Browse Source

Update the seealso entries for namedtuple() (GH-12373)

* Replace external recipe link with a link to the dataclasses module.

* Highlight the class definition syntax for typing.NamedTuple
  and add an example for clarity.
pull/12375/head
Raymond Hettinger 7 years ago
committed by Miss Islington (bot)
parent
commit
9c68543f02
  1. 17
      Doc/library/collections.rst
  2. 2
      Doc/library/typing.rst

17
Doc/library/collections.rst

@ -1028,17 +1028,20 @@ customize a prototype instance:
.. seealso::
* `Recipe for named tuple abstract base class with a metaclass mix-in
<https://code.activestate.com/recipes/577629-namedtupleabc-abstract-base-class-mix-in-for-named/>`_
by Jan Kaliszewski. Besides providing an :term:`abstract base class` for
named tuples, it also supports an alternate :term:`metaclass`-based
constructor that is convenient for use cases where named tuples are being
subclassed.
* See :class:`typing.NamedTuple` for a way to add type hints for named
tuples. It also provides an elegant notation using the :keyword:`class`
keyword::
class Component(NamedTuple):
part_number: int
weight: float
description: Optional[str] = None
* See :meth:`types.SimpleNamespace` for a mutable namespace based on an
underlying dictionary instead of a tuple.
* See :meth:`typing.NamedTuple` for a way to add type hints for named tuples.
* The :mod:`dataclasses` module provides a decorator and functions for
automatically adding generated special methods to user-defined classes.
:class:`OrderedDict` objects

2
Doc/library/typing.rst

@ -815,7 +815,7 @@ The module defines the following classes, functions and decorators:
.. class:: NamedTuple
Typed version of namedtuple.
Typed version of :func:`collections.namedtuple`.
Usage::

Loading…
Cancel
Save