diff options
| author | Ivan Levkivskyi <levkivskyi@gmail.com> | 2019-06-19 01:31:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-19 01:31:51 +0100 |
| commit | 809ff1181ccc09c3b629f3d0ec66e13eaa111b2e (patch) | |
| tree | d480cd05e3ea537c4732fb11bb605ab5a0d7ef27 | |
| parent | 47c2de7725025341318860b9a2601ba7013d27a9 (diff) | |
| download | cpython-git-809ff1181ccc09c3b629f3d0ec66e13eaa111b2e.tar.gz | |
Document typing.ForwardRef (GH-14216)
| -rw-r--r-- | Doc/library/typing.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 1a766c29a5..d2dd03d50f 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, |