diff options
author | Micael Jarniac <micael@jarniac.com> | 2021-10-09 03:33:37 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-09 03:33:37 (GMT) |
commit | a98b273ce42f33d04c8b85b8d574c47adf11dd2a (patch) | |
tree | 2cfeb912a04f00cadb93b186d6d35dc5e1758b4b /Doc/library/typing.rst | |
parent | b108db63e02797a795840152b82cab9792fd3ed2 (diff) | |
download | cpython-a98b273ce42f33d04c8b85b8d574c47adf11dd2a.zip cpython-a98b273ce42f33d04c8b85b8d574c47adf11dd2a.tar.gz cpython-a98b273ce42f33d04c8b85b8d574c47adf11dd2a.tar.bz2 |
Replace usage of List[...] with list[...] in typing docs (GH-28821)
The ``List[...]`` form is deprecated since 3.9.
Diffstat (limited to 'Doc/library/typing.rst')
-rw-r--r-- | Doc/library/typing.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 13760c1..bc6130a 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -975,16 +975,16 @@ These can be used as types in annotations using ``[]``, each having a unique syn For example:: - def is_str_list(val: List[object]) -> TypeGuard[List[str]]: + def is_str_list(val: list[object]) -> TypeGuard[list[str]]: '''Determines whether all objects in the list are strings''' return all(isinstance(x, str) for x in val) - def func1(val: List[object]): + def func1(val: list[object]): if is_str_list(val): - # Type of ``val`` is narrowed to ``List[str]``. + # Type of ``val`` is narrowed to ``list[str]``. print(" ".join(val)) else: - # Type of ``val`` remains as ``List[object]``. + # Type of ``val`` remains as ``list[object]``. print("Not a list of strings!") If ``is_str_list`` is a class or instance method, then the type in @@ -999,8 +999,8 @@ These can be used as types in annotations using ``[]``, each having a unique syn ``TypeB`` need not be a narrower form of ``TypeA`` -- it can even be a wider form. The main reason is to allow for things like - narrowing ``List[object]`` to ``List[str]`` even though the latter - is not a subtype of the former, since ``List`` is invariant. + narrowing ``list[object]`` to ``list[str]`` even though the latter + is not a subtype of the former, since ``list`` is invariant. The responsibility of writing type-safe type guards is left to the user. ``TypeGuard`` also works with type variables. For more information, see @@ -2065,8 +2065,8 @@ Introspection helpers .. class:: ForwardRef A class used for internal typing representation of string forward references. - For example, ``List["SomeClass"]`` is implicitly transformed into - ``List[ForwardRef("SomeClass")]``. This class should not be instantiated by + For example, ``list["SomeClass"]`` is implicitly transformed into + ``list[ForwardRef("SomeClass")]``. This class should not be instantiated by a user, but may be used by introspection tools. .. note:: |