U
ʗRe& 5 @ s2
d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZdddddddd d
d d d
ddddddddddddddd d d d d d!d"d#d$d%d&d'd(d)d*d+d,d-d.d/d0d1d2d3d4d5d6g5Z d7Z
e Z e
Zefd8d9Zejd:krd;d< Zn ejd=krd>d< Znd?d< Zdd@dAZejZedBZedCZedDZejdEd7dFZejdGd7dHZejZeedrpejddI dJkrpej Z n"G dKdL dLej d7dMZ e ddNdOZ ejdPkrej Z ndQd" Z dRd& Z eed(rej!Z!n"G dSdT dTej d7dMZ"e"d(dUdOZ!ej#Z#eed!rej$Z$ej%Z%ej&Z&n,e'e(ej'e)Z*dVd* Z$dWd! Z%dXd Z&ej+Z+ej,Z,ej-Z-ej.Z.ej/Z/ej0Z0ej1Z1ej2Z2ej3Z3eedrej4Z4ne5ej4eefZ4ej6Z6ej7Z7ej8Z8ej9Z9ej:Z:ej;Z;dYd
dZd[ddd\d]d^d_d`ddg
Zdedf Z?eed+rej@Z@n,dgdh ZAG didj dje jBZCG dkd+ d+eCdlZ@eed.rHejDZDndmd. ZDeDZEeedrhejFZFneDG dnd de@ZFeed5rejGZGejHZHejIZInzdodp ZJdqdr ZKdseK_Ld7dtdudvZMdweM_LG dxdy dye ZHeHde)fi ZGeNeG_OdzeG_PeedyrejHeHfZQneHfZQd{d' ZIeed r*ejRZRnd|d ZReed5rFejSZSn"d dlZd dlZd}d~ ZTddd%ZSeed rejUZUejVZVn$G dd dejWd7dMZVG dd d ZUejddI d:krejXZXejYZYnlzd dlmZZZ W n e[k
r ejWZZY nX zd dlm\Z] W n e[k
r" ejWZ]Y nX dd$ ZXdd# ZYeed0rHej^Z^nZejddI d=krG dd dej d7dMZ_e_dd0 Z^n"G dd dej d7dMZ_e_d0ddOZ^eedrej`Z`ejaZan.G dd dZbG dd debZ`G dd debZaeedrejcZcnG dd dedZceeds*G dd dedZeejfdd ZgeedrRejhZhejeZenDejddI d=krte_dd Zhn"G dd dej d7dMZieidddOZheed1rejjZjnZejddI d=krG dd dej d7dMZkekdd1 Zjn"G dd dej d7dMZkekd1ddOZjG dd dejld7dMZ eedr.ejmZmn e dd Zmeed rNejnZnn e dd Zneed3rnejoZon e dd3 Zoeed5rejpZpejqZqnrejddI d=krG dd dej d7dMZrerdd5 Zperdd6 Zqn.G dd dej d7dMZsesd5ddOZpesd6ddOZqeed rejtZtnejddI d=krpG dd dej d7dMZuG dd dejWd7dMZveudd Ztdd Zwn@G dd dejWd7dMZvG dd dej d7dMZxexd ddOZtdd Zweed rejyZynG dd d Zyeed,rejzZzneeddd,Zzeed r
ej{Z{neoeoddd Z{eed r.ej|Z|nZd7dddde}e}e}ej~ejej+ej ejdejf f df ejejegef ddd Z|eed see_ee_ejdPk rejZnzddÄ ZdddńZejZedddhZG ddʄ de ZdddZejjPe_Pe eddi Zejdk
r de_Lddτ Zee_dS ) NClassVar ConcatenateFinal
LiteralString ParamSpec
ParamSpecArgsParamSpecKwargsSelfType TypeVarTupleUnpack Awaitable
AsyncIterator
AsyncIterable CoroutineAsyncGeneratorAsyncContextManagerChainMapContextManagerCounterDeque DefaultDict
NamedTuple OrderedDict TypedDict
SupportsIndex Annotated assert_never assert_typeclear_overloadsdataclass_transform
get_overloadsfinalget_args
get_originget_type_hintsIntVar is_typeddictLiteralNewTypeoverloadProtocol reveal_typeruntimeruntime_checkableText TypeAlias TypeGuard
TYPE_CHECKINGNeverNoReturnRequired NotRequiredTc C s |st | d|tkrBt| dr*| js8t | dt| j}t|}||krt| drdd | jD }tdd |D }|dkr||| krdS t d ||krd
nd 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 class__parameters__c S s g | ]}t |s|qS )
_is_unpack.0pr8 r8 /builddir/build/BUILDROOT/alt-python38-pip-22.2.1-2.el8.x86_64/opt/alt/python38/lib/python3.8/site-packages/pip/_vendor/typing_extensions.py
d s z"_check_generic..c s s | ]}t |tV qd S N)
isinstancer r: r8 r8 r= e s z!_check_generic..r NzToo manyfewz parameters for z ; actual z , expected ) TypeError_markerhasattrr7 lensum)cls
parameterselenalenZ
num_tv_tuplesr8 r8 r= _check_genericW s
rM )
c C s t | tjtjtjfS r? )r@ typing
_GenericAlias_types GenericAlias UnionTypetr8 r8 r= _should_collect_from_parametersm s rW rN c C s t | tjtjfS r? )r@ rP rQ rR rS rU r8 r8 r= rW r s c C s t | tjo| j S r? )r@ rP rQ _specialrU r8 r8 r= rW u s c sj |dkrt j}g | D ]J}t||r>| kr>t|s> | t|r fdd|jD qt 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 | ]}| kr|qS r8 r8 r; rV tvarsr8 r= r> s z&_collect_type_vars..) rP TypeVarr@ r9 appendrW extendr7 tuple)typesZ
typevar_typesrV r8 r\ r= _collect_type_varsy s
rc TKTVTT_co) covariantT_contra)
contravariant )rN c @ s e Zd Zdd Zdd ZdS )
_FinalFormc C s
d| j S Nztyping_extensions._nameselfr8 r8 r= __repr__ s z_FinalForm.__repr__c C s" t || j d}t | |fS N accepts only a single type.rP _type_checkrp rQ rr rJ itemr8 r8 r= __getitem__ s
z_FinalForm.__getitem__N__name__
__module__ __qualname__rs rz r8 r8 r8 r= rm s rm )_rootaW A special typing construct to indicate that a 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.)doc)rN c C s( z
d| _ W n ttfk
r" Y nX | S )a This decorator can be used 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. The decorator
sets the ``__final__`` attribute to ``True`` on the decorated object
to allow runtime introspection.
T)Z __final__AttributeErrorrD )fr8 r8 r= r" s
c C s
t | S r? )rP r^ )namer8 r8 r= r& s c @ s e Zd Zdd Zdd ZdS ) _LiteralFormc C s
d| j S rn ro rq r8 r8 r= rs s z_LiteralForm.__repr__c C s t | |S r? )rP rQ rr rJ r8 r8 r= rz s z_LiteralForm.__getitem__Nr{ r8 r8 r8 r= r s r ao A type that can be used to indicate to type checkers
that the corresponding value has a value literally equivalent
to the provided parameter. For example:
var: Literal[4] = 4
The type checker understands that 'var' is literally equal to
the value 4 and no other value.
Literal[...] cannot be subclassed. There is no runtime
checking verifying that the parameter is actually a value
instead of a type.c C sB t | d| }z | t|j |j |jj< W n tk
r< Y nX tS )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
The overloads for a function can be retrieved at runtime using the
get_overloads() function.
__func__)getattr_overload_registryr} r~ __code__co_firstlinenor _overload_dummy)funcr r8 r8 r= r* s c C sD t | d| }|jtkrg S t|j }|j|kr2g S t||j S )z6Return all defined overloads for *func* as a sequence.r )r r} r r~ listvalues)r r mod_dictr8 r8 r= r! 4 s
c C s t dS )z$Clear all overloads in the registry.N)r clearr8 r8 r8 r= r ? s CallableIterableIteratorHashableSized Container
Collection
Reversiblec C sr t }| jd d D ]X}|jdkr$qt|di }t|j t| D ] }|dsJ|dkrJ|| qJq|S )N)r+ Generic__annotations___abc_)__abstractmethods__r __weakref__ _is_protocol_is_runtime_protocol__dict____args__ __slots__Z__next_in_mro__r7
__origin____orig_bases__Z __extra__Z
__tree_hash____doc____subclasshook____init____new__r} _MutableMapping__markerZ_gorg) set__mro__r| r r r keys
startswithadd)rI attrsbase annotationsattrr8 r8 r= _get_protocol_attrsi s
r c s t fddt D S )Nc 3 s | ]}t t |d V qd S r? )callabler r; r rI r8 r= rA } s z,_is_callable_members_only..)allr r r8 r r= _is_callable_members_only| s r c s g }d| j krt| j}d}| jD ]>}t|tjr$|jtjtfkr$|jj }|dk r\t
d|j }q$|dkrr|}ndt |}t | | ksd
fdd|D }d
dd |D }t
d| d | d
| d |}t|| _ dS ) zHelper function used in Protocol.__init_subclass__ and _TypedDictMeta.__new__.
The contents of this function are very similar
to logic found in typing.Generic.__init_subclass__
on the CPython main branch.
r NzECannot inherit from Generic[...] and/or Protocol[...] multiple types., c 3 s | ]}| krt |V qd S r? strr[ gvarsetr8 r= rA s z+_maybe_adjust_parameters..c s s | ]}t |V qd S r? r )r; gr8 r8 r= rA s zSome type variables (z) are not listed in [])r rP rc r r@ rQ r r r+ r| rD r7 r joinra )rI r] gvarsr Zthe_basetvarsets_varss_argsr8 r r= _maybe_adjust_parameters s0
r c O s t | jrtdd S )Nz Protocols cannot be instantiated)typer rD rr argskwargsr8 r8 r= _no_init s
r c 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? )rF r r r rI instancer8 r= rA s
z2_ProtocolMeta.__instancecheck__..) r r
issubclass __class__r r r super__instancecheck__r r r r= r s
z _ProtocolMeta.__instancecheck__)r| r} r~ r
__classcell__r8 r8 r r= r s r c s> e Zd ZdZdZdZ fddZejdd Z dd Z
Z S )
r+ a 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_extensions.runtime act as simple-minded runtime protocol that checks
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:
...
r8 Tc s | t krtdt | S )NzIType Protocol cannot be instantiated; it can only be used as a base class)r+ rD r r )rI r kwdsr r8 r= r s zProtocol.__new__c s t |ts|f}|s0| tjk r0td| j dd t fdd|D }| tkrtdd |D sd}t || tjr|d7 }qhtd |d d
|| t t
|t |krtd nt | |t | j t
| |S ) NzParameter list to z[...] cannot be emptyz*Parameters to generic types must be types.c 3 s | ]}t | V qd S r? rP rw r: msgr8 r= rA s z-Protocol.__class_getitem__..c s s | ]}t |tjV qd S r? )r@ rP r^ r: r8 r8 r= rA s r zBParameters to Protocol[...] must all be type variables. Parameter z is z.Parameters to Protocol[...] must all be unique)r@ ra rP TuplerD r~ r+ r r^ rG r rM r7 rQ )rI paramsir8 r r= __class_getitem__ s,
zProtocol.__class_getitem__c s d j krtj jk}n tj jk}|r0tdt j dd s\tdd jD _ fdd}d j krx| _
j sd S jD ]H}|t tjfks|j d kr|j
tkst|tr|j std
t| qt _d S ) Nr z!Cannot inherit from plain Genericr c s s | ]}|t kV qd S r? )r+ )r; br8 r8 r= rA s z-Protocol.__init_subclass__..c s j dd stS t dds>tdjd dkr6tS tdt sftdjd dkr^tS tdt | t
sxtd t D ]t}| j D ]`}||j kr|j | d krt S qt|d
i }t |t
jr||krt | tr| jr qqt S qd S ) Nr r Frk r| )abc functoolszBInstance and class checks can only be used with @runtime protocolsz._proto_hookr zcollections.abcz5Protocols can only inherit from other protocols, got )r rP r r __bases__rD r r anyr r objectr} r| _PROTO_WHITELISTr@ r reprr r )rI r r errorr r r8 r r= __init_subclass__ s2
zProtocol.__init_subclass__) r| r} r~ r r r r rP _tp_cacher r r r8 r8 r r= r+ s
) metaclassc C s( t | tr| js td| d| _| S )a4 Mark a protocol class as a runtime protocol, so that it
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 the
one-offs in collections.abc such as Hashable.
z@@runtime_checkable can be only applied to protocol classes, got T)r@ r r rD r r r8 r8 r= r. K s c @ s$ e Zd ZdZejedddZdS )r r8 )returnc C s d S r? r8 rq r8 r8 r= __index__g s zSupportsIndex.__index__N)r| r} r~ r r abstractmethodintr r8 r8 r8 r= r c s c C s> z t djd dkr tdW n ttfk
r8 Y nX dS )Nr r| )r r rP z4TypedDict does not support instance and class checksF)r r r rD r
ValueError)rI r r8 r8 r= _check_failsx s r c O s, | s t d| d | dd }} t| |S )N)TypedDict.__new__(): not enough argumentsr r )rD dict)r r _r8 r8 r= _dict_new s r z,($cls, _typename, _fields=None, /, **kwargs)totalc O s\ |s t d|d |dd }}|r>|d |dd }}n4d|krj|d}dd l}|jdtdd nt d|rz
|\}W q tk
r t d t|d d
Y qX n.r z?TypedDict('Name', {f0: t0, f1: t1, ...}); each t must be a typec s i | ]\}}|t | qS r8 r )r; ntpr r8 r=
s z*_TypedDictMeta.__new__..__required_keys__r8 __optional_keys__r __total__)r r r r r r rP r r r r itemsr updater r$ r r# r5 r r6 r frozensetr r rF r )rI r r r
r tp_dictr Zown_annotationsZ
required_keysZ
optional_keysr Zannotation_keyZannotation_typeZannotation_originZannotation_argsr r r= r sL
z_TypedDictMeta.__new__)T)T) r| r} r~ r r r r __subclasscheck__r r8 r8 r r= r s 9r a A simple typed name space. 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, with each key
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})
The class syntax is only supported in Python 3.6+, while two other
syntax forms work for Python 2.7 and 3.2+
c C s t | ttS )a Check 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
)r@ ra _TYPEDDICT_TYPESr r8 r8 r= r' s c C s | S )a Assert (to the type checker) that the value is of the given type.
When the type checker encounters a call to assert_type(), it
emits an error if the value is not of the specified type::
def greet(name: str) -> None:
assert_type(name, str) # ok
assert_type(name, int) # type checker error
At runtime this returns the first argument unchanged and otherwise
does nothing.
r8 )Z__valZ__typr8 r8 r= r 0 s
c C s t | trt| jS t| dr:| jttfkr:t| jd S t | tj rrt
dd | jD }|| jkrh| S | |S tt drt | t j
rt
dd | jD }|| jkr| S t
| j|S tt drt | t jrt
dd | jD }|| jkr| S ttj|S | S ) z=Strips Annotated, Required and NotRequired from a given type.r r c s s | ]}t |V qd S r?
_strip_extrasr; ar8 r8 r= rA N s z _strip_extras..rS c s s | ]}t |V qd S r? r r r8 r8 r= rA S s rT c s s | ]}t |V qd S r? r r r8 r8 r= rA X s )r@ _AnnotatedAliasr r rF r5 r6 r rP rQ ra copy_withrb rS rT r reduceoperatoror_)rV Z
stripped_argsr8 r8 r= r G s(
r Fc C sH t tdr tj| ||dd}ntj| ||d}|r6|S dd | D 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, adds Optional[t] if a
default value equal to None is set and recursively replaces all
'Annotated[T, ...]', 'Required[T]' or 'NotRequired[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.
- 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.
r T)globalnslocalnsinclude_extras)r$ r% c S s i | ]\}}|t |qS r8 r )r; krV r8 r8 r= r s z"get_type_hints..)rF rP r% r )objr$ r% r& hintr8 r8 r= r% _ s
c sH e Zd ZdZ fddZdd Zdd Zdd Zd
d Zd d
Z Z
S )r aK 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? )r@ r __metadata__r r r )rr originmetadatar r8 r= r s
z_AnnotatedAlias.__init__c C s$ t |dkst|d }t|| jS )Nr r )rG AssertionErrorr r* )rr r new_typer8 r8 r= r s z_AnnotatedAlias.copy_withc C s, dt | j dddd | jD dS )Nz typing_extensions.Annotated[r c s s | ]}t |V qd S r? )r r r8 r8 r= rA s z+_AnnotatedAlias.__repr__..r )rP
_type_reprr r r* rq r8 r8 r= rs s z_AnnotatedAlias.__repr__c C s t jt| jf| j ffS r? )r" getitemr r r* rq r8 r8 r=
__reduce__ s z_AnnotatedAlias.__reduce__c C s* t |tstS | j|jkr dS | j|jkS )NF)r@ r r r r* rr r r8 r8 r= __eq__ s
z_AnnotatedAlias.__eq__c C s t | j| jfS r? )hashr r* rq r8 r8 r= __hash__ s z_AnnotatedAlias.__hash__) r| r} r~ r r r rs r1 r3 r5 r r8 r8 r r= r s r c @ s2 e Zd ZdZdZdd Zejdd Zdd Z d 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 (and will be in
the __origin__ field), the remaining arguments are kept as a tuple in
the __extra__ field.
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()]
r8 c O s t dd S )Nz&Type Annotated cannot be instantiated.rD rI r r r8 r8 r= r s zAnnotated.__new__c C sn t |trt|dk r tdttf}t|d |kr@|d }nd}t|d |}t|dd }t ||S )Nrk zUAnnotated[...] should be used with at least two arguments (a type and an annotation).r z$Annotated[t, ...]: t must be a type.r )
r@ ra rG rD r r r$ rP rw r )rI r Zallowed_special_formsr+ r r, r8 r8 r= r s
zAnnotated.__class_getitem__c O s t d| j dd S )NCannot subclass z
.Annotated)rD r} r7 r8 r8 r= r s zAnnotated.__init_subclass__N)
r| r} r~ r r r rP r r r r8 r8 r8 r= r s
)_BaseGenericAlias)rS c C s> t | trtS t | tjttttfr*| j S | tj
kr:tj
S dS )a6 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) r@ r r rP rQ _typing_GenericAliasr9 r r r r r r8 r8 r= r$ s
c C sz t | tr| jf| j S t | tjtfrvt| ddr8dS | j}t | t
j j krr|d t
k rrt|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)
rZ Fr8 r Nr )r@ r r r* rP rQ r: r r r$ collectionsr r Ellipsisr )r resr8 r8 r= r# s
c @ s e Zd Zdd ZdS )_TypeAliasFormc C s
d| j S rn ro rq r8 r8 r= rs ; s _TypeAliasForm.__repr__Nr| r} r~ rs r8 r8 r8 r= r> : s r> c C s t | ddS )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.
is not subscriptableNr6 r r8 r8 r= r0 > s c @ s e Zd Zdd ZdS )r> c C s
d| j S rn ro rq r8 r8 r= rs N s r? Nr@ r8 r8 r8 r= r> M s 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.c @ s$ e Zd ZdZdZdd Zdd ZdS )
_Immutablez3Mixin to indicate that object should not be copied.r8 c C s | S r? r8 rq r8 r8 r= __copy__h s z_Immutable.__copy__c C s | S r? r8 )rr memor8 r8 r= __deepcopy__k s z_Immutable.__deepcopy__N)r| r} r~ r r rC rE r8 r8 r8 r= rB d s rB c @ s( e Zd ZdZdd Zdd Zdd ZdS ) r aQ 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 s
|| _ d S r? r rr r+ r8 r8 r= r z s zParamSpecArgs.__init__c C s | j j dS )Nz.argsr r| rq r8 r8 r= rs } s zParamSpecArgs.__repr__c C s t |tstS | j|jkS r? )r@ r r r r2 r8 r8 r= r3 s
zParamSpecArgs.__eq__Nr| r} r~ r r rs r3 r8 r8 r8 r= r n s c @ s( e Zd ZdZdd Zdd Zdd ZdS ) r a[ 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 s
|| _ d S r? rF rG r8 r8 r= r s zParamSpecKwargs.__init__c C s | j j dS )Nz.kwargsrH rq r8 r8 r= rs s zParamSpecKwargs.__repr__c C s t |tstS | j|jkS r? )r@ r r r r2 r8 r8 r= r3 s
zParamSpecKwargs.__eq__NrI r8 r8 r8 r= r s c sp e Zd ZdZejZedd Zedd Z dddd fd d
Z
d d Z d
d Z dd Z
dd Zdd Z ZS )r a' 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 s the first argument to ``Callable``. In Python 3.10 and higher,
they are also supported in user-defined Generics at runtime.
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__ == 'T'
P.__bound__ == None
P.__covariant__ == False
P.__contravariant__ == False
Note that only parameter specification variables defined in global scope can
be pickled.
c C s t | S r? )r rq r8 r8 r= r s zParamSpec.argsc C s t | S r? )r rq r8 r8 r= r s zParamSpec.kwargsNF)boundrh rj c s t | g || _t|| _t|| _|r.r )rP r/ r r r rq r8 r[ r= rs s z!_ConcatenateGenericAlias.__repr__c C s t | j| jfS r? )r4 r r rq r8 r8 r= r5 s z!_ConcatenateGenericAlias.__hash__c O s d S r? r8 r r8 r8 r= rW s z!_ConcatenateGenericAlias.__call__c C s t dd | jD S )Nc s s" | ]}t |tjtfr|V qd S r? )r@ rP r^ r )r; r r8 r8 r= rA $ s z:_ConcatenateGenericAlias.__parameters__..)ra r rq r8 r8 r= r7 " s z'_ConcatenateGenericAlias.__parameters__)r| r} r~ rP rQ r rZ r rs r5 rW rX r7 r r8 r8 r r= rY s rY c sZ |dkrt dt|ts |f}t|d ts6t dd t fdd|D }t| |S )Nr8 z&Cannot take a Concatenate of no types.r zAThe last parameter to Concatenate should be a ParamSpec variable.z/Concatenate[arg, ...]: each arg must be a type.c 3 s | ]}t | V qd S r? r r: r r8 r= rA 4 s z'_concatenate_getitem..)rD r@ ra r rY r r8 r r= _concatenate_getitem* s
r\ c C s
t | |S )& 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.
r\ r r8 r8 r= r > s c @ s e Zd Zdd Zdd ZdS )_ConcatenateFormc C s
d| j S rn ro rq r8 r8 r= rs N s z_ConcatenateForm.__repr__c C s
t | |S r? r^ r r8 r8 r= rz Q s z _ConcatenateForm.__getitem__Nr{ r8 r8 r8 r= r_ M s r_ r] c @ s e Zd Zdd ZdS )_TypeGuardFormc C s
d| j S rn ro rq r8 r8 r= rs g s _TypeGuardForm.__repr__Nr@ r8 r8 r8 r= r` f s r` c C s t || d}t | |fS ) 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).
ru )rP rw rQ rx r8 r8 r= r1 j s ,c @ s e Zd Zdd Zdd ZdS )r` c C s
d| j S rn ro rq r8 r8 r= rs s ra c C s" t || j d}t | |fS )Nz accepts only a single typerv rx r8 r8 r= rz s
z_TypeGuardForm.__getitem__Nr{ r8 r8 r8 r= r` s rb c @ sn e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dd Z dd Z dd Z
ejdd ZdS ) _SpecialForm)rp r _getitemc C s || _ |j| _|j| _d S r? )rd r| rp r )rr r0 r8 r8 r= r s z_SpecialForm.__init__c C s |dkr| j S t|d S )N> r| r~ )rp r )rr ry r8 r8 r= __getattr__ s z_SpecialForm.__getattr__c C s t d| d S )Nr8 r6 )rr r r8 r8 r= __mro_entries__ s z _SpecialForm.__mro_entries__c C s d| j S rn ro rq r8 r8 r= rs s z_SpecialForm.__repr__c C s | j S r? ro rq r8 r8 r= r1 s z_SpecialForm.__reduce__c O s t d| d S )NzCannot instantiate r6 rr r r r8 r8 r= rW s z_SpecialForm.__call__c C s t j| |f S r? rP Unionr2 r8 r8 r= __or__ s z_SpecialForm.__or__c C s t j|| f S r? rh r2 r8 r8 r= __ror__ s z_SpecialForm.__ror__c C s t | dd S )Nz! cannot be used with isinstance()r6 )rr r( r8 r8 r= r s z _SpecialForm.__instancecheck__c C s t | dd S )Nz! cannot be used with issubclass()r6 )rr rI r8 r8 r= r s z _SpecialForm.__subclasscheck__c C s | | |S r? )rd r r8 r8 r= rz s z_SpecialForm.__getitem__N)r| r} r~ r r re rf rs r1 rW rj rk r r rP r rz r8 r8 r8 r= rc s rc c C s t | ddS )aP Represents an arbitrary literal string.
Example::
from pip._vendor.typing_extensions import LiteralString
def query(sql: LiteralString) -> ...:
...
query("SELECT * FROM table") # ok
query(f"SELECT * FROM {input()}") # not ok
See PEP 675 for details.
rA Nr6 rr r r8 r8 r= r s c C s t | ddS )zUsed to spell the type of "self" in classes.
Example::
from typing import Self
class ReturnsSelf:
def parse(self, data: bytes) -> Self:
...
return self
rA Nr6 rl r8 r8 r= r s c C s t | ddS )a The bottom type, a type that has no members.
This can be used to define a function that should never be
called, or a function that never returns::
from pip._vendor.typing_extensions import Never
def never_call_me(arg: Never) -> None:
pass
def int_or_str(arg: int | str) -> None:
never_call_me(arg) # type checker error
match arg:
case int():
print("It's an int")
case str():
print("It's a str")
case _:
never_call_me(arg) # ok, arg is of type Never
rA Nr6 rl r8 r8 r= r3 - s c @ s e Zd Zdd ZdS )_ExtensionsSpecialFormc C s
d| j S rn ro rq r8 r8 r= rs M s z _ExtensionsSpecialForm.__repr__Nr@ r8 r8 r8 r= rm L s rm c C s" t || j d}t | |fS ) A special typing construct to mark a key of a total=False TypedDict
as required. For example:
class Movie(TypedDict, total=False):
title: Required[str]
year: int
m = Movie(
title='The Matrix', # typechecker error if key is omitted
year=1999,
)
There is no runtime checking that a required key is actually provided
when instantiating a related TypedDict.
ru rv rx r8 r8 r= r5 P s c C s" t || j d}t | |fS )` A special typing construct to mark a key of a TypedDict as
potentially missing. For example:
class Movie(TypedDict):
title: str
year: NotRequired[int]
m = Movie(
title='The Matrix', # typechecker error if key is omitted
year=1999,
)
ru rv rx r8 r8 r= r6 d s c @ s e Zd Zdd Zdd ZdS )
_RequiredFormc C s
d| j S rn ro rq r8 r8 r= rs w s z_RequiredForm.__repr__c C s" t || j d}t | |fS rt rv rx r8 r8 r= rz z s
z_RequiredForm.__getitem__Nr{ r8 r8 r8 r= rp v s rp rn ro c @ s e Zd Zdd ZdS )_UnpackSpecialFormc C s
d| j S rn ro rq r8 r8 r= rs s z_UnpackSpecialForm.__repr__Nr@ r8 r8 r8 r= rq s rq c @ s e Zd ZejZdS _UnpackAliasNr| r} r~ rP r^ r r8 r8 r8 r= rs s rs c C s t || j d}t| |fS ) A special typing construct to unpack a variadic type. For example:
Shape = TypeVarTuple('Shape')
Batch = NewType('Batch', int)
def add_batch_axis(
x: Array[Unpack[Shape]]
) -> Array[Batch, Unpack[Shape]]: ...
ru rP rw rp rs rx r8 r8 r= r s c C s
t | tS r? r@ rs r( r8 r8 r= r9 s r9 c @ s e Zd ZejZdS rr rt r8 r8 r8 r= rs s c @ s e Zd Zdd Zdd ZdS ) _UnpackFormc C s
d| j S rn ro rq r8 r8 r= rs s z_UnpackForm.__repr__c C s t || j d}t| |fS rt rv rx r8 r8 r= rz s
z_UnpackForm.__getitem__Nr{ r8 r8 r8 r= ry s ry ru c C s
t | tS r? rw rx r8 r8 r= r9 s c @ sN e Zd ZdZejZdd Zdd Zdd Z dd Z
d
d Z d d
Z dd Z
dS )r a Type variable tuple.
Usage::
Ts = TypeVarTuple('Ts')
In the same way that a normal type variable is a stand-in for a single
type such as ``int``, a type variable *tuple* is a stand-in for a *tuple*
type such as ``Tuple[int, str]``.
Type variable tuples can be used in ``Generic`` declarations.
Consider the following example::
class Array(Generic[*Ts]): ...
The ``Ts`` type variable tuple here behaves like ``tuple[T1, T2]``,
where ``T1`` and ``T2`` are type variables. To use these type variables
as type parameters of ``Array``, we must *unpack* the type variable tuple using
the star operator: ``*Ts``. The signature of ``Array`` then behaves
as if we had simply written ``class Array(Generic[T1, T2]): ...``.
In contrast to ``Generic[T1, T2]``, however, ``Generic[*Shape]`` allows
us to parameterise the class with an *arbitrary* number of type parameters.
Type variable tuples can be used anywhere a normal ``TypeVar`` can.
This includes class definitions, as shown above, as well as function
signatures and variable annotations::
class Array(Generic[*Ts]):
def __init__(self, shape: Tuple[*Ts]):
self._shape: Tuple[*Ts] = shape
def get_shape(self) -> Tuple[*Ts]:
return self._shape
shape = (Height(480), Width(640))
x: Array[Height, Width] = Array(shape)
y = abs(x) # Inferred type is Array[Height, Width]
z = x + x # ... is Array[Height, Width]
x.get_shape() # ... is tuple[Height, Width]
c c s | j V d S r? ) __unpacked__rq r8 r8 r= __iter__ s zTypeVarTuple.__iter__c C sX || _ ztdjdd}W n ttfk
r: d }Y nX |dkrJ|| _t| | _ d S )Nr r| r rK )
r| r r r r r r r} r rz )rr r rP r8 r8 r= r s
zTypeVarTuple.__init__c C s | j S r? rV rq r8 r8 r= rs s zTypeVarTuple.__repr__c C s
t | S r? rU rq r8 r8 r= r5 s zTypeVarTuple.__hash__c C s | |kS r? r8 r2 r8 r8 r= r3 " s zTypeVarTuple.__eq__c C s | j S r? rV rq r8 r8 r= r1 % s zTypeVarTuple.__reduce__c O s d|krt dd S )Nr z&Cannot subclass special typing classesr6 rg r8 r8 r= r ( s z TypeVarTuple.__init_subclass__N)r| r} r~ r rP r^ r r{ r rs r5 r3 r1 r r8 r8 r8 r= r s ,
)__objr c C s t dt| jtjd | S )a Reveal the inferred type of a variable.
When a static type checker encounters a call to ``reveal_type()``,
it will emit the inferred type of the argument::
x: int = 1
reveal_type(x)
Running a static type checker (e.g., ``mypy``) on this example
will produce output similar to 'Revealed type is "builtins.int"'.
At runtime, the function prints the runtime type of the
argument and returns it unchanged.
zRuntime type is )file)printr r| r stderr)r| r8 r8 r= r, 0 s )__argr c C s t ddS )a1 Assert to the type checker that a line of code is unreachable.
Example::
def int_or_str(arg: int | str) -> None:
match arg:
case int():
print("It's an int")
case str():
print("It's a str")
case _:
assert_never(arg)
If a type checker finds that a call to assert_never() is
reachable, it will emit an error.
At runtime, this throws an exception when called.
z Expected code to be unreachableN)r- )r r8 r8 r= r G s r8 )
eq_default
order_defaultkw_only_defaultfield_specifiers.)r r r r r r c s fdd}|S )a Decorator that marks a function, class, or metaclass as providing
dataclass-like behavior.
Example:
from pip._vendor.typing_extensions import dataclass_transform
_T = TypeVar("_T")
# Used on a decorator function
@dataclass_transform()
def create_model(cls: type[_T]) -> type[_T]:
...
return cls
@create_model
class CustomerModel:
id: int
name: str
# Used on a base class
@dataclass_transform()
class ModelBase: ...
class CustomerModel(ModelBase):
id: int
name: str
# Used on a metaclass
@dataclass_transform()
class ModelMeta(type): ...
class ModelBase(metaclass=ModelMeta): ...
class CustomerModel(ModelBase):
id: int
name: str
Each of the ``CustomerModel`` classes defined in this example will now
behave similarly to a dataclass created with the ``@dataclasses.dataclass``
decorator. For example, the type checker will synthesize an ``__init__``
method.
The arguments to this decorator can be used to customize this behavior:
- ``eq_default`` indicates whether the ``eq`` parameter is assumed to be
True or False if it is omitted by the caller.
- ``order_default`` indicates whether the ``order`` parameter is
assumed to be True or False if it is omitted by the caller.
- ``kw_only_default`` indicates whether the ``kw_only`` parameter is
assumed to be True or False if it is omitted by the caller.
- ``field_specifiers`` specifies a static list of supported classes
or functions that describe fields, similar to ``dataclasses.field()``.
At runtime, this decorator records its arguments in the
``__dataclass_transform__`` attribute on the decorated object.
See PEP 681 for details.
c s d| _ | S )N)r r r r r )Z__dataclass_transform__)Z cls_or_fnr r r r r r8 r= decorator s z&dataclass_transform..decoratorr8 )r r r r r r r8 r r= r a s F c C s6 zt djddW S ttfk
r0 Y d S X d S )Nrk r| r )r r r r r r r8 r8 r8 r= _caller s r c C sP dd |D }dd |D }t j| |||d}| |_|j_tjdk rL||_|S )Nc S s g | ] \}}|qS r8 r8 r; r rV r8 r8 r= r> s z!_make_nmtuple..c S s& i | ] \}}|t |d | dqS )zfield z annotation must be a typer r r8 r8 r= r s z!_make_nmtuple..defaultsmodulerX )r;
namedtupler r r version_info _field_types)r rb r r r r nm_tplr8 r8 r=
_make_nmtuple s
r r} r| r c @ s e Zd Zdd ZdS )_NamedTupleMetac
sJ t |ks t|D ] }|t k r|tjk rtdqtdd |D } di }g }|D ]L}| krn|| qV|rVtd| dt|dkrdnd d
d | qVt
|| fd d
|D d d}||_ tj|krtjj
j} t| |_
D ]>}
|
tkrtd|
q|
tkr|
|jkrt||
|
qtj|krF| |S )Nz3can only inherit from a NamedTuple type and Genericc s s | ]}|t krtn|V qd S r? ) _NamedTuplera r
r8 r8 r= rA s z*_NamedTupleMeta.__new__..r z Non-default namedtuple field z cannot follow default fieldr s r c s g | ] } | qS r8 r8 )r; r r
r8 r= r> s z+_NamedTupleMeta.__new__..r} r z&Cannot overwrite NamedTuple attribute )r r- rP r rD ra r r_ rG r r r r r r classmethod _prohibited_namedtuple_fieldsr _special_namedtuple_fieldsr setattrr ) rI r r r
r rb
default_names
field_namer Z
class_getitemkeyr8 r r= r s@ 2
z_NamedTupleMeta.__new__N)r| r} r~ r r8 r8 r8 r= r s r c K s. |d kr| }n |r tdt| |t dS )NzIEither list of fields or keywords can be provided to NamedTuple, not both)r )r rD r r )Z
__typenameZ__fieldsr r8 r8 r= r s
)rN z$(typename, fields=None, /, **kwargs)c C s t | ks ttfS r? )r r- r )r r8 r8 r= _namedtuple_mro_entries s r )N)NNF)r8 )N)r r; collections.abcr r" r rb rR rP __all__ZPEP_560r Z GenericMetar rE rM r rW rc r4 r^ rd re rf rg ri r rF r rc rm r" r& r( r r r* r! r defaultdictpartialr r r
r
r r r r r r r r _aliasr r r r) r/ r2 r r r r r+ r ABCMetar r. r- r r r r' r r __text_signature__r r| r} r r r r% r r r rQ r$ r# r9 ImportErrorrS r: r0 r> r r rB r r rY r r\ r r_ r1 r` _Finalr r r3 r5 r6 rm rp r rq rs r9 ry r r, r r rL r ri Anyr r r r _prohibitedr r r r r r r rf r8 r8 r8 r= s B
( ) ,?
, '=
d !
/
/+
P Y
%