Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Hopefully clarify the difference between Optional[t] and an optional argument.

This commit is contained in:
Guido van Rossum 2016-02-10 09:46:56 -08:00
parent 5b613dd810
commit 3fb5612e08
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/library/typing.rst
View File

@ -286,6 +286,13 @@ The module defines the following classes, functions and decorators:
``Optional[X]`` is equivalent to ``Union[X, type(None)]``.
Note that this is not the same concept as an optional argument,
which is one that has a default. An optional argument with a
default needn't use the ``Optional`` qualifier on its type
annotation (although it is inferred if the default is ``None``).
A mandatory argument may still have an ``Optional`` type if an
explicit value of ``None`` is allowed.
.. class:: Tuple
Tuple type; ``Tuple[X, Y]`` is the is the type of a tuple of two items