]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-97797: Mention `__metadata__` in docstrings of `typing.{_AnnotatedAlias, Annotated...
authorNikita Sobolev <mail@sobolevn.me>
Mon, 10 Apr 2023 14:57:17 +0000 (17:57 +0300)
committerGitHub <noreply@github.com>
Mon, 10 Apr 2023 14:57:17 +0000 (15:57 +0100)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Kirill <80244920+Eclips4@users.noreply.github.com>
Lib/typing.py

index 1f1c4ffa2566ab32ba341d1babd5314c01256f71..7c165562c2b53d6bf2ab9661dfbde3a514b4ed9e 100644 (file)
@@ -2154,6 +2154,8 @@ class _AnnotatedAlias(_NotIterable, _GenericAlias, _root=True):
     with extra annotations. The alias behaves like a normal typing alias,
     instantiating is the same as instantiating the underlying type, binding
     it to types is also the same.
+
+    The metadata itself is stored in a '__metadata__' attribute as a tuple.
     """
     def __init__(self, origin, metadata):
         if isinstance(origin, _AnnotatedAlias):
@@ -2209,6 +2211,10 @@ class Annotated:
     Details:
 
     - It's an error to call `Annotated` with less than two arguments.
+    - Access the metadata via the ``__metadata__`` attribute::
+
+        Annotated[int, '$'].__metadata__ == ('$',)
+
     - Nested Annotated are flattened::
 
         Annotated[Annotated[T, Ann1, Ann2], Ann3] == Annotated[T, Ann1, Ann2, Ann3]