[Python-checkins] Update the seealso entries for namedtuple() (GH-12373)

Miss Islington (bot) webhook-mailer at python.org
Sat Mar 16 16:01:38 EDT 2019


https://github.com/python/cpython/commit/68e0ed6a90c9553bf8ef0cfc61d35a30e408cc2f
commit: 68e0ed6a90c9553bf8ef0cfc61d35a30e408cc2f
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-03-16T13:01:35-07:00
summary:

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 at users.noreply.github.com>

files:
M Doc/library/collections.rst
M Doc/library/typing.rst

diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 0413f469228a..febaa4bf4620 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 e756062240c9..6f1c85feb0eb 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::
 



More information about the Python-checkins mailing list