diff options
author | Jelle Zijlstra <jelle.zijlstra@gmail.com> | 2023-05-14 11:53:15 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-14 11:53:15 (GMT) |
commit | 2f7b5e458e9189fa1ffd44339848aa1e52add3fa (patch) | |
tree | 87401dcd7bddb68a57245cb547ae674f75d5ed98 /Doc | |
parent | 178153c9a6f32da8d132aae591c0cfebea7c6366 (diff) | |
download | cpython-2f7b5e458e9189fa1ffd44339848aa1e52add3fa.zip cpython-2f7b5e458e9189fa1ffd44339848aa1e52add3fa.tar.gz cpython-2f7b5e458e9189fa1ffd44339848aa1e52add3fa.tar.bz2 |
Minor improvements to typing docs (#104465)
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/typing.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index fb1c916..c300c42 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -19,7 +19,7 @@ This module provides runtime support for type hints. The most fundamental support consists of the types :data:`Any`, :data:`Union`, :data:`Callable`, -:class:`TypeVar`, and :class:`Generic`. For a full specification, please see +:class:`TypeVar`, and :class:`Generic`. For a specification, please see :pep:`484`. For a simplified introduction to type hints, see :pep:`483`. @@ -592,7 +592,7 @@ The module defines the following classes, functions and decorators. when the checked program targets Python 3.9 or newer. The deprecated types will be removed from the :mod:`typing` module - in the first Python version released 5 years after the release of Python 3.9.0. + no sooner than the first Python version released 5 years after the release of Python 3.9.0. See details in :pep:`585`—*Type Hinting Generics In Standard Collections*. @@ -1291,6 +1291,8 @@ These are not used in annotations. They are building blocks for creating generic U = TypeVar('U', bound=str|bytes) # Can be any subtype of the union str|bytes V = TypeVar('V', bound=SupportsAbs) # Can be anything with an __abs__ method +.. _typing-constrained-typevar: + Using a *constrained* type variable, however, means that the ``TypeVar`` can only ever be solved as being exactly one of the constraints given:: @@ -1550,7 +1552,7 @@ These are not used in annotations. They are building blocks for creating generic .. data:: AnyStr - ``AnyStr`` is a :class:`constrained type variable <TypeVar>` defined as + ``AnyStr`` is a :ref:`constrained type variable <typing-constrained-typevar>` defined as ``AnyStr = TypeVar('AnyStr', str, bytes)``. It is meant to be used for functions that may accept any kind of string @@ -2112,7 +2114,7 @@ Other concrete types Python 2 is no longer supported, and most type checkers also no longer support type checking Python 2 code. Removal of the alias is not currently planned, but users are encouraged to use - :class:`str` instead of ``Text`` wherever possible. + :class:`str` instead of ``Text``. Abstract Base Classes --------------------- |