o
0ii @ s d Z ddlmZmZ ddlZddlZddlZddlZddlZddl Z
ddl Z ddl Z ddl m
Z
mZmZmZ g dZddddd Zdddd d Zd
d Zdd ZdddZdd Zdd Zdd Zdd Zdd Zg Z ddd d d Z e fd d!Z G d"d# d#Z G d$d% d%Z!G d&d' d'e d
d(Z"G d)d* d*e"d
d(Z#e"d+d, Z$e"d-d. Z%e"d/d0 Z&e"d1d2 Z'e"d3d4 Z(e"d5d6 Z)e#e d
d d7d8 Z*e"d9d: Z+e"d;d< Z,e"d=d> Z-G d?d@ d@e d
d(Z.G dAdB dBZ/G dCdD dDe e!e/d
d(Z0G dEdF dFe e!d
d(Z1G dGdH dHe e!d
d(Z2G dIdJ dJe e!e/d
d(Z3dKdL Z4G dMdN dNe d
d(Z5G dOdP dPe5d
d(Z6G dQdR dRe5d
d(Z7G dSdT dTe6d
d(Z8G dUdV dVe7d
d(Z9G dWdX dXe7d
d(Z:G dYdZ dZe6d
d(Z;d[d\ ZG dadb dbZ?G dcdd ddZ@G dedf dfZAg dgZBg dhZCeBeC dig ZDdjdk ZEdldm ZFdndo ZGddrdsZHddudvZIg dwdxdygdzZJG d{d| d|eZKG d}d~ d~e?eKdZLG dd de6d
d(ZMG dd dZNdd ZOdd ZPdd ZQe jRe jSe jTe jUe
eefZVdddZWdd ZXdd ZYdd ZZdd Z[dd Z\dd Z]dd Z^dd Z_dd Z`e0dZae0dZbe0dZce0dd
dZde0dd
dZee0dd
dZfe0dd
dZge0dd
ehdZie0dejekZle7ZmemejjndZnemejjodpZoemejjpdtZpemejjqdpZqemejjrdpZremejjsdpZsemejjtdpZtemejjudpZuemejjvdZvemejjwdpZwemejjxdpZxe9ejjydZydey_ emejjzdpddZ{emejj|dpZ|emejj}dZ}emejj~dZ~emejjdpZemejjdpZemejjdZe:eddddZde_ emedpdddZemejdpddZemedpdddZzeme dpdddZemejjdpZemejjdpZemejjdZemejjdpZemejdpddZemejdpddZemeddddZemejdddZemejdZemejdpZemejdZemejjdtZemejjdZemehdpdddZde_ eOG dd deLZeOG dd deLZeOG dd deLZeOG ddÄ deLZeOG ddń deLZeOG ddDŽ deLed ZeOG ddɄ deLed Zddd̄Ze h dͣZe h dΣZG ddЄ dehZddd҄Zeheddi ZddԄ Zee_G ddք dehZdd
dלddلZeheddi Zddۄ e_G dd݄ d݃ZekZdZG dd߄ de?el ZG dd deej ZG dd deek ZG dd dZed e_ee jej< eme
jdpZeme
jdpZG dd dZ ed e _e e je j< dS )aU
The typing module: Support for gradual typing as defined by PEP 484.
At large scale, the structure of the module is following:
* Imports and exports, all public names should be explicitly added to __all__.
* Internal helper functions: these should never be used in code outside this module.
* _SpecialForm and its instances (special forms):
Any, NoReturn, ClassVar, Union, Optional, Concatenate
* Classes whose instances can be type arguments in addition to types:
ForwardRef, TypeVar and ParamSpec
* The core of internal generics API: _GenericAlias and _VariadicGenericAlias, the latter is
currently only used by Tuple and Callable. All subscripted types like X[int], Union[int, str],
etc., are instances of either of these classes.
* The public counterpart of the generics API consists of two classes: Generic and Protocol.
* Public helper functions: get_type_hints, overload, cast, no_type_check,
no_type_check_decorator.
* Generic aliases for collections.abc ABCs and few additional protocols.
* Special types: NewType, NamedTuple, TypedDict.
* Wrapper submodules for re and io related types.
)abstractmethodABCMetaN)WrapperDescriptorTypeMethodWrapperTypeMethodDescriptorType GenericAlias)T AnnotatedAnyCallableClassVar ConcatenateFinal
ForwardRefGenericLiteralOptional ParamSpecProtocolTupleTypeTypeVarUnion AbstractSet
ByteString ContainerContextManagerHashable ItemsViewIterableIteratorKeysViewMapping MappingViewMutableMappingMutableSequence
MutableSetSequenceSized
ValuesView Awaitable
AsyncIterator
AsyncIterable Coroutine
CollectionAsyncGeneratorAsyncContextManager
Reversible SupportsAbs
SupportsBytesSupportsComplex
SupportsFloat
SupportsIndex SupportsInt
SupportsRoundChainMapCounterDequeDict DefaultDictList OrderedDictSet FrozenSet
NamedTuple TypedDict GeneratorBinaryIOIOMatchPatternTextIOAnyStrcastfinalget_args
get_originget_type_hints is_typeddictNewType
no_type_checkno_type_check_decoratorNoReturnoverload
ParamSpecArgsParamSpecKwargsruntime_checkableText
TYPE_CHECKING TypeAlias TypeGuardFallow_special_formsc C s, | du rt dS t| trt| ||dS | S )z=For converting None to type(None), and strings to ForwardRef.N)moduleis_class)type
isinstancestrr )argr^ r] rd -/opt/alt/python310/lib64/python3.10/typing.py
_type_convert s
rf Tc C s t tf}|s|tf7 }|r|tf7 }t| ||d} t| tr*| j|v r*t| d| t t
tt fv r4| S t| t s?| t tfv rGtd| dt| t
tttjtttfrV| S t| set| d| dd| S )a Check that the argument is a type, and return it (internal helper).
As a special case, accept None and return type(None) instead. Also wrap strings
into ForwardRef instances. Consider several corner cases, for example plain
special forms like Union are not valid, while Union[int, str] is OK, etc.
The msg argument is a human-readable error message, e.g::
"Union[arg, ...]: arg should be a type."
We append the repr() of the actual value (truncated to 100 chars).
)r^ r] z is not valid as type argumentzPlain z Got z.100.)r r r r
rf ra
_GenericAlias
__origin__ TypeErrorr rS rZ _SpecialFormr` r r types UnionTyper rU rV callable)rc msg is_argumentr^ r] Zinvalid_generic_formsrd rd re _type_check s(
rq c C s | du p t | ttttfS )N.)ra tuplelistr _ConcatenateGenericAlias)rc rd rd re _is_param_expr s
ru c C sf t | tjr
t| S t | tr | jdkr| jS | j d| j S | du r&dS t | tjr/| jS t| S )a; Return the repr() of an object, special-casing types (internal helper).
If obj is a type, we return a shorter version than the default
type.__repr__, based on the module and qualified name, which is
typically enough to uniquely identify a type. For everything
else, we fall back on repr(obj).
builtinsrg .z...) ra rl r reprr`
__module__ __qualname__ FunctionType__name__)objrd rd re
_type_repr s
r} c sj |du rt }g | D ]&}t||r| vr | t|tttjfr0 fdd|jD q
t S )zCollect all type variable contained
in types in order of first appearance (lexicographic order). For example::
_collect_type_vars((T, List[S, T])) == (T, S)
Nc s g | ]}| vr|qS rd rd .0ttvarsrd re
z&_collect_type_vars..)
r ra appendrh r rl rm extend__parameters__rr )Ztypes_
typevar_typesr rd r re _collect_type_vars s
r c C sR |s t | dt|}||kr't d||krdnd d| d| d| dS ) zCheck correct count for parameters of a generic cls (internal helper).
This gives a nice error message in case of count mismatch.
z is not a generic classzToo manyfewz arguments for z ; actual z , expected N)rj len)cls
parametersZelenZalenrd rd re _check_generic s r c C s~ t | jdkr|rt|d s|fS t| |t | j g }t|| jD ]\}}t|tr5t|tr5t|}| | q#t|S )z`Prepares the parameters for a Generic containing ParamSpec
variables (internal helper).
r )
r r ru r zipra r rs rr r )r paramsZ_paramspZtvarrd rd re _prepare_paramspec_params s
r c C sJ t | }t|t| k r#g }| D ]}||v r || || q|} | S N)setr r remove)r Z
all_paramsZ
new_paramsr rd rd re _deduplicate s
r c C sx g }| D ]1}t |ttjfr||j qt |tr0t|dkr0|d tu r0||dd q| | qtt
|S )zyAn internal helper for Union creation and substitution: flatten Unions
among parameters, then remove duplicates.
r r N) ra _UnionGenericAliasrl rm r __args__rr r r r r r r r rd rd re _remove_dups_flatten s " r c C s8 g }| D ]}t |tr||j q|| qt|S )zJAn internal helper for Literal creation: flatten Literals among parameters)ra _LiteralGenericAliasr r r rr r rd rd re _flatten_literal_params s
r typedc s fdd}| dur|| S |S )zInternal wrapper caching __getitem__ of generic types with a fallback to
original function for non-hashable arguments.
c s8 t jd t j t fdd}|S )Nr c s2 z | i |W S t y Y nw | i |S r rj argskwdscachedfuncrd re inner2 s z+_tp_cache..decorator..inner) functools lru_cache _cleanupsr cache_clearwraps)r r r r re decorator. s
z _tp_cache..decoratorNrd )r r r rd r re _tp_cache* s
r c s t | tr | S t | tttjfrGt fdd| jD }|| jkr*| S t | tr5t| j |S t | tjrBt
t j
|S | |S | S )zEvaluate all forward references in the given type t.
For use of globalns and localns see the docstring for get_type_hints().
recursive_guard is used to prevent infinite recursion with a recursive
ForwardRef.
c 3 s | ]
}t | V qd S r )
_eval_typer aglobalnslocalnsrecursive_guardrd re I z _eval_type..)ra r _evaluaterh r rl rm rr r ri r reduceoperatoror_ copy_with)r r r r Zev_argsrd r re r @ s
r c @ s e Zd ZdZdZdd ZdS )_Finalz Mixin to prohibit subclassing) __weakref__c O s d|vrt dd S )N_rootz&Cannot subclass special typing classesr selfr r rd rd re __init_subclass__Z s z_Final.__init_subclass__N)r{ rx ry __doc__ __slots__r rd rd rd re r U s r c @ s$ e Zd ZdZdZdd Zdd ZdS )
_Immutablez3Mixin to indicate that object should not be copied.rd c C | S r rd r rd rd re __copy__b z_Immutable.__copy__c C r r rd )r Zmemord rd re __deepcopy__e r z_Immutable.__deepcopy__N)r{ rx ry r r r r rd rd rd re r ^ s
r c @ sl e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dd Z dd Z dd Z
edd ZdS )rk )_namer _getitemc C s || _ |j| _|j| _d S r )r r{ r r )r getitemrd rd re __init__n s z_SpecialForm.__init__c C s |dv r| j S t|)N> r{ ry )r AttributeError)r itemrd rd re __getattr__s s z_SpecialForm.__getattr__c C t d| )NCannot subclass r )r basesrd rd re __mro_entries__y z _SpecialForm.__mro_entries__c C
d| j S Ntyping.r r rd rd re __repr__|
z_SpecialForm.__repr__c C | j S r r r rd rd re
__reduce__ z_SpecialForm.__reduce__c O r )NzCannot instantiate r r rd rd re __call__ r z_SpecialForm.__call__c C t | |f S r r r otherrd rd re __or__ z_SpecialForm.__or__c C t || f S r r r rd rd re __ror__ r z_SpecialForm.__ror__c C t | d)Nz! cannot be used with isinstance()r r r| rd rd re __instancecheck__ r z _SpecialForm.__instancecheck__c C r )Nz! cannot be used with issubclass()r r r rd rd re __subclasscheck__ r z _SpecialForm.__subclasscheck__c C s | | |S r )r r r rd rd re __getitem__ s z_SpecialForm.__getitem__N)r{ rx ry r r r r r r r r r r r r r rd rd rd re rk k s rk )r c @ e Zd Zdd ZdS )_LiteralSpecialFormc C s" t |ts|f}| j| g|R S r )ra rr r r rd rd re r s
z _LiteralSpecialForm.__getitem__N)r{ rx ry r rd rd rd re r s r c C r )a` Special type indicating an unconstrained type.
- Any is compatible with every type.
- Any assumed to have all methods.
- All values assumed to be instances of Any.
Note that all the above statements are true from the point of view of
static type checkers. At runtime, Any should not be used with instance
or class checks.
is not subscriptabler r rd rd re r r c C r )a Special type indicating functions that never return.
Example::
from typing import NoReturn
def stop() -> NoReturn:
raise Exception('no way')
This type is invalid in other positions, e.g., ``List[NoReturn]``
will fail in static type checkers.
r r r rd rd re rS s
rS c C t || d}t| |fS )a3 Special type construct to mark class variables.
An annotation wrapped in ClassVar indicates that a given
attribute is intended to be used as a class variable and
should not be set on instances of that class. Usage::
class Starship:
stats: ClassVar[Dict[str, int]] = {} # class variable
damage: int = 10 # instance variable
ClassVar accepts only types and cannot be further subscribed.
Note that ClassVar is not a class itself, and should not
be used with isinstance() or issubclass().
accepts only single type.rq rh r r r rd rd re r s r c C r )a Special typing construct to indicate final names to type checkers.
A final name cannot be re-assigned or overridden in a subclass.
For example:
MAX_SIZE: Final = 9000
MAX_SIZE += 1 # Error reported by type checker
class Connection:
TIMEOUT: Final[int] = 10
class FastConnector(Connection):
TIMEOUT = 1 # Error reported by type checker
There is no runtime checking of these properties.
r r r rd rd re r
s r
c s |dkrt dt|ts|f}d t fdd|D }t|}t|dkr+|d S t|dkr>td |v r>t| |d
d S t| |S ) a' Union type; Union[X, Y] means either X or Y.
To define a union, use e.g. Union[int, str]. Details:
- The arguments must be types and there must be at least one.
- None as an argument is a special case and is replaced by
type(None).
- Unions of unions are flattened, e.g.::
Union[Union[int, str], float] == Union[int, str, float]
- Unions of a single argument vanish, e.g.::
Union[int] == int # The constructor actually returns int
- Redundant arguments are skipped, e.g.::
Union[int, str, int] == Union[int, str]
- When comparing unions, the argument order is ignored, e.g.::
Union[int, str] == Union[str, int]
- You cannot subclass or instantiate a union.
- You can use Optional[X] as a shorthand for Union[X, None].
rd z Cannot take a Union of no types.z)Union[arg, ...]: each arg must be a type.c 3 | ]}t | V qd S r rq r r ro rd re r zUnion..r r Nr name)rj ra rr r r r` r r rd r re r s
r c C s t || d}t|tdf S )zEOptional type.
Optional[X] is equivalent to Union[X, None].
z requires a single type.N)rq r r` )r r rc rd rd re r s r c G sH t |}ztdd ttt|D }W n ty Y nw t| |S )a Special typing form to define literal types (a.k.a. value types).
This form can be used to indicate to type checkers that the corresponding
variable or function parameter has a value equivalent to the provided
literal (or one of several literals):
def validate_simple(data: Any) -> Literal[True]: # always returns True
...
MODE = Literal['r', 'rb', 'w', 'wb']
def open_helper(file: str, mode: MODE) -> str:
...
open_helper('/some/path', 'r') # Passes type check
open_helper('/other/path', 'typo') # Error in type checker
Literal[...] cannot be subclassed. At runtime, an arbitrary value
is allowed as type argument to Literal[...], but type checkers may
impose restrictions.
c s s | ]\}}|V qd S r rd )r r _rd rd re r 0 zLiteral..)r rr r rs _value_and_type_iterrj r r rd rd re r s "
r c C r )a Special marker indicating that an assignment should
be recognized as a proper type alias definition by type
checkers.
For example::
Predicate: TypeAlias = Callable[..., bool]
It's invalid when used anywhere except as in the example above.
r r r rd rd re rZ 7 r rZ c sv |dkrt dt|ts|f}t|d tst dd g fdd|dd D |d R }t| |ttfd d
S ) a Used in conjunction with ``ParamSpec`` and ``Callable`` to represent a
higher order function which adds, removes or transforms parameters of a
callable.
For example::
Callable[Concatenate[int, P], int]
See PEP 612 for detailed information.
rd z&Cannot take a Concatenate of no types.AThe last parameter to Concatenate should be a ParamSpec variable.z/Concatenate[arg, ...]: each arg must be a type.c 3 r r r r r rd re r Z r z Concatenate..NT_typevar_types_paramspec_tvars)rj ra rr r rt r r rd r re r F s
(r c C r )a Special typing form used to annotate the return type of a user-defined
type guard function. ``TypeGuard`` only accepts a single type argument.
At runtime, functions marked this way should return a boolean.
``TypeGuard`` aims to benefit *type narrowing* -- a technique used by static
type checkers to determine a more precise type of an expression within a
program's code flow. Usually type narrowing is done by analyzing
conditional code flow and applying the narrowing to a block of code. The
conditional expression here is sometimes referred to as a "type guard".
Sometimes it would be convenient to use a user-defined boolean function
as a type guard. Such a function should use ``TypeGuard[...]`` as its
return type to alert static type checkers to this intention.
Using ``-> TypeGuard`` tells the static type checker that for a given
function:
1. The return value is a boolean.
2. If the return value is ``True``, the type of its argument
is the type inside ``TypeGuard``.
For example::
def is_str(val: Union[str, float]):
# "isinstance" type guard
if isinstance(val, str):
# Type of ``val`` is narrowed to ``str``
...
else:
# Else, type of ``val`` is narrowed to ``float``.
...
Strict type narrowing is not enforced -- ``TypeB`` need not be a narrower
form of ``TypeA`` (it can even be a wider form) and this may lead to
type-unsafe results. The main reason is to allow for things like
narrowing ``List[object]`` to ``List[str]`` even though the latter is not
a subtype of the former, since ``List`` is invariant. The responsibility of
writing type-safe type guards is left to the user.
``TypeGuard`` also works with type variables. For more information, see
PEP 647 (User-Defined Type Guards).
r r r rd rd re r[ ` s , r[ c @ sD e Zd ZdZdZdddddZd d
Zd d Zd
d Zdd Z dS )r z-Internal wrapper to hold a forward reference.)__forward_arg____forward_code____forward_evaluated____forward_value____forward_is_argument____forward_is_class____forward_module__TNF)r_ c C st t |ts td|zt|dd}W n ty" td|w || _|| _d| _d | _|| _ || _
|| _ d S )Nz*Forward reference must be a string -- got zevalz/Forward reference must be an expression -- got F) ra rb rj compile SyntaxErrorr r
r r r
r r )r rc rp r^ r_ coderd rd re r s
zForwardRef.__init__c C s | j |v r| S | jr||urW|d u r|d u ri }}n
|d u r"|}n|d u r(|}| jd ur9ttj| jd d|}tt| j ||d| j
| j d}t ||||| j hB | _
d| _| j
S )N__dict__z*Forward references must evaluate to types.)rp r] T)r r r getattrsysmodulesgetrq r r
r
r r r )r r r r Ztype_rd rd re r s0
zForwardRef._evaluatec C sJ t |tstS | jr|jr| j|jko| j|jkS | j|jko$| j|jkS r )ra r NotImplementedr r r r r rd rd re __eq__ s
zForwardRef.__eq__c C t | j| jfS r )hashr r r rd rd re __hash__ zForwardRef.__hash__c C s d| j dS )Nz ForwardRef())r r rd rd re r r zForwardRef.__repr__TN)
r{ rx ry r r r r r r r rd rd rd re r s r c @ s8 e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd S )
_TypeVarLikez5Mixin for TypeVar-like types (TypeVar and ParamSpec).c C sB |r|rt dt|| _t|| _|r t|d| _dS d| _dS )zfUsed to setup TypeVars and ParamSpec's bound, covariant and
contravariant attributes.
z"Bivariant types are not supported.zBound must be a type.N)
ValueErrorbool
__covariant____contravariant__rq __bound__)r bound covariant
contravariantrd rd re r s
z_TypeVarLike.__init__c C r r r r rightrd rd re r r z_TypeVarLike.__or__c C r r r r leftrd rd re r r z_TypeVarLike.__ror__c C s& | j rd}n| jr d}nd}|| j S )N+-~)r$ r% r{ )r prefixrd rd re r s
z_TypeVarLike.__repr__c C r r )r{ r rd rd re r r z_TypeVarLike.__reduce__N) r{ rx ry r r r r r r rd rd rd re r! s
r! c s. e Zd ZdZdZdddd fdd
Z ZS )r a Type variable.
Usage::
T = TypeVar('T') # Can be anything
A = TypeVar('A', str, bytes) # Must be str or bytes
Type variables exist primarily for the benefit of static type
checkers. They serve as the parameters for generic types as well
as for generic function definitions. See class Generic for more
information on generic types. Generic functions work as follows:
def repeat(x: T, n: int) -> List[T]:
'''Return a list containing n references to x.'''
return [x]*n
def longest(x: A, y: A) -> A:
'''Return the longest of two strings.'''
return x if len(x) >= len(y) else y
The latter example's signature is essentially the overloading
of (str, str) -> str and (bytes, bytes) -> bytes. Also note
that if the arguments are instances of some subclass of str,
the return type is still plain str.
At runtime, isinstance(x, T) and issubclass(C, T) will raise TypeError.
Type variables defined with covariant=True or contravariant=True
can be used to declare covariant or contravariant generic types.
See PEP 484 for more details. By default generic types are invariant
in all type variables.
Type variables can be introspected. e.g.:
T.__name__ == 'T'
T.__constraints__ == ()
T.__covariant__ == False
T.__contravariant__ = False
A.__constraints__ == (str, bytes)
Note that only type variables defined in global scope can be pickled.
)r{ r& __constraints__r$ r% r NFr' r( r) c s || _ t ||| |r|d urtd|r!t|dkr!tdd t fdd|D | _z tdj
dd}W n
t t fyH d }Y nw |d krR|| _
d S d S )
Nz-Constraints cannot be combined with bound=...r z"A single constraint is not allowedz:TypeVar(name, constraint, ...): constraints must be types.c 3 r r r r~ r rd re r * r z#TypeVar.__init__..r{ __main__typing)r{ superr rj r rr r2 r _getframe f_globalsr r r" rx )r r r' r( r) Z constraintsdef_mod __class__r re r ! s
zTypeVar.__init__)r{ rx ry r r r
__classcell__rd rd r: re r s +r c @ ( e Zd ZdZdd Zdd Zdd ZdS ) rU a< The args for a ParamSpec object.
Given a ParamSpec object P, P.args is an instance of ParamSpecArgs.
ParamSpecArgs objects have a reference back to their ParamSpec:
P.args.__origin__ is P
This type is meant for runtime introspection and has no special meaning to
static type checkers.
c C
|| _ d S r ri r originrd rd re r ? r zParamSpecArgs.__init__c C | j j dS )Nz.argsri r{ r rd rd re r B r zParamSpecArgs.__repr__c C t |tstS | j|jkS r )ra rU r ri r rd rd re r E
zParamSpecArgs.__eq__Nr{ rx ry r r r r rd rd rd re rU 3
rU c @ r= ) rV aF The kwargs for a ParamSpec object.
Given a ParamSpec object P, P.kwargs is an instance of ParamSpecKwargs.
ParamSpecKwargs objects have a reference back to their ParamSpec:
P.kwargs.__origin__ is P
This type is meant for runtime introspection and has no special meaning to
static type checkers.
c C r> r r? r@ rd rd re r W r zParamSpecKwargs.__init__c C rB )Nz.kwargsrC r rd rd re r Z r zParamSpecKwargs.__repr__c C rD r )ra rV r ri r rd rd re r ] rE zParamSpecKwargs.__eq__NrF rd rd rd re rV K rG rV c sF e Zd ZdZdZedd Zedd Zdddd fd
d
Z Z S ) r aq Parameter specification variable.
Usage::
P = ParamSpec('P')
Parameter specification variables exist primarily for the benefit of static
type checkers. They are used to forward the parameter types of one
callable to another callable, a pattern commonly found in higher order
functions and decorators. They are only valid when used in ``Concatenate``,
or as the first argument to ``Callable``, or as parameters for user-defined
Generics. See class Generic for more information on generic types. An
example for annotating a decorator::
T = TypeVar('T')
P = ParamSpec('P')
def add_logging(f: Callable[P, T]) -> Callable[P, T]:
'''A type-safe decorator to add logging to a function.'''
def inner(*args: P.args, **kwargs: P.kwargs) -> T:
logging.info(f'{f.__name__} was called')
return f(*args, **kwargs)
return inner
@add_logging
def add_two(x: float, y: float) -> float:
'''Add two numbers together.'''
return x + y
Parameter specification variables defined with covariant=True or
contravariant=True can be used to declare covariant or contravariant
generic types. These keyword arguments are valid, but their actual semantics
are yet to be decided. See PEP 612 for details.
Parameter specification variables can be introspected. e.g.:
P.__name__ == 'P'
P.__bound__ == None
P.__covariant__ == False
P.__contravariant__ == False
Note that only parameter specification variables defined in global scope can
be pickled.
)r{ r& r$ r% r c C t | S r )rU r rd rd re r zParamSpec.argsc C rH r )rV r rd rd re kwargs rI zParamSpec.kwargsNFr3 c s` || _ t ||| z tdjdd}W n
ttfy$ d }Y nw |dkr.|| _ d S d S )Nr r{ r4 r5 )
r{ r6 r r r7 r8 r r r" rx )r r r' r( r) r9 r: rd re r s
zParamSpec.__init__)
r{ rx ry r r propertyr rJ r r< rd rd r: re r c s -
r c C s | do | dS )N__)
startswithendswith)attrrd rd re
_is_dunder s rP c sd e Zd ZdZdddddZdd Zd d
Zd d Z fd
dZdd Z dd Z
fddZ Z S )_BaseGenericAliasa The central part of internal API.
This represents a generic version of type 'origin' with type arguments 'params'.
There are two kind of these aliases: user defined and special. The special ones
are wrappers around builtin collections and ABCs in collections.abc. These must
have 'name' always set. If 'inst' is False, then the alias can't be instantiated,
this is used by e.g. typing.List and typing.Dict.
TNinstr c C s || _ || _|| _d | _d S r )_instr ri r )r rA rS r rd rd re r s
z_BaseGenericAlias.__init__c O sT | j std| j d| jj d| j|i |}z| |_W |S ty) Y |S w )NzType z cannot be instantiated; use z
() instead)rT rj r ri r{ __orig_class__r )r r rJ resultrd rd re r s
z_BaseGenericAlias.__call__c C sj g }| j |vr
|| j || }||d d D ]}t|ts&t|tr+ t|S q|t t|S )Nr )ri r indexra rQ
issubclassr rr )r r resibrd rd re r s
z!_BaseGenericAlias.__mro_entries__c C s< |dv r | j p
| jjS d| jv rt|st| j|S t|)N> r{ ry ri )r ri r{ r rP r r r rO rd rd re r s
z _BaseGenericAlias.__getattr__c s4 t |s|dv rt || d S t| j|| d S )N> r _nparamsr r rT )rP r6 __setattr__setattrri )r rO valr: rd re r^ s z _BaseGenericAlias.__setattr__c C | t|S r r r` r rd rd re r r z#_BaseGenericAlias.__instancecheck__c C t d)NzBSubscripted generics cannot be used with class and instance checksr r rd rd re r z#_BaseGenericAlias.__subclasscheck__c s& t tt dd t| jD S )Nc S s g | ]}t |s|qS rd )rP r rO rd rd re r r z-_BaseGenericAlias.__dir__..)rs r r6 __dir__dirri r r: rd re rf s z_BaseGenericAlias.__dir__)
r{ rx ry r r r r r r^ r r rf r< rd rd r: re rQ s
rQ c sx e Zd Zddedd fdd
Zdd Zd d
Zd d Zd
d Ze dd Z
dd Z dd Z dd Z
fddZ ZS )rh TNF)rS r r r c sd t j|||d t|ts|f}tdd |D | _t||d| _|| _|| _|s0|j | _ d S d S )NrR c s s, | ]}|t u r
d n|tu rdn|V qdS ).rd N)_TypingEllipsis _TypingEmptyr rd rd re r s
z)_GenericAlias.__init__..)r )
r6 r ra rr r r r r r rx )r rA r rS r r r r: rd re r s
z_GenericAlias.__init__c C & t |tstS | j|jko| j|jkS r )ra rh r ri r r rd rd re r
z_GenericAlias.__eq__c C r r )r ri r r rd rd re r
r z_GenericAlias.__hash__c C r r r r* rd rd re r r z_GenericAlias.__or__c C r r r r, rd rd re r r z_GenericAlias.__ror__c sL | j ttfv rtd| t|ts|f}tdd |D }| jr2tdd | jD r2t | |}n t
| |t | j t t
| j| g }| jD ]V}t|| jrjt|tre | }t|sdtd| n" | }n t|tttjfr|j}|rt fdd|D }|| }| j tjjkrt|tr|| qH|| qH| t|S )Nz%Cannot subscript already-subscripted c s | ]}t |V qd S r rf r rd rd re r r z,_GenericAlias.__getitem__..c s | ]}t |tV qd S r ra r r~ rd rd re r r zFExpected a list of types, an ellipsis, ParamSpec, or Concatenate. Got c 3 s | ]} | V qd S r rd )r xsubstrd re r 2 r ) ri r r rj ra rr r anyr r r r dictr r r r ru rh r rl rm collectionsabcr
r r r )r r new_argsrc subparamssubargsrd rq re r s>
z_GenericAlias.__getitem__c C s | j | j|| j| j| j| jdS )Nr rS r r )r; ri r rT r r r r rd rd re r ; s z_GenericAlias.copy_withc C sB | j r d| j }nt| j}ddd | jD }| d| dS )Nr , c S g | ]}t |qS rd r} r rd rd re r E z*_GenericAlias.__repr__..[])r r} ri joinr )r r r rd rd re r @ s
z_GenericAlias.__repr__c C sb | j r
t | j }n| j}t| j}t|dkr*t|d tr'|tu r*|d s*|\}tj ||ffS )Nr r )
r globalsri rr r r ra r r r )r rA r rd rd re r H s
z_GenericAlias.__reduce__c s t | jtr
td| | jrt |S | jtu r=t|v r!dS | | }||d d D ]}t |t
r<|| ur< dS q.| jfS )Nr rd r ) ra ri rk rj r r6 r r r rW rQ )r r rZ r[ r: rd re r S s
z _GenericAlias.__mro_entries__)r{ rx ry r r r r r r r r r r r r r< rd rd r: re rh s
$ rh c sd e Zd Zddd fdd
Zedd Zdd Zd
d Z fd d
Zdd Z dd Z
dd Z Z S )_SpecialGenericAliasTNrR c s` |d u r|j }t j|||d || _|jdkr"d|j d| _d S d|j d|j d| _d S )NrR rv zA generic version of rg )r{ r6 r r] rx ry r )r rA ZnparamsrS r r: rd re r h s
z _SpecialGenericAlias.__init__c sB t |ts|f}d t fdd|D }t| || j | |S )Nz*Parameters to generic types must be types.c 3 r r r r r rd re r w r z3_SpecialGenericAlias.__getitem__..)ra rr r r] r r{ rd r re r r s
z _SpecialGenericAlias.__getitem__c C s t | j|| j| jdS )N)r rS )rh ri r rT r{ rd rd re r { s z _SpecialGenericAlias.copy_withc C r r r r rd rd re r r z _SpecialGenericAlias.__repr__c s: t |tr t|j| jS t |tst|| jS t |S r )ra r rX ri rh r6 r r r: rd re r s
z&_SpecialGenericAlias.__subclasscheck__c C r r r r rd rd re r r z _SpecialGenericAlias.__reduce__c C r r r r* rd rd re r r z_SpecialGenericAlias.__or__c C r r r r, rd rd re r r z _SpecialGenericAlias.__ror__)
r{ rx ry r r r r r r r r r r< rd rd r: re r g s
r c s$ e Zd Z fddZdd Z ZS )_CallableGenericAliasc sZ | j }t|dkrt|d rt S dddd |d d D dt|d d S )
Nr r ztyping.Callable[[r| c S r} rd r~ r rd rd re r r z2_CallableGenericAlias.__repr__..r z], r )r r ru r6 r r r} r r r: rd re r s
z _CallableGenericAlias.__repr__c C sD | j }t|dkrt|d st|d d |d f}tjt|ffS )Nr r r )r r ru rs r r r
r rd rd re r s z _CallableGenericAlias.__reduce__)r{ rx ry r r r< rd rd r: re r s r c @ s( e Zd Zdd Zdd Zedd ZdS )
_CallableTypec C s t | j|| j| jttfddS )NTrz )r ri r rT r r r{ rd rd re r s
z_CallableType.copy_withc C sP t |tr t|dkrtd|\}}t |tr t||f}n||f}| |S )Nr z6Callable must be used as Callable[[arg, ...], result].)ra rr r rj rs __getitem_inner__)r r r rV rd rd re r s
z_CallableType.__getitem__c C sb |\}}d}t ||}|tu r| t|fS t|ts |f}tdd |D }||f }| |S )Nz.Callable[args, result]: result must be a type.c s rl r rm )r rc rd rd re r r z2_CallableType.__getitem_inner__..)rq Ellipsisr rh ra rr )r r r rV ro rd rd re r s
z _CallableType.__getitem_inner__N)r{ rx ry r r r r rd rd rd re r s
r c @ s e Zd Zedd ZdS )
_TupleTypec s |dkr
| tfS t|ts|f}t|dkr.|d du r.d t|d }| |tfS d t fdd |D }| |S )
Nrd r r .z Tuple[t, ...]: t must be a type.r z*Tuple[t0, t1, ...]: each t must be a type.c 3 r r r r r rd re r r z)_TupleType.__getitem__..)r ri ra rr r rq rh )r r r rd r re r s
z_TupleType.__getitem__N)r{ rx ry r r rd rd rd re r s r c sP e Zd Zdd Zdd Zdd Z fddZd d
Zd d Z fd
dZ Z
S )r c C s t | S r r r{ rd rd re r rd z _UnionGenericAlias.copy_withc C s( t |ttjfs
tS t| jt|jkS r )ra r rl rm r r r r rd rd re r s z_UnionGenericAlias.__eq__c C s t t| jS r )r frozensetr r rd rd re r r z_UnionGenericAlias.__hash__c sd | j }t|dkr-|d td u rdt|d dS |d td u r-dt|d dS t S )Nr r ztyping.Optional[r r )r r r` r} r6 r r r: rd re r s
z_UnionGenericAlias.__repr__c C ra r rb r rd rd re r r z$_UnionGenericAlias.__instancecheck__c C s | j D ]
}t||r
dS qd S )NT)r rX )r r rc rd rd re r s
z$_UnionGenericAlias.__subclasscheck__c s t \}\}}|t|ffS r )r6 r r )r r rA r r: rd re r s z _UnionGenericAlias.__reduce__) r{ rx ry r r r r r r r r< rd rd r: re r s r c C s dd | D S )Nc s s | ] }|t |fV qd S r )r` r rd rd re r s z'_value_and_type_iter..rd )r rd rd re r r r c @ s e Zd Zdd Zdd ZdS )r c C s* t |tstS tt| jtt|jkS r )ra r r r r r r rd rd re r s
z_LiteralGenericAlias.__eq__c C s t tt| jS r )r r r r r rd rd re r z _LiteralGenericAlias.__hash__N)r{ rx ry r r rd rd rd re r s r c e Zd Z fddZ ZS )rt c sz t |d ttfrg |d d |d R S t |d tr,g |d d |d jR }n t |d ts7tdt |S )Nr r ) ra rs rr rt r r rj r6 r r{ r: rd re r s z"_ConcatenateGenericAlias.copy_with)r{ rx ry r r< rd rd r: re rt s rt c s4 e Zd ZdZdZdZedd Z fddZ Z S )r aC Abstract base class for generic types.
A generic type is typically declared by inheriting from
this class parameterized with one or more type variables.
For example, a generic mapping type might be defined as::
class Mapping(Generic[KT, VT]):
def __getitem__(self, key: KT) -> VT:
...
# Etc.
This class can then be used as follows::
def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
try:
return mapping[key]
except KeyError:
return default
rd Fc C s t |ts|f}|s| turtd| j dtdd |D }| ttfv rLtdd |D s8td| j dt t
|t |krKtd| j dnt d d | j D r\t
| |}n t| |t | j t| |ttfd
d S ) NzParameter list to z[...] cannot be emptyc s rl r rm r rd rd re r 2 r z,Generic.__class_getitem__..c s s | ]
}t |ttfV qd S r )ra r r r rd rd re r 5 r zParameters to zF[...] must all be type variables or parameter specification variables.z[...] must all be uniquec s rn r ro r~ rd rd re r > r Tr )ra rr r rj ry r r allr{ r r rs r r r rh r r )r r rd rd re __class_getitem__+ s0
zGeneric.__class_getitem__c
s t j|i | g }d| jv rt| jv }n
t| jv o | jdk}|r&tdd| jv rt| jt t
f}d }| jD ]}t |t rO|j
tu rO|d urLtd|j}q8|d urt|}t| | ksd fdd|D }ddd |D } td | d
| d |}t|| _d S ) N__orig_bases__r z!Cannot inherit from plain Genericz0Cannot inherit from Generic[...] multiple types.r| c 3 s | ] }| vrt |V qd S r rb r~ Zgvarsetrd re r b z,Generic.__init_subclass__..c s rl r r )r grd rd re r c r zSome type variables (z ) are not listed in Generic[r )r6 r r r r __bases__r{ rj r r r ra rh ri r r r rr )
r r rJ r errorZgvarsbaseZtvarsetZs_varsZs_argsr: r re r F s<
zGeneric.__init_subclass__)
r{ rx ry r r _is_protocolr r r r< rd rd r: re r s
r c @ e Zd ZdZdS )ri zInternal placeholder for () or []. Used by TupleMeta and CallableMeta
to allow empty list/tuple in specific places, without allowing them
to sneak in where prohibited.
Nr{ rx ry r rd rd rd re ri j ri c @ r )rh z(Internal placeholder for ... (ellipsis).Nr rd rd rd re rh q r rh )r r rU r _is_runtime_protocol) __abstractmethods____annotations__r r r rx __new__r __subclasshook__r r _MutableMapping__markerc C sr t }| jdd D ],}|jdv rq
t|di }t|j t| D ]}|ds5|tvr5| | q%q
|S )zCollect protocol members from a protocol class objects.
This includes names actually defined in the class dictionary, as well
as names that appear in annotations. Special names (above) are skipped.
Nr )r r r Z_abc_)
r __mro__r{ r rs r keysrM EXCLUDED_ATTRIBUTESadd)r Zattrsr annotationsrO rd rd re _get_protocol_attrs s
r c s t fddt D S )Nc 3 s | ] }t t |d V qd S r )rn r re r rd re r r z,_is_callable_members_only..)r r r rd r re _is_callable_members_only s r c O st t | }|jr td|jturd S |jD ]}|jdt}|tur'||_ nqtj|_|j| g|R i | d S )Nz Protocols cannot be instantiatedr ) r` r rj r _no_init_or_replace_initr r r object)r r rJ r r Zinitrd rd re r s
r r r4 c C s4 z
t | d jd|W S ttfy Y d S w )Nr r{ )r r7 r8 r r r" )depthdefaultrd rd re _caller s
r c C s0 z t | jd dv W S ttfy Y dS w )zAllow instance and class checks for special stdlib modules.
The abc and functools modules indiscriminately call isinstance() and
issubclass() on the whole MRO of a user class, which may contain protocols.
r{ )rv r T)r r7 r8 r r" r rd rd re _allow_reckless_class_checks s
r )
r
r) r r r+ r r' r r- r0 AbstractContextManagerAbstractAsyncContextManager)zcollections.abc
contextlibc r )
_ProtocolMetac s t ddrt ddstddstdt ddr t r'tj r'dS jr:t fdd t D r:dS t
S )
Nr Fr r r LInstance and class checks can only be used with @runtime_checkable protocolsTc 3 s: | ]}t |ott |d pt|d uV qd S r )hasattrrn r re r instancerd re r s
z2_ProtocolMeta.__instancecheck__..) r r rj r rX r; r r r r6 r r r: r re r s&
z _ProtocolMeta.__instancecheck__)r{ rx ry r r< rd rd r: re r s r c s, e Zd ZdZdZdZdZ fddZ ZS )r aZ Base class for protocol classes.
Protocol classes are defined as::
class Proto(Protocol):
def meth(self) -> int:
...
Such classes are primarily used with static type checkers that recognize
structural subtyping (static duck-typing), for example::
class C:
def meth(self) -> int:
return 0
def func(x: Proto) -> int:
return x.meth()
func(C()) # Passes static type check
See PEP 544 for details. Protocol classes decorated with
@typing.runtime_checkable act as simple-minded runtime protocols that check
only the presence of given attributes, ignoring their type signatures.
Protocol classes can be generic, they are defined as::
class GenProto(Protocol[T]):
def meth(self) -> T:
...
rd TFc s t j|i | jddstdd jD _ fdd}d jvr)| _ js.d S jD ]#}|tt fv sT|j
t v rF|j t |j
v sTt
|t rN|jsTtd| q1t _d S ) Nr Fc s s | ]}|t u V qd S r )r )r r[ rd rd re r r z-Protocol.__init_subclass__..c s j dds tS t ddst rtS tdt s%t r!tS tdt| ts.tdt D ];}| j
D ]1}||j v rM|j | d u rKt S n t|di }t|t j j
rh||v rht| trh| jrh nq7t S q2dS ) Nr Fr r z._proto_hookr z7Protocols can only inherit from other protocols, got %r)r6 r r r rs r r r r r rx _PROTO_ALLOWLISTr{ rX rj r r )r r rJ r r r: r re r
s*
&
zProtocol.__init_subclass__) r{ rx ry r r r r r r< rd rd r: re r s r ) metaclassc sT e Zd ZdZ fddZdd Zdd Zdd Zd
d Zd d
Z fddZ
Z S )_AnnotatedAliasa7 Runtime representation of an annotated type.
At its core 'Annotated[t, dec1, dec2, ...]' is an alias for the type 't'
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.
c s2 t |tr
|j| }|j}t || || _d S r )ra r __metadata__ri r6 r )r rA metadatar: rd re r U s
z_AnnotatedAlias.__init__c C s |d }t || jS )Nr )r r )r r Znew_typerd rd re r \ s z_AnnotatedAlias.copy_withc C s$ d t| jddd | jD S )Nztyping.Annotated[{}, {}]r| c s rl r )rw r rd rd re r d r z+_AnnotatedAlias.__repr__..)formatr} ri r r r rd rd re r a s z_AnnotatedAlias.__repr__c C s t jt| jf| j ffS r )r r r ri r r rd rd re r g s z_AnnotatedAlias.__reduce__c C rj r )ra r r ri r r rd rd re r l rk z_AnnotatedAlias.__eq__c C r r )r ri r r rd rd re r r r z_AnnotatedAlias.__hash__c s |dv rdS t |S )N> r{ ry r )r6 r r\ r: rd re r u s z_AnnotatedAlias.__getattr__) r{ rx ry r r r r r r r r r< rd rd r: re r M s r c @ s0 e Zd ZdZdZdd Zedd Zdd Zd S )
r a Add context specific metadata to a type.
Example: Annotated[int, runtime_check.Unsigned] indicates to the
hypothetical runtime_check module that this type is an unsigned int.
Every other consumer of this type can ignore this metadata and treat
this type as int.
The first argument to Annotated must be a valid type.
Details:
- It's an error to call `Annotated` with less than two arguments.
- Nested Annotated are flattened::
Annotated[Annotated[T, Ann1, Ann2], Ann3] == Annotated[T, Ann1, Ann2, Ann3]
- Instantiating an annotated type is equivalent to instantiating the
underlying type::
Annotated[C, Ann1](5) == C(5)
- Annotated can be used as a generic type alias::
Optimized = Annotated[T, runtime.Optimize()]
Optimized[int] == Annotated[int, runtime.Optimize()]
OptimizedList = Annotated[List[T], runtime.Optimize()]
OptimizedList[int] == Annotated[List[int], runtime.Optimize()]
rd c O rc )Nz&Type Annotated cannot be instantiated.r r r rJ rd rd re r rd zAnnotated.__new__c C sN t |tr t|dk rtdd}t|d |dd}t|dd }t||S )Nr zUAnnotated[...] should be used with at least two arguments (a type and an annotation).z$Annotated[t, ...]: t must be a type.r Tr\ r )ra rr r rj rq r )r r ro rA r rd rd re r s
zAnnotated.__class_getitem__c O s t d| j)Nz Cannot subclass {}.Annotated)rj r rx r rd rd re r s
zAnnotated.__init_subclass__N) r{ rx ry r r r r r r rd rd rd re r { s
r c C s& t | tr| jstd| d| _| S )a9 Mark a protocol class as a runtime protocol.
Such protocol can be used with isinstance() and issubclass().
Raise TypeError if applied to a non-protocol class.
This allows a simple-minded structural check very similar to
one trick ponies in collections.abc such as Iterable.
For example::
@runtime_checkable
class Closable(Protocol):
def close(self): ...
assert isinstance(open('/some/file'), Closable)
Warning: this will check only the presence of the required methods,
not their type signatures!
zB@runtime_checkable can be only applied to protocol classes, got %rT)rX r r rj r r rd rd re rW s rW c C |S )zCast a value to a type.
This returns the value unchanged. To the type checker this
signals that the return value has the designated type, but at
runtime we intentionally don't check anything (we want this
to be as fast as possible).
rd )typr` rd rd re rJ s rJ c
C s z| j }W n ty i Y S w |j}|j}|d| }| jp!d}| j}|r+t|ni }|t| }t||d |D ]\}} | ||< q<|S )z:Internal helper to extract the default arguments, by name.Nrd ) __code__r co_argcount co_varnames __defaults____kwdefaults__rt r r )
r r Z pos_countZ arg_namesdefaultsZ
kwdefaultsrY Z
pos_offsetr valuerd rd re
_get_defaults s
r c
C s@ t | ddri S t| tri }t| jD ]d}|du r't tj|jddi }n|}|j di }t|t
j r8i }|du rBt t
|n|}|du rQ|du rQ||}}| D ]"\} }
|
du ratd}
t|
trmt|
ddd}
t|
||}
|
|| < qUq|r}|S dd | D S |du rt| t
jr| j }n| } t| d
r| j} t| d
st | d i }|du r|}n|du r|}t | dd}|du rt| tri S td | t| } t |}| D ]7\} }
|
du rtd}
t|
trt|
t| t
j dd}
t|
||}
| | v r
| | du r
t|
}
|
|| < q|r|S d
d | D S )aH Return type hints for an object.
This is often the same as obj.__annotations__, but it handles
forward references encoded as string literals, adds Optional[t] if a
default value equal to None is set and recursively replaces all
'Annotated[T, ...]' with 'T' (unless 'include_extras=True').
The argument may be a module, class, method, or function. The annotations
are returned as a dictionary. For classes, annotations include also
inherited members.
TypeError is raised if the argument is not of a type that can contain
annotations, and an empty dictionary is returned if no annotations are
present.
BEWARE -- the behavior of globalns and localns is counterintuitive
(unless you are familiar with how eval() and exec() work). The
search order is locals first, then globals.
- If no dict arguments are passed, an attempt is made to use the
globals from obj (or the respective module's globals for classes),
and these are also used as the locals. If the object does not appear
to have globals, an empty dictionary is used. For classes, the search
order is globals first then locals.
- If one dict argument is passed, it is used for both globals and
locals.
- If two dict arguments are passed, they specify globals and
locals, respectively.
__no_type_check__Nr r FT)rp r_ c S i | ] \}}|t |qS rd _strip_annotationsr kr rd rd re
+ z"get_type_hints.. __wrapped__ __globals__z1{!r} is not a module, class, method, or function.c S r rd r r rd rd re r S r )r ra r` reversedr r r r rx r rl GetSetDescriptorTypert varsitemsrb r r
ModuleTyper r _allowed_typesrj r r r )
r| r r Zinclude_extrasZhintsr Z base_globalsannZ base_localsr r Znsobjr rd rd re rN sv !
rN c C s t | tr
t| jS t | tr%tdd | jD }|| jkr | S | |S t | trAtdd | jD }|| jkr;| S t| j|S t | t j
r_tdd | jD }|| jkrX| S t t
j|S | S )z.Strips the annotations from a given type.
c s rl r r r rd rd re r \ r z%_strip_annotations..c s rl r r r rd rd re r a r c s rl r r r rd rd re r f r )ra r r ri rh rr r r r rl rm r r r r )r Z
stripped_argsrd rd re r V s$
r c C sH t | trtS t | ttttfr| jS | tu rtS t | t j
r"t j
S dS )a
Get the unsubscripted version of a type.
This supports generic types, Callable, Tuple, Union, Literal, Final, ClassVar
and Annotated. Return None for unsupported types. Examples::
get_origin(Literal[42]) is Literal
get_origin(int) is None
get_origin(ClassVar[int]) is ClassVar
get_origin(Generic) is Generic
get_origin(Generic[T]) is Generic
get_origin(Union[T, int]) is Union
get_origin(List[Tuple[T, T]][int]) == list
get_origin(P.args) is P
N) ra r r rQ r rU rV ri r rl rm tprd rd re rM n s
rM c C s t | tr | jf| j S t | ttfr7| j}| jtjj u r5t
|dkr)t |d s5t |dd |d f}|S t | t
jr@| jS dS )a Get type arguments with all substitutions performed.
For unions, basic simplifications used by Union constructor are performed.
Examples::
get_args(Dict[str, int]) == (str, int)
get_args(int) == ()
get_args(Union[int, Union[T, int], str][int]) == (int, str)
get_args(Union[int, Tuple[T, int]][str]) == (int, Tuple[str, int])
get_args(Callable[[], T][int]) == ([], int)
r r Nr rd )ra r ri r rh r r ru rv r
r ru rs rl rm )r rY rd rd re rL s
rL c C s
t | tS )zCheck if an annotation is a TypedDict class
For example::
class Film(TypedDict):
title: str
year: int
is_typeddict(Film) # => True
is_typeddict(Union[list, str]) # => False
)ra _TypedDictMetar rd rd re rO s
rO c C s t | tr:| j }| j D ]\}}|| j| f v r || q| D ]}t |tj r0d|_
t |tr9t | q%zd| _
W | S t yJ Y | S w )aI Decorator to indicate that annotations are not type hints.
The argument must be a class or function; if it is a class, it
applies recursively to all methods and classes defined in that class
(but not to methods defined in its superclasses or subclasses).
This mutates the function(s) or class(es) in place.
T)
ra r` r copyr r popvaluesrl rz r rQ rj )rc Z arg_attrsrO r` r| rd rd re rQ s&
rQ c s t fdd}|S )zDecorator to give another decorator the @no_type_check effect.
This wraps the decorator with something that wraps the decorated
function in @no_type_check.
c s | i |}t |}|S r )rQ )r r r r rd re wrapped_decorator s z2no_type_check_decorator..wrapped_decorator)r r )r r rd r re rR s rR c O rc )z*Helper for @overload to raise when called.zYou should not call an overloaded function. A series of @overload-decorated functions outside a stub module should always be followed by an implementation that is not @overload-ed.)NotImplementedErrorr rd rd re _overload_dummy s r c C s t S )a
Decorator for overloaded functions/methods.
In a stub file, place two or more stub definitions for the same
function in a row, each decorated with @overload. For example:
@overload
def utf8(value: None) -> None: ...
@overload
def utf8(value: bytes) -> bytes: ...
@overload
def utf8(value: str) -> bytes: ...
In a non-stub file (i.e. a regular .py file), do the same but
follow it with an implementation. The implementation should *not*
be decorated with @overload. For example:
@overload
def utf8(value: None) -> None: ...
@overload
def utf8(value: bytes) -> bytes: ...
@overload
def utf8(value: str) -> bytes: ...
def utf8(value):
# implementation goes here
)r )r rd rd re rT s rT c C r )aV A decorator to indicate final methods and final classes.
Use this decorator to indicate to type checkers that the decorated
method cannot be overridden, and decorated class cannot be subclassed.
For example:
class Base:
@final
def done(self) -> None:
...
class Sub(Base):
def done(self) -> None: # Error reported by type checker
...
@final
class Leaf:
...
class Other(Leaf): # Error reported by type checker
...
There is no runtime checking of these properties.
rd )frd rd re rK s rK TKTVTT_co)r( V_coVT_coT_contra)r) CT_co)r( r' rI r a Callable type; Callable[[int], str] is a function of (int) -> str.
The subscription syntax must always be used with exactly two
values: the argument list and the return type. The argument list
must be a list of types or ellipsis; the return type must be a single type.
There is no syntax to indicate optional or keyword arguments,
such function types are rarely used as callback types.
r r r r rR a@ Tuple type; Tuple[X, Y] is the cross-product type of X and Y.
Example: Tuple[T1, T2] is a tuple of two elements corresponding
to type variables T1 and T2. Tuple[int, float, str] is a tuple
of an int, a float and a string.
To specify a variable-length tuple of homogeneous type, use Tuple[T, ...].
r= r: r? r@ r r/ r; r< r a A special construct usable to annotate class objects.
For example, suppose we have the following classes::
class User: ... # Abstract base for User classes
class BasicUser(User): ...
class ProUser(User): ...
class TeamUser(User): ...
And a function that takes a class argument that's a subclass of
User and returns an instance of the corresponding class::
U = TypeVar('U', bound=User)
def new_user(user_class: Type[U]) -> U:
user = user_class()
# (Here we could write the user object to a database)
return user
joe = new_user(BasicUser)
At this point the type checker knows that joe has type BasicUser.
c @ & e Zd ZdZdZedefddZdS )r6 z(An ABC with one abstract method __int__.rd returnc C d S r rd r rd rd re __int__ zSupportsInt.__int__N)r{ rx ry r r r intr rd rd rd re r6
r6 c @ r )r4 z*An ABC with one abstract method __float__.rd r c C r r rd r rd rd re __float__ r zSupportsFloat.__float__N)r{ rx ry r r r floatr rd rd rd re r4 r r4 c @ r )r3 z,An ABC with one abstract method __complex__.rd r c C r r rd r rd rd re __complex__ r zSupportsComplex.__complex__N)r{ rx ry r r r complexr rd rd rd re r3 r r3 c @ r )r2 z*An ABC with one abstract method __bytes__.rd r c C r r rd r rd rd re __bytes__ r zSupportsBytes.__bytes__N)r{ rx ry r r r bytesr rd rd rd re r2 r r2 c @ r )r5 z*An ABC with one abstract method __index__.rd r c C r r rd r rd rd re __index__ r zSupportsIndex.__index__N)r{ rx ry r r r r r rd rd rd re r5 r r5 c @ r )r1 zMAn ABC with one abstract method __abs__ that is covariant in its return type.rd r c C r r rd r rd rd re __abs__ r zSupportsAbs.__abs__N)r{ rx ry r r r r r rd rd rd re r1 r r1 c @ s, e Zd ZdZdZed dedefddZdS )
r7 zOAn ABC with one abstract method __round__ that is covariant in its return type.rd r ndigitsr c C r r rd )r r rd rd re __round__ r zSupportsRound.__round__Nr ) r{ rx ry r r r r r r rd rd rd re r7 s
r7 rd c C s@ dd |D }dd |D }t j| |||d}| |_|j_|S )Nc S s g | ]\}}|qS rd rd r nr rd rd re r r z!_make_nmtuple..c S s$ i | ]\}}|t |d | dqS )zfield z annotation must be a typer r rd rd re r s z!_make_nmtuple..r r^ )ru
namedtupler r )r rl r^ r fieldsnm_tplrd rd re
_make_nmtuple s r >
__getnewargs___maker _asdictZ_source_field_defaultsr _fieldsr _replace> r rx r{ c @ r )NamedTupleMetac
s di }g }|D ]&}| v r|| q
|r0td| dt|dkr%dnd dd| q
t|| fd d
|D d d } D ] }|tv rRtd
| |t vrc||j
vrct || | qF|S )Nr z Non-default namedtuple field z cannot follow default fieldr s r| c s g | ]} | qS rd rd )r r nsrd re r r z*NamedTupleMeta.__new__..rx r z&Cannot overwrite NamedTuple attribute ) r r rj r r r r _prohibitedr _specialr
r_ ) r typenamer r rl Z
default_namesZ
field_namer keyrd r re r s.
zNamedTupleMeta.__new__N)r{ rx ry r rd rd rd re r s r c K s` |du r | }n|rtdz tdjdd}W n
ttfy( d}Y nw t| ||dS )a Typed version of namedtuple.
Usage in Python versions >= 3.6::
class Employee(NamedTuple):
name: str
id: int
This is equivalent to::
Employee = collections.namedtuple('Employee', ['name', 'id'])
The resulting class has an extra __annotations__ attribute, giving a
dict that maps field names to types. (The field names are also in
the _fields attribute, which is part of the namedtuple API.)
Alternative equivalent keyword syntax is also accepted::
Employee = NamedTuple('Employee', name=str, id=int)
In Python versions <= 3.5 use::
Employee = NamedTuple('Employee', [('name', str), ('id', int)])
NzIEither list of fields or keywords can be provided to NamedTuple, not bothr r{ r4 r^ ) r rj r r7 r8 r r r" r )r r rJ r^ rd rd re rA s
rA c C s t | dkr
tdtfS )Nr z5Multiple inheritance with NamedTuple is not supported)r rj _NamedTupler rd rd re _namedtuple_mro_entries s r c @ s& e Zd ZdddZeZdd ZeZdS )r Tc s |D ] }t |turtdqt t|tf|i }|di }t| }d fdd| D }t } t }
|D ] }| |j
di | |j
dd |
|j
dd q<| | |rj| | n|
| |_ t | _
t |
_td s|_S )
a5 Create new typed dict class object.
This method is called when TypedDict is subclassed,
or when TypedDict is instantiated. This way
TypedDict supports all three syntax forms described in its docstring.
Subclasses and instances of TypedDict return actual dictionaries.
zHcannot inherit from both a TypedDict type and a non-TypedDict base classr z?TypedDict('Name', {f0: t0, f1: t1, ...}); each t must be a typec s" i | ]
\}}|t | jd qS )r )rq rx )r r r ro Ztp_dictrd re r 4 s z*_TypedDictMeta.__new__..__required_keys__rd __optional_keys__ __total__)r` r rj r rt r r r r updater r r r r r r ) r r r r totalr r Zown_annotationsZown_annotation_keysZ
required_keysZ
optional_keysrd r re r " s8
z_TypedDictMeta.__new__c C rc )Nz4TypedDict does not support instance and class checksr )r r rd rd re r O rI z _TypedDictMeta.__subclasscheck__N)T)r{ rx ry r rt r r r rd rd rd re r ! s
+r r" c K sj |du r|}n|r
t ddt|i}ztdjdd|d< W n ttfy, Y nw t| d||d S )
aS A simple typed namespace. At runtime it is equivalent to a plain dict.
TypedDict creates a dictionary type that expects all of its
instances to have a certain set of keys, where each key is
associated with a value of a consistent type. This expectation
is not checked at runtime but is only enforced by type checkers.
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')
The type info can be accessed via the Point2D.__annotations__ dict, and
the Point2D.__required_keys__ and Point2D.__optional_keys__ frozensets.
TypedDict supports two additional equivalent forms::
Point2D = TypedDict('Point2D', x=int, y=int, label=str)
Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})
By default, all keys must be present in a TypedDict. It is possible
to override this by specifying totality.
Usage::
class point2D(TypedDict, total=False):
x: int
y: int
This means that a point2D TypedDict can have any of the keys omitted.A type
checker is only expected to support a literal False or True as the value of
the total argument. True is the default, and makes all items defined in the
class body be required.
The class syntax is only supported in Python 3.6+, while two other
syntax forms work for Python 2.7 and 3.2+
Nz@TypedDict takes either a dict or keyword arguments, but not bothr r r{ r4 rx rd r# ) rj rt r r7 r8 r r r" r )r r r" rJ r rd rd re rB V s * rB c C s t fS r )
_TypedDictr rd rd re s r% c @ s@ e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dS )rP a% NewType creates simple unique types with almost zero
runtime overhead. NewType(name, tp) is considered a subtype of tp
by static type checkers. At runtime, NewType(name, tp) returns
a dummy callable that simply returns its argument. Usage::
UserId = NewType('UserId', int)
def name_by_id(user_id: UserId) -> str:
...
UserId('user') # Fails type check
name_by_id(42) # Fails type check
name_by_id(UserId(42)) # OK
num = UserId(5) + 1 # type: int
c C sD || _ d|v r|dd }|| _|| _t }|dkr || _d S d S )Nrg r r5 )ry
rpartitionr{ Z
__supertype__r rx )r r r r9 rd rd re r s
zNewType.__init__c C s | j d| j S )Nrg )rx ry r rd rd re r r zNewType.__repr__c C r r rd )r rp rd rd re r r zNewType.__call__c C r r )ry r rd rd re r r zNewType.__reduce__c C r r r r rd rd re r r zNewType.__or__c C r r r r rd rd re r r zNewType.__ror__N)
r{ rx ry r r r r r r r rd rd rd re rP s
rP c @ s e Zd ZdZdZeedefddZeedefddZ ed8d d
Z
eede fd d Z ede
fd
dZed8ddZede fddZed9de
defddZede fddZed9de
defddZed9d e
dee fd d Zed:d e
d!e
de
fd"d#Zede fd$d%Zede
fd&d'Zed;d(e
de
fd)d*Zede fd+d,Zed-ede
fd.d/Z ed0ee ddfd1d2Z ed rd rd re
writelines
r z
IO.writelines
IO[AnyStr]c C r r rd r rd rd re __enter__"
r z IO.__enter__c C r r rd )r r` r tracebackrd rd re __exit__&
r z IO.__exit__)r N)r r r )r r@ ) r{ rx ry r r rK r rb r' r r) r# r* r r+ r, r- rI r. r/ r1 r= r3 r6 r7 r8 r: r; r= r? rA rC rd rd rd re rE s\ rE c @ s@ e Zd ZdZdZedeeef de fddZ
ed
ddZ d S ) rD z5Typed version of the return of open() in binary mode.rd r r c C r r rd r< rd rd re r= 0
r zBinaryIO.writec C r r rd r rd rd re rA 4
r zBinaryIO.__enter__N)r rD ) r{ rx ry r r r r r bytearrayr r= rA rd rd rd re rD +
s rD c @ s e Zd ZdZdZeedefddZeede fddZ
eede e fdd Z eede
fd
d Zeedefd d
ZedddZdS )rH z3Typed version of the return of open() in text mode.rd r c C r r rd r rd rd re buffer>
r( z
TextIO.bufferc C r r rd r rd rd re encodingC
r( zTextIO.encodingc C r r rd r rd rd re errorsH
r( z
TextIO.errorsc C r r rd r rd rd re line_bufferingM
r( zTextIO.line_bufferingc C r r rd r rd rd re newlinesR
r( zTextIO.newlinesc C r r rd r rd rd re rA W
r zTextIO.__enter__N)r rH )r{ rx ry r r rK r rD rE rb rF r rG r# rH r rI rA rd rd rd re rH 9
s( rH c @ s$ e Zd ZdZg dZeZeZeZdS )ioz)Wrapper namespace for IO generic classes.)rE rH rD N)r{ rx ry r __all__rE rH rD rd rd rd re rJ \
s rJ z.ioc @ s e Zd ZdZddgZeZeZdS )rez&Wrapper namespace for re type aliases.rG rF N)r{ rx ry r rK rG rF rd rd rd re rL k
s
rL z.rer r )r r4 )r )NNF)rd )r rv r r ru Zcollections.abcr r r rL Z stdlib_rer rl r r r r rK rf rq ru r} r r r r r r r r r r r r rk r r rS r r
r r r rZ r r[ r r! r rU rV r rP rQ rh r r r r r r r rt r ri rh Z_TYPING_INTERNALSZ_SPECIAL_NAMESr r r r r r r r r r r rW rJ r rz BuiltinFunctionType
MethodTyper r rN r rM rL rO rQ rR r rT rK r r r r r r r r` r r rb rI Z_aliasr r) r, r+ r* r r r0 r' r r- r
r? r r% r! r# r& r$ r rr r rs r= dequer: r r@ r" r r r( r r r r/ rt r; defaultdictr< r> r9 r8 rC r. r r6 r4 r3 r2 r5 r1 r7 r r r r rA r r r r r rB r$ rP rX rY rE rD rH rJ r{ r rG rF rd rd rd re s g "
+
'
!
/@"ADMp+#" V
b.5
i
#59
.c#