diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-03-16 13:01:35 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-16 13:01:35 -0700 |
| commit | 68e0ed6a90c9553bf8ef0cfc61d35a30e408cc2f (patch) | |
| tree | 793dca0051c6e74535937b9bdbab3c825046e3f6 | |
| parent | e213cd6325f2d6f116b6c3dce109cdf21f6263d5 (diff) | |
| download | cpython-git-68e0ed6a90c9553bf8ef0cfc61d35a30e408cc2f.tar.gz | |
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.
(cherry picked from commit 9c68543f022b130ff51944edc6771c60510ee683)
Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
| -rw-r--r-- | Doc/library/collections.rst | 17 | ||||
| -rw-r--r-- | Doc/library/typing.rst | 2 |
2 files changed, 11 insertions, 8 deletions
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst index 0413f46922..febaa4bf46 100644 --- a/Doc/library/collections.rst +++ b/Doc/library/collections.rst @@ -1016,17 +1016,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 diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index e756062240..6f1c85feb0 100644 --- a/Doc/library/typing.rst +++ b/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:: |