Document typing.ForwardRef (GH-14216)

809ff118 · Ivan Levkivskyi · GitHub · 47c2de77 · 809ff118
Commit 809ff118 authored Jun 19, 2019 by Ivan Levkivskyi Committed by GitHub Jun 19, 2019
Hide whitespace changes
Inline Side-by-side

Showing with 7 additions and 0 deletions

Doc/library/typing.rst Doc/library/typing.rst +7 -0

No files found.
--- 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,