[Python-checkins] Document typing.ForwardRef (GH-14216)
Ivan Levkivskyi
webhook-mailer at python.org
Tue Jun 18 20:31:57 EDT 2019
https://github.com/python/cpython/commit/809ff1181ccc09c3b629f3d0ec66e13eaa111b2e
commit: 809ff1181ccc09c3b629f3d0ec66e13eaa111b2e
branch: master
author: Ivan Levkivskyi <levkivskyi at gmail.com>
committer: GitHub <noreply at github.com>
date: 2019-06-19T01:31:51+01:00
summary:
Document typing.ForwardRef (GH-14216)
files:
M Doc/library/typing.rst
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 1a766c29a57a..d2dd03d50fc6 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -1001,6 +1001,13 @@ The module defines the following classes, functions and decorators:
.. versionadded:: 3.8
+.. 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
+ a user, but may be used by introspection tools.
+
.. function:: NewType(typ)
A helper function to indicate a distinct types to a typechecker,
More information about the Python-checkins
mailing list