Skip to content

gh-130117: Document why nested Union, Literal, and Annotated types referenced through a type alias are not flattened #130119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions Doc/library/typing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1098,6 +1098,12 @@ These can be used as types in annotations. They all support subscription using

Union[Union[int, str], float] == Union[int, str, float]

However, this does not apply to unions referenced through a type
alias, to avoid forcing evaluation of the underlying :class:`TypeAliasType`::

type A = Union[int, str]
Union[A, float] != Union[int, str, float]

* Unions of a single argument vanish, e.g.::

Union[int] == int # The constructor actually returns int
Expand Down Expand Up @@ -1230,6 +1236,32 @@ These can be used as types in annotations. They all support subscription using
is allowed as type argument to ``Literal[...]``, but type checkers may
impose restrictions. See :pep:`586` for more details about literal types.

Additional details:

* The arguments must be literal values and there must be at least one.

* Nested ``Literal`` types are flattened, e.g.::

assert Literal[Literal[1, 2], 3] == Literal[1, 2, 3]

However, this does not apply to ``Literal`` types referenced through a type
alias, to avoid forcing evaluation of the underlying :class:`TypeAliasType`::

type A = Literal[1, 2]
assert Literal[A, 3] != Literal[1, 2, 3]

* Redundant arguments are skipped, e.g.::

assert Literal[1, 2, 1] == Literal[1, 2]

* When comparing literals, the argument order is ignored, e.g.::

assert Literal[1, 2] == Literal[2, 1]

* You cannot subclass or instantiate a ``Literal``.

* You cannot write ``Literal[X][Y]``.

.. versionadded:: 3.8

.. versionchanged:: 3.9.1
Expand Down Expand Up @@ -1400,6 +1432,14 @@ These can be used as types in annotations. They all support subscription using
int, ValueRange(3, 10), ctype("char")
]

However, this does not apply to ``Annotated`` types referenced through a type
alias, to avoid forcing evaluation of the underlying :class:`TypeAliasType`::

type From3To10[T] = Annotated[T, ValueRange(3, 10)]
assert Annotated[From3To10[int], ctype("char")] != Annotated[
int, ValueRange(3, 10), ctype("char")
]

Duplicated metadata elements are not removed::

assert Annotated[int, ValueRange(3, 10)] != Annotated[
Expand Down
Loading