From 0c36c37841a66ebfcf1686777b76e7407efbe3ca Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Tue, 24 Sep 2024 15:52:27 +0200 Subject: [PATCH] [3.12] gh-124120: Document `Annotated.__origin__` (GH-124125) (#124417) gh-124120: Document `Annotated.__origin__` (GH-124125) (cherry picked from commit faef3fa653f2901cc905f98eae0ddcd8dc334d33) Co-authored-by: sobolevn Co-authored-by: Brian Schubert Co-authored-by: Alex Waygood --- Doc/library/typing.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index bb4909350527..7f86b550b915 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -1405,6 +1405,23 @@ These can be used as types in annotations. They all support subscription using >>> X.__metadata__ ('very', 'important', 'metadata') + * At runtime, if you want to retrieve the original + type wrapped by ``Annotated``, use the :attr:`!__origin__` attribute: + + .. doctest:: + + >>> from typing import Annotated, get_origin + >>> Password = Annotated[str, "secret"] + >>> Password.__origin__ + + + Note that using :func:`get_origin` will return ``Annotated`` itself: + + .. doctest:: + + >>> get_origin(Password) + + .. seealso:: :pep:`593` - Flexible function and variable annotations @@ -3010,6 +3027,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 -- 2.47.3