[Python-checkins] bpo-44926: `get_type_hints`: Add note about type aliases with forward refs (GH-27859) (GH-27860)

ambv webhook-mailer at python.org
Sun Aug 22 14:30:11 EDT 2021

commit: 9ffe582a018a2babd14e874ae2b169370633fe33
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2021-08-22T20:29:59+02:00

bpo-44926: `get_type_hints`: Add note about type aliases with forward refs (GH-27859) (GH-27860)

(cherry picked from commit 16b9be4861e007ad483611ba0479feb2b90ea783)

Co-authored-by: Maximilian Hils <git at maximilianhils.com>

M Doc/library/typing.rst

diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index e8d7c9ee01bd1..47d6c3a2e3898 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -2013,6 +2013,13 @@ Introspection helpers
            'name': Annotated[str, 'some marker']
+   .. note::
+      :func:`get_type_hints` does not work with imported
+      :ref:`type aliases <type-aliases>` that include forward references.
+      Enabling postponed evaluation of annotations (:pep:`563`) may remove
+      the need for most forward references.
    .. versionchanged:: 3.9
       Added ``include_extras`` parameter as part of :pep:`593`.

More information about the Python-checkins mailing list