10000 gh-124120: Document `Annotated.__origin__` by sobolevn · Pull Request #124125 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-124120: Document Annotated.__origin__ #124125

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.

Sign up for GitHub

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 6 commits into from
Sep 24, 2024
Merged

gh-124120: Document Annotated.__origin__ #124125

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
748a3c7
gh-124120: Document use of `get_origin` to access `Annotated` origin
sobolevn Sep 16, 2024
e82bb85
Also mention Annotated in get_origin docs
sobolevn Sep 16, 2024
2750cf8
Fix test
sobolevn Sep 16, 2024
a9a3f74
Update Doc/library/typing.rst
sobolevn Sep 16, 2024
e8de2a5
Apply suggestions from code review
sobolevn Sep 16, 2024
8994ed4
Fix tests
sobolevn Sep 16, 2024
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
17 changes: 17 additions & 0 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1458,6 +1458,22 @@ These can be used as types in annotations. They all support subscription using
>>> X.__metadata__
('very', 'important', 'metadata')

* At runtime, if you want to retrive the original
type wrapped by ``Annotated``, use :attr:`!__origin__` attribute:

.. doctest::

>>> from typing import Annotated, get_origin
>>> Password = Annotated[str, "secret"]
>>> Password.__origin__
<class 'str'>

Note that using :func:`get_origin` will return ``Annotated`` itself:

.. doctest::

>>> assert get_origin(Password) is Annotated

.. seealso::

:pep:`593` - Flexible function and variable annotations
Expand Down Expand Up @@ -3298,6 +3314,7 @@ Introspection helpers
assert get_origin(str) is None
assert get_origin(Dict[str, int]) is dict
assert get_origin(Union[int, str]) is Union
assert get_origin(Annotated[str, "metadata"]) is Annotated
P = ParamSpec('P')
assert get_origin(P.args) is P
assert get_origin(P.kwargs) is P
Expand Down
Loading
0