mirror of
https://github.com/python/cpython
synced 2024-09-05 16:38:56 +00:00
gh-112194: Convert more examples to doctests in typing.py
(#112195)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This commit is contained in:
parent
9fb0f2dfee
commit
949b2cc6ea
|
@ -212,8 +212,12 @@ def _should_unflatten_callable_args(typ, args):
|
|||
|
||||
For example::
|
||||
|
||||
assert collections.abc.Callable[[int, int], str].__args__ == (int, int, str)
|
||||
assert collections.abc.Callable[ParamSpec, str].__args__ == (ParamSpec, str)
|
||||
>>> import collections.abc
|
||||
>>> P = ParamSpec('P')
|
||||
>>> collections.abc.Callable[[int, int], str].__args__ == (int, int, str)
|
||||
True
|
||||
>>> collections.abc.Callable[P, str].__args__ == (P, str)
|
||||
True
|
||||
|
||||
As a result, if we need to reconstruct the Callable from its __args__,
|
||||
we need to unflatten it.
|
||||
|
@ -255,7 +259,10 @@ def _collect_parameters(args):
|
|||
|
||||
For example::
|
||||
|
||||
assert _collect_parameters((T, Callable[P, T])) == (T, P)
|
||||
>>> P = ParamSpec('P')
|
||||
>>> T = TypeVar('T')
|
||||
>>> _collect_parameters((T, Callable[P, T]))
|
||||
(~T, ~P)
|
||||
"""
|
||||
parameters = []
|
||||
for t in args:
|
||||
|
@ -2244,14 +2251,15 @@ def get_origin(tp):
|
|||
|
||||
Examples::
|
||||
|
||||
assert get_origin(Literal[42]) is Literal
|
||||
assert get_origin(int) is None
|
||||
assert get_origin(ClassVar[int]) is ClassVar
|
||||
assert get_origin(Generic) is Generic
|
||||
assert get_origin(Generic[T]) is Generic
|
||||
assert get_origin(Union[T, int]) is Union
|
||||
assert get_origin(List[Tuple[T, T]][int]) is list
|
||||
assert get_origin(P.args) is P
|
||||
>>> P = ParamSpec('P')
|
||||
>>> assert get_origin(Literal[42]) is Literal
|
||||
>>> assert get_origin(int) is None
|
||||
>>> assert get_origin(ClassVar[int]) is ClassVar
|
||||
>>> assert get_origin(Generic) is Generic
|
||||
>>> assert get_origin(Generic[T]) is Generic
|
||||
>>> assert get_origin(Union[T, int]) is Union
|
||||
>>> assert get_origin(List[Tuple[T, T]][int]) is list
|
||||
>>> assert get_origin(P.args) is P
|
||||
"""
|
||||
if isinstance(tp, _AnnotatedAlias):
|
||||
return Annotated
|
||||
|
@ -2272,11 +2280,12 @@ def get_args(tp):
|
|||
|
||||
Examples::
|
||||
|
||||
assert get_args(Dict[str, int]) == (str, int)
|
||||
assert get_args(int) == ()
|
||||
assert get_args(Union[int, Union[T, int], str][int]) == (int, str)
|
||||
assert get_args(Union[int, Tuple[T, int]][str]) == (int, Tuple[str, int])
|
||||
assert get_args(Callable[[], T][int]) == ([], int)
|
||||
>>> T = TypeVar('T')
|
||||
>>> assert get_args(Dict[str, int]) == (str, int)
|
||||
>>> assert get_args(int) == ()
|
||||
>>> assert get_args(Union[int, Union[T, int], str][int]) == (int, str)
|
||||
>>> assert get_args(Union[int, Tuple[T, int]][str]) == (int, Tuple[str, int])
|
||||
>>> assert get_args(Callable[[], T][int]) == ([], int)
|
||||
"""
|
||||
if isinstance(tp, _AnnotatedAlias):
|
||||
return (tp.__origin__,) + tp.__metadata__
|
||||
|
@ -2295,12 +2304,15 @@ def is_typeddict(tp):
|
|||
|
||||
For example::
|
||||
|
||||
class Film(TypedDict):
|
||||
title: str
|
||||
year: int
|
||||
|
||||
is_typeddict(Film) # => True
|
||||
is_typeddict(Union[list, str]) # => False
|
||||
>>> from typing import TypedDict
|
||||
>>> class Film(TypedDict):
|
||||
... title: str
|
||||
... year: int
|
||||
...
|
||||
>>> is_typeddict(Film)
|
||||
True
|
||||
>>> is_typeddict(dict)
|
||||
False
|
||||
"""
|
||||
return isinstance(tp, _TypedDictMeta)
|
||||
|
||||
|
@ -2898,15 +2910,15 @@ def TypedDict(typename, fields=_sentinel, /, *, total=True):
|
|||
|
||||
Usage::
|
||||
|
||||
class Point2D(TypedDict):
|
||||
x: int
|
||||
y: int
|
||||
label: str
|
||||
|
||||
a: Point2D = {'x': 1, 'y': 2, 'label': 'good'} # OK
|
||||
b: Point2D = {'z': 3, 'label': 'bad'} # Fails type check
|
||||
|
||||
assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
|
||||
>>> class Point2D(TypedDict):
|
||||
... x: int
|
||||
... y: int
|
||||
... label: str
|
||||
...
|
||||
>>> a: Point2D = {'x': 1, 'y': 2, 'label': 'good'} # OK
|
||||
>>> b: Point2D = {'z': 3, 'label': 'bad'} # Fails type check
|
||||
>>> Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
|
||||
True
|
||||
|
||||
The type info can be accessed via the Point2D.__annotations__ dict, and
|
||||
the Point2D.__required_keys__ and Point2D.__optional_keys__ frozensets.
|
||||
|
|
Loading…
Reference in a new issue