From: sobolevn <mail@sobolevn.me>
Date: Tue, 24 Sep 2024 06:53:04 +0000 (+0300)
Subject: gh-124120: Document `Annotated.__origin__` (#124125)
X-Git-Tag: v3.14.0a1~379
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=faef3fa653f2901cc905f98eae0ddcd8dc334d33;p=thirdparty%2FPython%2Fcpython.git

gh-124120: Document `Annotated.__origin__` (#124125)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
---

diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 075c58d65ce2..f52c593a086c 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -1458,6 +1458,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__
+        <class 'str'>
+
+     Note that using :func:`get_origin` will return ``Annotated`` itself:
+
+     .. doctest::
+
+        >>> get_origin(Password)
+        typing.Annotated
+
    .. seealso::
 
       :pep:`593` - Flexible function and variable annotations
@@ -3298,6 +3315,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