diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-06-08 15:06:39 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-08 15:06:39 (GMT) |
commit | af80db063fa9569c239367f430467cadac5b714d (patch) | |
tree | 8b7c1478c3d548d9e9f5d6a744bed4ce5555394d /Lib/typing.py | |
parent | 02c5513b30f31b65fab48318772f83441f426df4 (diff) | |
download | cpython-af80db063fa9569c239367f430467cadac5b714d.zip cpython-af80db063fa9569c239367f430467cadac5b714d.tar.gz cpython-af80db063fa9569c239367f430467cadac5b714d.tar.bz2 |
[3.11] Further improve docs for `typing.Annotated` (GH-105498) (#105504)
* Further improve docs for `typing.Annotated` (GH-105498)
(cherry picked from commit d213c2990f0db62ed39fc5468977f989c2658675)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Diffstat (limited to 'Lib/typing.py')
-rw-r--r-- | Lib/typing.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Lib/typing.py b/Lib/typing.py index eed557a..d5a3d54 100644 --- a/Lib/typing.py +++ b/Lib/typing.py @@ -2173,7 +2173,7 @@ class Annotated: assert Annotated[int, '$'].__metadata__ == ('$',) - - Nested Annotated are flattened:: + - Nested Annotated types are flattened:: assert Annotated[Annotated[T, Ann1, Ann2], Ann3] == Annotated[T, Ann1, Ann2, Ann3] @@ -2184,15 +2184,15 @@ class Annotated: - Annotated can be used as a generic type alias:: - Optimized = Annotated[T, runtime.Optimize()] + Optimized: TypeAlias = Annotated[T, runtime.Optimize()] assert Optimized[int] == Annotated[int, runtime.Optimize()] - OptimizedList = Annotated[List[T], runtime.Optimize()] - assert OptimizedList[int] == Annotated[List[int], runtime.Optimize()] + OptimizedList: TypeAlias = Annotated[list[T], runtime.Optimize()] + assert OptimizedList[int] == Annotated[list[int], runtime.Optimize()] - Annotated cannot be used with an unpacked TypeVarTuple:: - Annotated[*Ts, Ann1] # NOT valid + Variadic: TypeAlias = Annotated[*Ts, Ann1] # NOT valid This would be equivalent to:: |