[Python-checkins] bpo-37814: Document the empty tuple type annotation syntax (GH-15208)
Miss Islington (bot)
webhook-mailer at python.org
Tue Aug 13 15:05:18 EDT 2019
https://github.com/python/cpython/commit/8a784af750fa82c8355903309e5089eb2b60c16b
commit: 8a784af750fa82c8355903309e5089eb2b60c16b
branch: master
author: Josh Holland <anowlcalledjosh at gmail.com>
committer: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
date: 2019-08-13T12:05:09-07:00
summary:
bpo-37814: Document the empty tuple type annotation syntax (GH-15208)
https://bugs.python.org/issue37814:
> The empty tuple syntax in type annotations, `Tuple[()]`, is not obvious from the examples given in the documentation (I naively expected `Tuple[]` to work); it has been documented in PEP 484 and in mypy, but not in the documentation for the typing module.
https://bugs.python.org/issue37814
files:
M Doc/library/typing.rst
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index d2dd03d50fc6..12efde131657 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -1245,7 +1245,8 @@ The module defines the following classes, functions and decorators:
.. data:: Tuple
Tuple type; ``Tuple[X, Y]`` is the type of a tuple of two items
- with the first item of type X and the second of type Y.
+ with the first item of type X and the second of type Y. The type of
+ the empty tuple can be written as ``Tuple[()]``.
Example: ``Tuple[T1, T2]`` is a tuple of two elements corresponding
to type variables T1 and T2. ``Tuple[int, float, str]`` is a tuple
More information about the Python-checkins
mailing list