U
e5db
G @ s d Z ddlmZmZ ddlZddlZddlZddlZddlZddl Z
ddl Z ddl Z ddl m
Z
mZmZ ddddd d
d d d
ddddddddddddddd d d d d d!d"d#d$d%d&d'd(d)d*d+d,d-d.d/d0d1d2d3d4d5d6d7d8d9d:d;dd?d@dAdBdCdDdEdFdGdHdIdJdKgGZddMdNZdOdP ZdQdR ZdSdT ZdUdV ZdWdX Zg ZdYdZ Zd[d\ ZG d]d^ d^ZG d_d` d`ZG dadb dbeedLdcZ e ddddeZ e dGdfdeZ e ddgdeZ e ddhdeZ e ddideZ!e d djdeZ"e d dkdeZ#G dld d edLdcZ$G dmd deedLdcZ%d7dd5d9d:d4d6dddn Z&dodp Z'G dqdr dredLdcZ(G dsdt dte(dLdcZ)G dud
d
Z*G dvdw dwZ+G dxdy dyZ,dzd{d|d}d~gZ-ddddddddddg
Z.e-e. dg Z/dd Z0dd Z1dd Z2dd Z3dd#ddd%dd!dd'd*g
ddgdZ4G dd deZ5G dd
d
e*e5dZ6ddI Z7dd? Z8dd Z9e j:e j;e jdddCZ?ddB Z@ddA ZAddE ZBddF ZCdd ZDddH ZEdd@ ZFe%dZGe%dZHe%dZIe%ddLdZJe%ddLdZKe%ddLdZLe%ddLdZMe%ddLeNdZOe%d>ePeQZRdddZSeSejjTdZTeSejjUeJZUeSejjVeJeMeKfZVeSejjWeJZWeSejjXeJZXeSejjYeJZYeSejjZeJZZeSejj[eJZ[eSejj\dZ\eSejj]eJZ]eSejj^eJZ^e)ejj_ddLdZ_de__ eSejj`eJZaeSejjbeGZbeSejjceHeLfZceSejjdeHeIfZdeSejjeeJZeeSejjfeGZfeSejjgdZge)ehdddLdZidei_ eSejeGddZkeSejleGZmeSeneGddZ`eSeoeJddZpeSejjqeJZqeSejjreHZreSejjseHeLfZseSejjteLZteSejueJZveSejweJZxeSeyeHeIfddZzeSej{eHeIfZ|eSej}eHeIfZ}eSej~eGZ~eSejeHeIfZeSejjeJeMeKfZeSejjeJeMfZeSeNeOddZde_ e7G dd0 d0e6Ze7G dd. d.e6Ze7G dd- d-e6Ze7G dd, d,e6Ze7G dd/ d/e6Ze7G dd+ d+e6eJ Ze7G dd1 d1e6eJ ZddÄ ZdZdZG ddDŽ deNZG dd; d;edZddʄ ZddLd˜dd̈́Zddτ ZG ddф deNZG dd< d s z&_collect_type_vars..)rP r appendrR _specialextend__parameters__tuple)r` rh rZ ri r[ _collect_type_vars s
rq c C s t | ts| S t| j}t| jD ]J\}}t |tr\t|D ] \}}||kr<|| ||< qdnd 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 ZmanyZfewz parameters for z ; actual z , expected N)ro rT len)cls
parametersZalenZelenrZ rZ r[ _check_generic s
r} c C s g }| D ]f}t |tr.|jtkr.||j qt |trdt|dkrd|d tkrd||dd q|| qt |}t|t|k rg }|D ] }||kr|| |
| q|}|rt |t|S )zyAn internal helper for Union creation and substitution: flatten Unions
among parameters, then remove duplicates.
r N) rP rR rS r rn rs rp rz rl setremoveAssertionError)r| paramspZ
all_paramsZ
new_paramsrh rZ rZ r[ _remove_dups_flatten s" "
r c s4 t t j t fdd}|S )zInternal wrapper caching __getitem__ of generic types with a fallback to
original function for non-hashable arguments.
c s, z | |W S t k
r Y nX | |S NrT argskwdscachedfuncrZ r[ inner s
z_tp_cache..inner) functools lru_cache _cleanupsrl cache_clearwraps)r r rZ r r[ _tp_cache s
r c sb t | tr| S t | tr^t fdd| jD }|| jkrH| S | |}| j|_|S | S )zEvaluate all forward references in the given type t.
For use of globalns and localns see the docstring for get_type_hints().
c 3 s | ]}t | V qd S r )
_eval_typerg rx globalnslocalnsrZ r[ s z _eval_type..)rP r _evaluaterR rp rs rv rm )rh r r Zev_argsresrZ r r[ r s
r c @ s e Zd ZdZdZdd ZdS )_Finalz Mixin to prohibit subclassing) __weakref__c O s d|krt dd S )N_rootz&Cannot subclass special typing classesr selfr r rZ rZ r[ __init_subclass__ s z_Final.__init_subclass__N)rb r^ r_ __doc__ __slots__r rZ rZ rZ r[ r s r c @ s e Zd ZdZdd Zdd ZdS )
_Immutablez3Mixin to indicate that object should not be copied.c C s | S r rZ r rZ rZ r[ __copy__% s z_Immutable.__copy__c C s | S r rZ )r ZmemorZ rZ r[ __deepcopy__( s z_Immutable.__deepcopy__N)rb r^ r_ r r r rZ rZ rZ r[ r " s r c sp e Zd ZdZdZ fddZdd Zdd Zd d
Zd d Z d
d Z
dd Z dd Z dd Z
edd Z ZS )rU zhInternal indicator of special typing constructs.
See _doc instance attribute for specific docs.
_nameZ_docc sB t |dkr6t|d tr6t|d tr6td| t | S )zConstructor.
This only exists to give a better error message in case
someone tries to subclass a special typing object (not a good idea).
r r~ zCannot subclass )rz rP rQ rp rT super__new__)r{ r r __class__rZ r[ r 3 s z_SpecialForm.__new__c C s || _ || _d S r r )r namedocrZ rZ r[ __init__@ s z_SpecialForm.__init__c C s t |tstS | j|jkS r )rP rU NotImplementedr r otherrZ rZ r[ __eq__D s
z_SpecialForm.__eq__c C s t | jfS r )hashr r rZ rZ r[ __hash__I s z_SpecialForm.__hash__c C s
d| j S )Ntyping.r r rZ rZ r[ __repr__L s z_SpecialForm.__repr__c C s | j S r r r rZ rZ r[
__reduce__O s z_SpecialForm.__reduce__c O s t d| d S )NzCannot instantiate r r rZ rZ r[ __call__R s z_SpecialForm.__call__c C s t | dd S )Nz! cannot be used with isinstance()r r rd rZ rZ r[ __instancecheck__U s z _SpecialForm.__instancecheck__c C s t | dd S )Nz! cannot be used with issubclass()r r r{ rZ rZ r[ __subclasscheck__X s z _SpecialForm.__subclasscheck__c s | j dkr(t|| j d}t| |fS | j dkr|dkrBtdt|tsR|f}d t fdd|D }t|}t|d kr|d
S t| |S | j d krt|d }t|t d f S | j d
krt| |S t| dd S )N)r r
z accepts only single type.r rZ z Cannot take a Union of no types.z)Union[arg, ...]: each arg must be a type.c 3 s | ]}t | V qd S r r\ rg r rX rZ r[ r f s z+_SpecialForm.__getitem__..r~ r r z#Optional[t] requires a single type.r
z is not subscriptable)
r r\ rR rT rP rp r rz r rO )r r| itemrW rZ r r[ __getitem__[ s(
z_SpecialForm.__getitem__)rb r^ r_ r r r r r r r r r r r r r
__classcell__rZ rZ r r[ rU , s
rU )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.
)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.
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().
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.
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].
zEOptional type.
Optional[X] is equivalent to Union[X, None].
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> e Zd ZdZdZdddZdd Zdd Zd
d Zd d
Z dS )r z-Internal wrapper to hold a forward reference.)__forward_arg____forward_code____forward_evaluated____forward_value____forward_is_argument__Tc C sn t |tstd|zt|dd}W n" tk
rJ td|Y nX || _|| _d| _d | _|| _ d S )Nz*Forward reference must be a string -- got zevalz/Forward reference must be an expression -- got F)
rP rQ rT compile SyntaxErrorr r r r r )r rW rY coderZ rZ r[ r s
zForwardRef.__init__c C sj | j r||k rd|d kr(|d kr(i }}n|d kr6|}n |d krB|}tt| j||d| jd| _d| _ | jS )Nz*Forward references must evaluate to types.rY T)r r\ r r r r )r r r rZ rZ r[ r s
zForwardRef._evaluatec C s> t |tstS | jr2|jr2| j|jko0| j|jkS | j|jkS r )rP r r r r r r rZ rZ r[ r s
zForwardRef.__eq__c C s
t | jS r )r r r rZ rZ r[ r s zForwardRef.__hash__c C s d| j dS )Nz ForwardRef())r r rZ rZ r[ r s zForwardRef.__repr__N)T)
rb r^ r_ r r r r r r r rZ rZ rZ r[ r s
c @ s6 e Zd ZdZdZddddddZdd Zd
d ZdS ) 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.
)rb __bound____constraints__
__covariant____contravariant__NF)bound covariant
contravariantc s || _ |r|rtdt|| _t|| _|r>|d k r>td|rVt|dkrVtdd t fdd|D | _|rt |d| _
nd | _
zt dj
d d
}W n ttfk
r d }Y nX |d kr|| _d S ) Nz"Bivariant types are not supported.z-Constraints cannot be combined with bound=...r~ z"A single constraint is not allowedz:TypeVar(name, constraint, ...): constraints must be types.c 3 s | ]}t | V qd S r r rf r rZ r[ r V s z#TypeVar.__init__..zBound must be a type.rb __main__typing)rb
ValueErrorboolr r rT rz rp r r\ r sys _getframe f_globalsgetAttributeErrorr^ )r r r r r Z constraintsZdef_modrZ r r[ r J s(
zTypeVar.__init__c C s& | j r d}n| jrd}nd}|| j S )N+-~)r r rb )r prefixrZ rZ r[ r b s zTypeVar.__repr__c C s | j S r )rb r rZ rZ r[ r k s zTypeVar.__reduce__)rb r^ r_ r r r r r rZ rZ rZ r[ r s + ) rr rp dictr frozensetdeque defaultdictrO r; c C s | do| dS )N__)
startswithendswith)attrrZ rZ r[
_is_dunder s r c s e Zd ZdZddddddZedd Zd
d Zd d
Zdd Z dd Z
dd Z dd Z dd Z
fddZdd Zd d Zd d Z ZS ) rR a 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.
TFN)instspecialr c C sz || _ || _|r*|d kr*|j}t||}|| _t|ts@|f}|| _tdd |D | _ t
|| _ d | _ |sv|j
| _
d S )Nc s s* | ]"}|t krd n|tkr dn|V qdS ).rZ N)_TypingEllipsis _TypingEmptyr rZ rZ r[ r s z)_GenericAlias.__init__..)_instrm rb _normalize_aliasr r rP rp rS rs rq ro r r^ )r originr r r r Z orig_namerZ rZ r[ r s
z_GenericAlias.__init__c s^ | j ttfkr td| t|ts,|f}d t fdd|D }t| | t| | j|S )Nz%Cannot subscript already-subscripted *Parameters to generic types must be types.c 3 s | ]}t | V qd S r r r r rZ r[ r s z,_GenericAlias.__getitem__..) rS r r rT rP rp r} ru ro r r rZ r r[ r s
z_GenericAlias.__getitem__c C s t | j|| j| jdS )N)r r )rR rS r r r rZ rZ r[ rv s z_GenericAlias.copy_withc C s | j dks&t| jdkrx| jd tkrx| j r8d| j }n
t| j}| jshdddd | jD d }nd
}| | S | jrd S d dd
d | jd d D dt| jd d S )Nr r r [, c S s g | ] }t |qS rZ re r rZ rZ r[ rk s z*_GenericAlias.__repr__..] ztyping.Callableztyping.Callable[[c S s g | ] }t |qS rZ r r rZ rZ r[ rk s z], )r rz rs Ellipsisre rS rm join)r r r rZ rZ r[ r s
z_GenericAlias.__repr__c C sR t |tstS | j|jkr dS | jtkrF|jtkrFt| jt|jkS | j|jkS )NF)rP rR r rS r r rs r rZ rZ r[ r s
z_GenericAlias.__eq__c C s, | j tkr ttt| jfS t| j | jfS r )rS r r r rs r rZ rZ r[ r s
z_GenericAlias.__hash__c O sT | j s$td| j d| j d| j||}z
| |_W n tk
rN Y nX |S )NType z cannot be instantiated; use z
() instead)r rT r lowerrS __orig_class__r )r r kwargsresultrZ rZ r[ r s
z_GenericAlias.__call__c C s | j rZg }| j|kr || j || }tdd ||d d D sR|t t|S | jtkrt|krpdS || }||d d D ] }t|t r|| k r dS q| jfS )Nc s s" | ]}t |tpt|tV qd S r )rP rR
issubclassr rg brZ rZ r[ r s z0_GenericAlias.__mro_entries__..r~ rZ )
r rS rl indexanyr rp r rP rR )r basesr ry r rZ rZ r[ __mro_entries__ s$
z _GenericAlias.__mro_entries__c C s* d| j kr t|s t| j|S t|d S )NrS )__dict__r getattrrS r )r r rZ rZ r[ __getattr__ s z_GenericAlias.__getattr__c s2 t |s|dkr t || nt| j|| d S )N)r r rm )r r __setattr__setattrrS )r r valr rZ r[ r s z_GenericAlias.__setattr__c C s | t|S r )r rO r rZ rZ r[ r s z _GenericAlias.__instancecheck__c C s< | j r0t|ts t|| jS |j r0t|j| jS tdd S )NzBSubscripted generics cannot be used with class and instance checks)rm rP rR r rS rT r rZ rZ r[ r s
z _GenericAlias.__subclasscheck__c C s | j r | jS | jr t | j }n| j}|tkrht| jdkrJ| jd tksht| jd d | jd f}n*t | j}t|dkrt
|d t s|\}t j ||ffS )Nr r r r~ )
rm r globalsrS r rz rs r rr rp rP operatorgetitem)r r r rZ rZ r[ r s
z_GenericAlias.__reduce__)rb r^ r_ r r r r rv r r r r r r r r r r r rZ rZ r r[ rR s
rR c s, e Zd ZdZdd Ze fddZ ZS )_VariadicGenericAliaszSame as _GenericAlias above but for variadic aliases. Currently,
this is used only by special internal aliases: Tuple and Callable.
c C s | j dks| js| |S t|tr0t|dkr8td|\}}|tkrRt|f}n$t|tsjtd| t||f}| |S )Nr r z6Callable must be used as Callable[[arg, ...], result].z1Callable[args, result]: args must be a list. Got ) r rm __getitem_inner__rP rp rz rT r rr )r r r r rZ rZ r[ r " s
z!_VariadicGenericAlias.__getitem__c s
| j tkr| jr|dkr$| tfS t|ts4|f}t|dkrl|d dkrld t|d }| |tfS d t fdd |D }| |S | j t j
j kr| jr|\}}d
t| }|t kr| t|fS d t fd d |D }||f }| |S t
|S )
NrZ r r~ .z Tuple[t, ...]: t must be a type.r z*Tuple[t0, t1, ...]: each t must be a type.c 3 s | ]}t | V qd S r r r r rZ r[ r > s z:_VariadicGenericAlias.__getitem_inner__..z.Callable[args, result]: result must be a type.z6Callable[[arg, ...], result]: each arg must be a type.c 3 s | ]}t | V qd S r r )rg rW r rZ r[ r G s )rS rp rm rv r rP rz r\ r collectionsabcr r r r )r r r r r r r r[ r 2 s.
z'_VariadicGenericAlias.__getitem_inner__)rb r^ r_ r r r r r rZ rZ r r[ r s r c s@ e Zd ZdZdZdZ fddZedd Z fdd Z 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
rZ Fc s^ | t tfkr td| j dt jtjkrF| jtjk rFt | }nt j| f||}|S )Nr z< cannot be instantiated; it can be used only as a base class)r r rT rb r r objectr )r{ r r rd r rZ r[ r d s zGeneric.__new__c s t |ts|f}|s.| tk r.td| j dd t fdd|D }| ttfkrtdd |D sxtd| j dt t
|t |krtd| j d n
t | | t | |S )
NzParameter list to z[...] cannot be emptyr c 3 s | ]}t | V qd S r r r r rZ r[ r v s z,Generic.__class_getitem__..c s s | ]}t |tV qd S r )rP r r rZ rZ r[ r y s zParameters to z [...] must all be type variablesz[...] must all be unique)
rP rp r rT r_ r r allrb rz r r} rR )r{ r rZ r r[ __class_getitem__n s&
zGeneric.__class_getitem__c
s
t j|| g }d| jkr(t| jk}nt| jko:| jdk}|rHtdd| jkrt| j}d }| jD ].}t |t
rf|j tkrf|d k rtd|j }qf|d k rt
|}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 | ]}| krt |V qd S r rQ rf ZgvarsetrZ r[ r s z,Generic.__init_subclass__..c s s | ]}t |V qd S r r )rg grZ rZ r[ r s zSome type variables (z ) are not listed in Generic[r )r r r
r r __bases__rb rT rq rP rR rS ro r r rp )
r{ r r rj errorZgvarsbaseZtvarsetZs_varsZs_argsr r r[ r s8
zGeneric.__init_subclass__) rb r^ r_ r r _is_protocolr r r r r rZ rZ r r[ r M s
c @ s e Zd ZdZdS )r 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.
Nrb r^ r_ r rZ rZ rZ r[ r s r c @ s e Zd ZdZdS )r z(Internal placeholder for ... (ellipsis).Nr% rZ rZ rZ r[ r s r ro r r r$ _is_runtime_protocol__abstractmethods____annotations__r
r r r^ r r __subclasshook__r _MutableMapping__markerc C sr t }| jdd D ]X}|jdkr$qt|di }t|j t| D ] }|dsJ|tkrJ| | qJq|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__rb r rr r
keysr EXCLUDED_ATTRIBUTESadd)r{ attrsr# annotationsr rZ rZ r[ _get_protocol_attrs s
r1 c s t fddt D S )Nc 3 s | ]}t t |d V qd S r )rV r rg r r{ rZ r[ r s z,_is_callable_members_only..)r r1 r3 rZ r3 r[ _is_callable_members_only s r4 c O s t | jrtdd S )Nz Protocols cannot be instantiated)rO r$ rT )r r r rZ rZ r[ _no_init s
r5 c C s6 zt djd dkW S ttfk
r0 Y dS X dS )zAllow instnance 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 rb )r r TN)r r r r r rZ rZ rZ r[ _allow_reckless_class_cheks s r6 AbstractContextManagerAbstractAsyncContextManager)zcollections.abc
contextlibc s e Zd Z fddZ ZS )
_ProtocolMetac sV t ddrt r$tj r$dS jrJt fddt D rJdS t S )Nr$ FTc 3 s8 | ]0}t |o.tt |d p.t|d k V qd S r )hasattrrV r r2 r{ instancerZ r[ r s
z2_ProtocolMeta.__instancecheck__..) r r4 r r r$ r r1 r r r< r r< r[ r s
z _ProtocolMeta.__instancecheck__)rb r^ r_ r r rZ rZ r r[ 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:
...
rZ TFc s t j|| jdds2tdd jD _ fdd}d jkrN| _ jsXd S jD ]F}|tt fks^|j
t kr|j t |j
ks^t
|t r|js^td| q^t _d S ) Nr$ Fc s s | ]}|t kV qd S r )r r rZ rZ r[ r ) s z-Protocol.__init_subclass__..c s j ddstS t dds0t r(tS tdt sJt rBtS tdt| ts\tdt D ]v}| j
D ]b}||j kr|j | d krt S qdt|di }t|t j j
rn||krnt| trn| jrn qdqnt S qddS ) Nr$ Fr& zLInstance and class checks can only be used with @runtime_checkable protocolsz._proto_hookr) z7Protocols can only inherit from other protocols, got %r)r r r
r r
r! r$ r) r r r^ _PROTO_WHITELISTrb r rT r5 r )r{ r r r> r# r r3 r[ r $ s, &
zProtocol.__init_subclass__) rb r^ r_ r r r$ r& r r rZ rZ r r[ r s
) metaclassc C s& t | tr| js td| 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)r r r$ rT r& r3 rZ rZ r[ rK d s c C s |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).
rZ )typr rZ rZ r[ rA } s c
C s z
| j }W n tk
r" i Y S X |j}|j}|d| }| jpDd}| j}|rXt|ni }|t| }t||d |D ] \}} ||kst | ||< qz|S )z:Internal helper to extract the default arguments, by name.NrZ )
__code__r co_argcount co_varnames __defaults____kwdefaults__r rz zipr )
r r Z pos_countZ arg_namesdefaultsZ
kwdefaultsr Z
pos_offsetr valuerZ rZ r[
_get_defaults s
rJ c C s t | ddri S t| tri }t| jD ]z}|dkrDtj|j j}n|}|j di }|
D ]B\}}|dkrvtd}t|t rt |dd}t
|||}|||< q^q(|S |dkrt| tjr| j}n"| } t| dr| j} qt | di }|dkr|}n|dkr|}t | dd}|dkr6t| tr(i S td| t| }
t|}|
D ]d\}}|dkrhtd}t|t r|t |}t
|||}||
kr|
| dkrt| }|||< qN|S ) a Return type hints for an object.
This is often the same as obj.__annotations__, but it handles
forward references encoded as string literals, and if necessary
adds Optional[t] if a default value equal to None is set.
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.
- 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( Fr __wrapped__ __globals__z1{!r} is not a module, class, method, or function.)r rP rO reversedr+ r modulesr^ r
r itemsrQ r r r`
ModuleTyper; rL _allowed_typesrT formatrJ r r ) rd r r Zhintsr# Z base_globalsannr rI ZnsobjrH rZ rZ r[ rE s^
c C s t | tr| jS | tkr tS dS )a Get the unsubscripted version of a type.
This supports generic types, Callable, Tuple, Union, Literal, Final and ClassVar.
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
N)rP rR rS r )rw rZ rZ r[ rD s
c C sR t | trN| jsN| j}t| tjjkrJ|d tk rJt |dd |d f}|S 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 Nr rZ )
rP rR rm rs rD r r r r rr )rw r rZ rZ r[ rC s c C s t | trt| j }| j D ]"\}}|| j| f kr || q | D ](}t |tj r`d|_
t |trJt | qJz
d| _
W n t k
r Y nX | S )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)
rP rO r
copyrP r! popvaluesr` ra rK rG rT )rW Z arg_attrsr r rd rZ rZ r[ rG s
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 | |}t |}|S r )rG )r r r decoratorrZ r[ wrapped_decorator@ s
z2no_type_check_decorator..wrapped_decorator)r r )rY rZ rZ rX r[ rH 9 s c O s t ddS )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.N)NotImplementedErrorr rZ rZ r[ _overload_dummyI 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 rZ rZ r[ rJ R s c C s | S )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.
rZ )frZ rZ r[ rB o s TKTVTT_co)r V_coVT_coT_contra)r CT_co)r r c C s t | |d|dS )NT)r r )rR )r r r rZ rZ r[ _alias s rf rZ )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.
F)r r 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 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 @ s& e Zd ZdZdZeedddZdS )r2 z(An ABC with one abstract method __int__.rZ returnc C s d S r rZ r rZ rZ r[ __int__ s zSupportsInt.__int__N)rb r^ r_ r r r intri rZ rZ rZ r[ r2 s c @ s& e Zd ZdZdZeedddZdS )r0 z*An ABC with one abstract method __float__.rZ rg c C s d S r rZ r rZ rZ r[ __float__ s zSupportsFloat.__float__N)rb r^ r_ r r r floatrk rZ rZ rZ r[ r0 s c @ s& e Zd ZdZdZeedddZdS )r/ z,An ABC with one abstract method __complex__.rZ rg c C s d S r rZ r rZ rZ r[ __complex__
s zSupportsComplex.__complex__N)rb r^ r_ r r r complexrm rZ rZ rZ r[ r/ s c @ s& e Zd ZdZdZeedddZdS )r. z*An ABC with one abstract method __bytes__.rZ rg c C s d S r rZ r rZ rZ r[ __bytes__ s zSupportsBytes.__bytes__N)rb r^ r_ r r r bytesro rZ rZ rZ r[ r. s c @ s& e Zd ZdZdZeedddZdS )r1 z*An ABC with one abstract method __index__.rZ rg c C s d S r rZ r rZ rZ r[ __index__ s zSupportsIndex.__index__N)rb r^ r_ r r r rj rq rZ rZ rZ r[ r1 s c @ s& e Zd ZdZdZeedddZdS )r- zMAn ABC with one abstract method __abs__ that is covariant in its return type.rZ rg c C s d S r rZ r rZ rZ r[ __abs__( s zSupportsAbs.__abs__N)rb r^ r_ r r r ra rr rZ rZ rZ r[ r- # s c @ s* e Zd ZdZdZedeedddZdS ) r3 zOAn ABC with one abstract method __round__ that is covariant in its return type.rZ r )ndigitsrh c C s d S r rZ )r rs rZ rZ r[ __round__2 s zSupportsRound.__round__N)r ) rb r^ r_ r r r rj ra rt rZ rZ rZ r[ r3 - s c st d fdd|D }t | dd |D }t| |_|_ztdjdd|_ W n t
t fk
rn Y nX |S )NzDNamedTuple('Name', [(f0, t0), (f1, t1), ...]); each t must be a typec s g | ]\}}|t | fqS rZ r rg nrh r rZ r[ rk 9 s z!_make_nmtuple..c S s g | ] \}}|qS rZ rZ ru rZ rZ r[ rk : s r rb r ) r
namedtupler r( _field_typesr r r r r^ r r )r r` nm_tplrZ r r[
_make_nmtuple7 s rz ) r r r __getnewargs___fields_field_defaultsrx _make_replace_asdictZ_source)r^ rb r( c s e Zd Z fddZ ZS )NamedTupleMetac s | ddr t | |||S | di }t|| }g }i }|D ]H}||krl|| } || | ||< qD|rDtdj|d| dqDt
||j_ t ||j_
||_|D ]<}
|
tkrtd|
q|
tkr|
|jkrt||
||
q|S )Nr Fr( zXNon-default namedtuple field {field_name} cannot follow default field(s) {default_names}r )
field_nameZ
default_namesz&Cannot overwrite NamedTuple attribute )r r r rz rP rl rT rS r r, r r( rp rE r} _prohibitedr rm r| r ) r{ typenamer nsr` ry rH Z
defaults_dictr Z
default_valuekeyr rZ r[ r O s2
zNamedTupleMeta.__new__)rb r^ r_ r r rZ rZ r r[ r M s r c @ s" e Zd ZdZdZdd Zde_dS )r= 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)])
Tc O s | s t d| ^}} | r"| ^}} n4d|krN|d}dd l}|jdtdd nt d| rz
| \}W q tk
r t dt| d d d Y qX n r r( z?TypedDict('Name', {f0: t0, f1: t1, ...}); each t must be a typec s i | ]\}}|t | qS rZ r )rg rv rw r rZ r[
s z*_TypedDictMeta.__new__..r )
r r r r r r r rP updater
r( r; r )r{ r r r r Ztp_dictZannsr# r r r[ r s
z_TypedDictMeta.__new__)T)rb r^ r_ r r r r r rZ rZ r r[ r s r c @ s e Zd ZdZdS )r> a 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 Point2D.__annotations__. 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+
Nr% rZ rZ rZ r[ r> s c C s dd }| |_ ||_|S )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 function 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 S s | S r rZ )xrZ rZ r[ new_type s zNewType..new_type)rb Z
__supertype__)r rw r rZ rZ r[ rF s c @ s e Zd ZdZdZeeedddZeeedddZ eddd d
Z
eee dd d Z ee
dd
dZeddddZee dddZed7e
edddZee dddZed8e
edddZed9e
ee d d d Zed:e
e
e
d d!d"Zee dd#d$Zee
dd%d&Zed;e
e
d'd(d)Zee dd*d+Zeee
d,d-d.Z eee dd/d0d1Z ed2dd3d4Z eddd5d6Z dS )<IOa Generic base class for TextIO and BinaryIO.
This is an abstract, generic version of the return of open().
NOTE: This does not distinguish between the different possible
classes (text vs. binary, read vs. write vs. read/write,
append-only, unbuffered). The TextIO and BinaryIO subclasses
below capture the distinctions between text vs. binary, which is
pervasive in the interface; however we currently do not offer a
way to track the other distinctions in the type system.
rZ rg c C s d S r rZ r rZ rZ r[ mode= s zIO.modec C s d S r rZ r rZ rZ r[ r B s zIO.nameNc C s d S r rZ r rZ rZ r[ closeG s zIO.closec C s d S r rZ r rZ rZ r[ closedK s z IO.closedc C s d S r rZ r rZ rZ r[ filenoP s z IO.filenoc C s d S r rZ r rZ rZ r[ flushT s zIO.flushc C s d S r rZ r rZ rZ r[ isattyX s z IO.isattyr )rv rh c C s d S r rZ )r rv rZ rZ r[ read\ s zIO.readc C s d S r rZ r rZ rZ r[ readable` s z IO.readable)limitrh c C s d S r rZ )r r rZ rZ r[ readlined s z IO.readline)hintrh c C s d S r rZ )r r rZ rZ r[ readlinesh s z IO.readlinesr )offsetwhencerh c C s d S r rZ )r r r rZ rZ r[ seekl s zIO.seekc C s d S r rZ r rZ rZ r[ seekablep s z IO.seekablec C s d S r rZ r rZ rZ r[ tellt s zIO.tell)sizerh c C s d S r rZ )r r rZ rZ r[ truncatex s z IO.truncatec C s d S r rZ r rZ rZ r[ writable| s z IO.writablesrh c C s d S r rZ r r rZ rZ r[ write s zIO.write)linesrh c C s d S r rZ )r r rZ rZ r[
writelines s z
IO.writelinesz
IO[AnyStr]c C s d S r rZ r rZ rZ r[ __enter__ s z IO.__enter__c C s d S r rZ )r rO rI tracebackrZ rZ r[ __exit__ s z IO.__exit__)r )r )r )r )N) rb r^ r_ r r propertyr rQ r r r r r rj r r r r@ r r r r9 r r r r r r r r r r rZ rZ rZ r[ r . sZ r c @ sB e Zd ZdZdZeeeef e dddZ
ed dddZ d S )
BinaryIOz5Typed version of the return of open() in binary mode.rZ r c C s d S r rZ r rZ rZ r[ r s zBinaryIO.writerg c C s d S r rZ r rZ rZ r[ r s zBinaryIO.__enter__N) rb r^ r_ r r r r rp bytearrayrj r r rZ rZ rZ r[ r s r c @ s e Zd ZdZdZeeedddZeee dddZ
eee e ddd Z eee
dd
d Zeeedd d
Zed dddZdS )TextIOz3Typed version of the return of open() in text mode.rZ rg c C s d S r rZ r rZ rZ r[ buffer s z
TextIO.bufferc C s d S r rZ r rZ rZ r[ encoding s zTextIO.encodingc C s d S r rZ r rZ rZ r[ errors s z
TextIO.errorsc C s d S r rZ r rZ rZ r[ line_buffering s zTextIO.line_bufferingc C s d S r rZ r rZ rZ r[ newlines s zTextIO.newlinesc C s d S r rZ r rZ rZ r[ r s zTextIO.__enter__N)rb r^ r_ r r r r r r rQ r r r r r r r r rZ rZ rZ r[ r s& r c @ s& e Zd ZdZdddgZeZeZeZdS )ioz)Wrapper namespace for IO generic classes.r r r N)rb r^ r_ r __all__r r r rZ rZ rZ r[ r s
r z.ioc @ s e Zd ZdZddgZeZeZdS )rez&Wrapper namespace for re type aliases.PatternMatchN)rb r^ r_ r r r r rZ rZ rZ r[ r s r z.re)T)NN)T)N)r r r r r Zcollections.abcr9 r r r Z stdlib_rer r` r r r r r\ re rq ru r} r r r r r r rU r rI r r
r r r
r r r r rR r r r r Z_TYPING_INTERNALSZ_SPECIAL_NAMESr- r1 r4 r5 r6 r? r: r rK rA rJ ra BuiltinFunctionType
MethodTyperQ rR rE rD rC rG rH r\ rJ rB r^ r_ r` ra rb rc rd rO re rp rQ r@ rf r r% r( r' r& r r r, r# r r) r r; r r! r r r" r r rp r rr r9 r r6 r r r< r r r r$ r7 r r8 r+ r r7 r r8 r: r5 r4 r? r* r r2 r0 r/ r. r1 r- r3 rz r rm r r= r r r r r> rF rL rM r r r r rb rO r r rZ rZ rZ r[ s( X
!
I
2a
/[ b
V
@+ c#