Skip to content

Fix deprecated use of List #28821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Fidget-Spinner merged 1 commit into from
Oct 9, 2021
Merged

Fix deprecated use of List #28821

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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::
Expand Down