Skip to content

[3.9] bpo-41370: Add note about ForwardRefs and PEP585 generic types in docs (GH-25183) #25184

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
miss-islington merged 1 commit into from
Apr 4, 2021
Merged

[3.9] bpo-41370: Add note about ForwardRefs and PEP585 generic types in docs (GH-25183) #25184

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
9 changes: 7 additions & 2 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1710,10 +1710,15 @@ 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::
:pep:`585` generic types such as ``list["SomeClass"]`` will not be
implicitly transformed into ``list[ForwardRef("SomeClass")]`` and thus
will not automatically resolve to ``list[SomeClass]``.

.. versionadded:: 3.7.4

Constant
Expand Down