mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-23 17:03:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

gh-90015: Document that PEP-604 unions do not support forward references (#105366)

Browse source
This commit is contained in:
Alex Waygood 2023-06-07 18:26:23 +01:00 • committed by GitHub
parent c85be33acc
commit fbdee000de
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/library/stdtypes.rst
View file

@ -5162,6 +5162,14 @@ enables cleaner type hinting syntax compared to :data:`typing.Union`.
def square(number: int | float) -> int | float: def square(number: int | float) -> int | float:
return number ** 2 return number ** 2
.. note::
The ``|`` operand cannot be used at runtime to define unions where one or
more members is a forward reference. For example, ``int | "Foo"``, where
``"Foo"`` is a reference to a class not yet defined, will fail at
runtime. For unions which include forward references, present the
whole expression as a string, e.g. ``"int | Foo"``.
.. describe:: union_object == other .. describe:: union_object == other
Union objects can be tested for equality with other union objects. Details: Union objects can be tested for equality with other union objects. Details: