]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.9] bpo-42198: Document __new__ for types.GenericAlias (GH-23039) (GH-23061)
authorkj <28750310+Fidget-Spinner@users.noreply.github.com>
Sat, 31 Oct 2020 15:05:36 +0000 (23:05 +0800)
committerGitHub <noreply@github.com>
Sat, 31 Oct 2020 15:05:36 +0000 (08:05 -0700)
(cherry picked from commit bcbf758476c1148993ddf4b54d3f6169b973ee1c)

Doc/library/stdtypes.rst
Doc/library/types.rst

index e19e76f8311c8e5b1013d7f565989856d8ef522e..a48cfa1327791027f80cfed07633faa6916cae60 100644 (file)
@@ -4760,7 +4760,8 @@ The ``GenericAlias`` object acts as a proxy for :term:`generic types
 of a generic which provides the types for container elements.
 
 The user-exposed type for the ``GenericAlias`` object can be accessed from
-:data:`types.GenericAlias` and used for :func:`isinstance` checks.
+:class:`types.GenericAlias` and used for :func:`isinstance` checks.  It can
+also be used to create ``GenericAlias`` objects directly.
 
 .. describe:: T[X, Y, ...]
 
index 1573e460f2f2be666172e247b76938a7da18efbb..5d68c6852678c2a770378912fc9d409dd57956f4 100644 (file)
@@ -242,11 +242,22 @@ Standard names are defined for the following types:
          Defaults to ``None``. Previously the attribute was optional.
 
 
-.. data:: GenericAlias
+.. class:: GenericAlias(t_origin, t_args)
 
    The type of :ref:`parameterized generics <types-genericalias>` such as
    ``list[int]``.
 
+   ``t_origin`` should be a non-parameterized generic class, such as ``list``,
+   ``tuple`` or ``dict``.  ``t_args`` should be a :class:`tuple` (possibly of
+   length 1) of types which parameterize ``t_origin``::
+
+      >>> from types import GenericAlias
+
+      >>> list[int] == GenericAlias(list, (int,))
+      True
+      >>> dict[str, int] == GenericAlias(dict, (str, int))
+      True
+
    .. versionadded:: 3.9