֦i4 d Z ddlmZmZ ddlZddlmZ ddlZddlZddlZddl Z ddl
Z
ddl Z ddl
Z
ddlZddlZddlmZmZmZmZ ddlmZmZmZmZmZmZmZm Z g dZ ddd d
Z ddd d Z d
Z d Z!d Z"d Z#d Z$d Z%dddZ&d Z'd Z(d Z)d Z*g Z+i Z,ddddZ-d e. dd Z/ G d d Z0 G d d Z1 G d! d"e0e1d # Z2 G d$ d%e2d # Z3 G d& d'e4 Z5 G d( d)e5* Z6e2d+ Z7e2d, Z8e2d- Z9e2d. Z:e2d/ Z;e2d0 Ze2d3 Z?e3 e-d d4 Z@e2d5 ZAe2d6 ZBe2d7 ZC G d8 d9e0d # ZDd:e6d;eEfd<ZFd:e6d;eEfd=ZG G d> d? ZHd@ ZIdA ZJdB ZKdC ZLe-dD ZMdE ZNdF ZO G dG dHe0d # ZP G dI dJePd # ZQ G dK dLe1ePd # ZR G dM dNeRd # ZS G dO dPe1eQd # ZT G dQ dReRd # ZU G dS dTeRd # ZV G dU dVe1eQd # ZWdW ZX G dX dYeQd # ZY G dZ d[eQd # ZZe2d\ Z[ G d] d^eQd # Z\ G d_ d` Z] e.h da Z^ e.h db Z_e^e_z dchz Z`dd Zade ZbddgZcddiZdg djdkdlgdmZee j dn Zge+j egj do Zj ej eej dp Zl ej eel [j[l G dq dre Zmends Zo G dt due em* Zp G dv dwe1eQd # Zq G dx dy Zrdz Zsd{ Ztd| Zuej ej ej ej eeefZzdd}Z{d~ Z|d Z}d Z~d ZdZde8d;e8fdZd Zd Zd Z e e j
ee Zd Zd Zd Zd Z ed Z ed Z ed Z edd Z edd Z edd Z edd Z edd e4 Z edee ZeRZ eej j0 d Z eej j2 df Z eej j4 d Z eej j6 df Z eej j8 df Z eej j: df Z eej j< df Z eej j> df Z eej j@ d Z eej jB df Z eej jD df Z eUej jF dh Zde_ eej jH dfd Z eej jL df Z eej jN dh Z eej jP dh Z eej jR df Z eej jT df Z eSej jV dd Z eVeddd Zde_ eedfdd Z eej` dfd Z eedfdd Z ee.dfdd Z eej jh df Z eej jj df Z eej jl dh Z eej jn df Z eejp dfd Z eejt dfd Z eedhdd Z eej
dhd Z eej| dh Z eej~ df Z eej dh Z eej j d Z eej j dh Z ee4dfdd Zde_ es G d dep Zes G d dep Zes G d dep Zes G d dep Zes G d dep Zes d Zes d ZddZ e.h d Z e.h d Z G d de4 ZddZe4j eddi Zd Zee_ G d de4 Zdd dÜdĄZe4j eddi ZdƄ e_ e2dDŽ Ze2dȄ Z G dɄ dʫ ZeZdZ G d˄ de e Z G d̈́ dee Z G dτ dee Z G dф de4 Z G dӄ de߬* Zedz e_ ee
j ej < ee j df Z ee j df Z G dք de߬* Z edz e _ e e
j e j < dل Z G dڄ dep Zd dddddܜdeEdeEdeEdeEdee4e6 ede6f z df de6d;efdZddd f Z d Zy)a
The typing module: Support for gradual typing as defined by PEP 484 and subsequent PEPs.
Among other things, the module includes the following:
* Generic, Protocol, and internal machinery to support generic aliases.
All subscripted types like X[int], Union[int, str] are generic aliases.
* Various "special forms" that have unique meanings in type annotations:
NoReturn, Never, ClassVar, Self, Concatenate, Unpack, and others.
* Classes whose instances can be type arguments to generic classes and functions:
TypeVar, ParamSpec, TypeVarTuple.
* Public helper functions: get_type_hints, overload, cast, final, and others.
* Several protocols to support duck-typing:
SupportsFloat, SupportsIndex, SupportsAbs, and others.
* Special types: NewType, NamedTuple, TypedDict.
* Deprecated wrapper submodules for re and io related types.
* Deprecated aliases for builtin types and collections.abc ABCs.
Any name not present in __all__ is an implementation detail
that may be changed without notice. Use at your own risk!
)abstractmethodABCMetaN) defaultdict)WrapperDescriptorTypeMethodWrapperTypeMethodDescriptorType GenericAlias)_idfuncTypeVar ParamSpec TypeVarTuple
ParamSpecArgsParamSpecKwargs
TypeAliasTypeGeneric)c AnnotatedAnyCallableClassVar ConcatenateFinal
ForwardRefr LiteralOptionalr ProtocolTupleTyper r
Union AbstractSet
ByteString ContainerContextManagerHashable ItemsViewIterableIteratorKeysViewMapping MappingViewMutableMappingMutableSequence
MutableSetSequenceSized
ValuesView Awaitable
AsyncIterator
AsyncIterable Coroutine
CollectionAsyncGeneratorAsyncContextManager
Reversible SupportsAbs
SupportsBytesSupportsComplex
SupportsFloat
SupportsIndex SupportsInt
SupportsRoundChainMapCounterDequeDict DefaultDictList OrderedDictSet FrozenSet
NamedTuple TypedDict GeneratorBinaryIOIOMatchPatternTextIOAnyStr assert_type assert_nevercastclear_overloadsdataclass_transformfinalget_args
get_origin
get_overloadsget_type_hints is_typeddict
LiteralStringNeverNewType
no_type_checkno_type_check_decoratorNoReturn NotRequiredoverloadoverrider r Required reveal_typeruntime_checkableSelfText
TYPE_CHECKING TypeAlias TypeGuardr UnpackFallow_special_formsc \ | t d S t | t rt | || S | S )z=For converting None to type(None), and strings to ForwardRef.N)moduleis_class)type
isinstancestrr )argrq ro s /usr/lib64/python3.12/typing.py
_type_convertrx s0
{Dz#s#f7JKK J Tc t t f}|s|t fz
}|r
|t fz
}t | || } t | t r | j |v rt | d | t t t t t t fv r| S |r| t t fv r| S t | t s| t t fv rt d| d t! | t" u rt | 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).
)rq ro is not valid as type argumentzPlain z Got z.100.)r r r r rx rt
_GenericAlias
__origin__ TypeErrorr r\ ra r] rh rk _SpecialFormrs tuple)rv msg is_argumentrq ro invalid_generic_formss rw _type_checkr s %h / (, !eX - !
F@S
TC3
& NN 3 33% =>??
sM8UD)DD
sx&7 7
#|$/B(B&%CDEE CyE3%uS4L233 Jry c N | du xs t | t t t t f S N.)rt r listr _ConcatenateGenericAlias)rv s rw _is_param_exprr s, #: @C
D)%= >@ @ry c | j t j j u xr t | dk( xr t |d S )aC Internal helper for munging collections.abc.Callable's __args__.
The canonical representation for a Callable's __args__ flattens the
argument types, see https://github.com/python/cpython/issues/86361.
For example::
>>> import collections.abc
>>> P = ParamSpec('P')
>>> collections.abc.Callable[[int, int], str].__args__ == (int, int, str)
True
>>> collections.abc.Callable[P, str].__args__ == (P, str)
True
As a result, if we need to reconstruct the Callable from its __args__,
we need to unflatten it.
r )r~ collectionsabcr lenr )typargss rw _should_unflatten_callable_argsr s@ & +//222 =Ta ;N47$; <ry c V t | t r6| j dk( r | j S | j d| j S | du ryt | t j
r | j S t | t r ddj d | D z dz S 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).
builtinsr| ....[, c 3 2 K | ] }t | y wN)
_type_repr).0ts rw z _type_repr.. s :cz!}c ])
rt rs
__module__ __qualname__types FunctionType__name__r joinreprobjs rw r r s #t >>Z '## #..!3#3#3"455
cz#u))*||#u TYY :c :::S@@ 9ry c ` g }| D ] }t |t rt |t r/|D ]) }t |g D ] }||vs|j | + St |d r||vsd|j | vt
|dd D ] }||vs|j | t | S )a Collect all type variables and parameter specifications in args
in order of first appearance (lexicographic order).
For example::
>>> P = ParamSpec('P')
>>> T = TypeVar('T')
>>> _collect_parameters((T, Callable[P, T]))
(~T, ~P)
__typing_subst____parameters__ )rt rs r _collect_parametersappendhasattrgetattr)r
parametersr x collecteds rw r r s J
a
5
! !4aS!9I
2")))4 ": Q*
+
"!!!$ Q 0"5J& %%a( 6 $ ry c
|st | d t | }||k7 r t d||kD rdnd d| d| d| y) zCheck correct count for parameters of a generic cls (internal helper).
This gives a nice error message in case of count mismatch.
is not a generic classToo manyfew arguments for ; actual , expected N)r r )clsr elenalens rw _check_genericr ' sh
3% 6788 z?D t|$v% @PSu U##'& D6; < < ry c g }| D ]= }t |dd }||r|d du s|j | -|j | ? |S )N __typing_unpacked_tuple_args__.)r extendr )r newargsrv subargss rw _unpack_argsr 3 sR G# ?F GBK34F NN7 # NN3 Nry unhashable_fallbackc h t j | S # t $ r |s t | cY S w xY wr )dictfromkeysr _deduplicate_unhashable)paramsr s rw _deduplicater = s6 /}}V$$ /" &v.. /s 11c D g }| D ] }||vs|j | |S r )r )unhashable_paramsnew_unhashabler s rw r r G s/ N
N " ! !! $ ry c t | }t | }t | } |D ] }|j | | S # t $ r Y yw xY w)NF)r r remove
ValueError)
first_args second_argsfirst_unhashablesecond_unhashabler elems rw _compare_args_orderlessr N sZ .z:/ <
A$D
HHTN % 5L s ? A
A c g }| D ]O }t |t t j f r |j |j
?|j
| Q t t |d S )zwInternal helper for Union creation and substitution.
Flatten Unions among parameters, then remove duplicates.
Tr ) rt _UnionGenericAliasr UnionTyper __args__r r r r r ps rw _remove_dups_flattenr Y sW F
a,eoo> ? MM!** % MM! f$? @@ry c g }| D ]? }t |t r |j |j /|j | A t | S )zHInternal helper for Literal creation: flatten Literals among parameters.)rt _LiteralGenericAliasr r r r r s rw _flatten_literal_paramsr i sD
F
a- . MM!** % MM!
=ry typedc & fd}| || S |S )zInternal wrapper caching __getitem__ of generic types.
For non-hashable arguments, the original function is used as a fallback.
c t j }|t < t j |j
~t j fd }|S )Nr c P t | i |S # t $ r Y nw xY w | i |S r )_cachesr )r kwdsfuncs rw innerz+_tp_cache..decorator..inner s>
t}d3d33
&& &s
) functools lru_cacher _cleanupsr cache_clearwraps)r cacher r s ` rw decoratorz _tp_cache..decorator} s^ 1 ##%06
**+ '
' ry r )r r r s ` rw _tp_cacher x s
( ry recursive_guardc t | t r| j S t | t t t
j f r t | t rft d | j D }| j }t | | r| j |dd |d f } n| j | } |r t | } t fd| j D }|| j k( r| S t | t rt | j | S t | t
j r$t j t j | 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().
recursive_guard is used to prevent infinite recursion with a recursive
ForwardRef.
r c 3 V K | ]! }t |t r t | n| # y wr )rt ru r r rv s rw r z _eval_type.. s* %C $.c3#7
3S@%s ')Nr c 3 > K | ] }t | yw)r N)
_eval_type)r aglobalnslocalnsr type_paramss rw r z _eval_type.. s2
8Wk?
s )rt r _evaluater} r r r r r __unpacked__r r~ rm r reduceoperatoror_ copy_with)r r r r r r is_unpackedev_argss ```` rw r r s0 !Z {{8Wk?{[[!m\5??CD a & :: D ..K.q$7LL$s)T"X!67LL&1I
ZZ
ajj H a & g6 6 a ) ##HLL': :;;w' ' Hry c e Zd ZdZdZd Zy)_Finalz Mixin to prohibit subclassing.) __weakref__c " d|vr t d y )N_rootz&Cannot subclass special typing classesr )r r r s rw __init_subclass__z_Final.__init_subclass__ s $ DE E ry N)r r r __doc__ __slots__r r ry rw r
r
s ( IFry r
c e Zd ZdZdZdZy) _NotIterablea Mixin to prevent iteration, without being compatible with Iterable.
That is, we could do::
def __iter__(self): raise TypeError()
But this would make users of this mixin duck type-compatible with
collections.abc.Iterable - isinstance(foo, Iterable) would be True.
Luckily, we can instead prevent iteration by setting __iter__ to None, which
is treated specially.
r N)r r r r r __iter__r ry rw r r s IHry r c \ e Zd ZdZd Zd Zd Zd Zd Zd Z d Z
d Z d
Z d Z
ed Zy
)r )_namer _getitemc V || _ |j | _ |j | _ y r )r r r r )selfgetitems rw __init__z_SpecialForm.__init__ s!
%%
ry c 8 |dv r | j S t | )N> r r )r AttributeError)r items rw __getattr__z_SpecialForm.__getattr__ s / /:: T""ry c t d| )NCannot subclass r r basess rw __mro_entries__z _SpecialForm.__mro_entries__ s *4(344ry c d| j z S Ntyping.r r s rw __repr__z_SpecialForm.__repr__ 4::%%ry c | j S r r( r) s rw
__reduce__z_SpecialForm.__reduce__ zzry c t d| )NzCannot instantiate r )r r r s rw __call__z_SpecialForm.__call__ s -dX677ry c t | |f S r r r others rw __or__z_SpecialForm.__or__ T5[!!ry c t || f S r r2 r3 s rw __ror__z_SpecialForm.__ror__ UD[!!ry c t | d )Nz! cannot be used with isinstance()r r r s rw __instancecheck__z _SpecialForm.__instancecheck__ 4& ABCCry c t | d )Nz! cannot be used with issubclass()r r r s rw __subclasscheck__z _SpecialForm.__subclasscheck__ r= ry c & | j | | S r )r r r s rw __getitem__z_SpecialForm.__getitem__ s }}T:..ry N)r r r r r r r$ r* r- r0 r5 r8 r< r@ r rC r ry rw r r sO 0I'
# 5&8""DD / /ry r )r
c e Zd Zd Zy)_LiteralSpecialFormc N t |t s|f} | j | g| S r )rt r r rB s rw rC z _LiteralSpecialForm.__getitem__ s) *e,$ J t}}T/J//ry N)r r r rC r ry rw rE rE s 0ry rE c ( e Zd Z fdZ fdZ xZS )_AnyMetac H | t u r t d t |
| S )Nz+typing.Any cannot be used with isinstance())r r superr< )r r __class__s rw r< z_AnyMeta.__instancecheck__ s& 3; IJ Jw(--ry c 2 | t u ryt | S )Nz
typing.Any)r rJ r* )r rK s rw r* z_AnyMeta.__repr__ s 3; w !!ry )r r r r< r*
__classcell__rK s @rw rH rH s .
" "ry rH c " e Zd ZdZ fdZ xZS )r aW 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
checks.
c H | t u r t d t |
| S )NzAny cannot be instantiated)r r rJ __new__r r kwargsrK s rw rQ z Any.__new__' s% #: 89 9ws##ry )r r r r rQ rM rN s @rw r r s $ $ry r ) metaclassc t | d )a Special type indicating functions that never return.
Example::
from typing import NoReturn
def stop() -> NoReturn:
raise Exception('no way')
NoReturn can also be used as a bottom type, a type that
has no values. Starting in Python 3.11, the Never type should
be used for this concept instead. Type checkers should treat the two
equivalently.
is not subscriptabler rB s rw ra ra - s tf 12
33ry c t | d )ad 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 typing 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
rV r rB s rw r] r] B s , tf 12
33ry c t | d )as Used to spell the type of "self" in classes.
Example::
from typing import Self
class Foo:
def return_self(self) -> Self:
...
return self
This is especially useful for:
- classmethods that are used as alternative constructors
- annotating an `__enter__` method which returns self
rV r rB s rw rh rh [ s " tf 12
33ry c t | d )a
Represents an arbitrary literal string.
Example::
from typing import LiteralString
def run_query(sql: LiteralString) -> None:
...
def caller(arbitrary_string: str, literal_string: LiteralString) -> None:
run_query("SELECT * FROM students") # OK
run_query(literal_string) # OK
run_query("SELECT * FROM " + literal_string) # OK
run_query(arbitrary_string) # type checker error
run_query( # type checker error
f"SELECT * FROM students WHERE name = {arbitrary_string}"
)
Only string literals and other LiteralStrings are compatible
with LiteralString. This provides a tool to help prevent
security issues such as SQL injection.
rV r rB s rw r\ r\ o s 0 tf 12
33ry c : t || d }t | |f S )a> 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.r r} r r r s rw r r ' & zdV+E#F GD w ''ry c : t || d }t | |f S )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] s rw r r r^ ry c |dk( r t d t |t s|f}dt fd|D }t | }t | dk( r|d S t | dk( rt d |v rt
| |d
S t
| | S ) a Union type; Union[X, Y] means either X or Y.
On Python 3.10 and higher, the | operator
can also be used to denote unions;
X | Y means the same thing to the type checker as Union[X, 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.::
assert Union[Union[int, str], float] == Union[int, str, float]
- Unions of a single argument vanish, e.g.::
assert Union[int] == int # The constructor actually returns int
- Redundant arguments are skipped, e.g.::
assert Union[int, str, int] == Union[int, str]
- When comparing unions, the argument order is ignored, e.g.::
assert 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].
r z Cannot take a Union of no types.z)Union[arg, ...]: each arg must be a type.c 3 6 K | ] }t | y wr r r r r s rw r zUnion.. s ?Jq{1c*J r r Nr name)r rt r r r rs r r r r s @rw r r s > R:;; j% ( ]
5C?J??J%j1J
:!!}
:!T
j 8!$
DD dJ //ry c t | |f S )zUsed from the C implementation of TypeVar.
TypeVar.__or__ calls this instead of returning types.UnionType
because we want to allow unions between TypeVars and strings
(forward references).
r2 )leftrights rw _make_unionrl s u ry c H t || d }t |t d f S )z,Optional[X] is equivalent to Union[X, None].z requires a single type.N)r r rs )r r rv s rw r r s+ jTF*B"C
DC d4j !!ry c
t | } t d t t t | D }t
| | S # t
$ r Y w xY w)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 3 & K | ] \ }}| y wr r )r r _s rw r zLiteral..
s ^)]A1)]s )r r r r _value_and_type_iterr r rB s rw r r sW 2 )4J
^ d;OPZ;[6\)]^^
j 11
s -A AAc t | d )a: Special form for marking type aliases.
Use TypeAlias to indicate 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.
rV r rB s rw rk rk s tf 12
33ry c |dk( r t d t |t s|f}|d du s t |d t s t d dg fd|dd D |d }t | | S ) ac Special form for annotating higher-order functions.
``Concatenate`` can be used in conjunction with ``ParamSpec`` and
``Callable`` to represent a higher-order function which adds, removes or
transforms the parameters of a callable.
For example::
Callable[Concatenate[int, P], int]
See PEP 612 for detailed information.
r z&Cannot take a Concatenate of no types.r .zMThe last parameter to Concatenate should be a ParamSpec variable or ellipsis.z/Concatenate[arg, ...]: each arg must be a type.c 3 6 K | ] }t | y wr rb rc s rw r z Concatenate..; s A AK3' rd N)r rt r r r rh s @rw r r % s R@AA j% ( ]
rNc !Z
2 %J : ; ;
;CRACR AR:b>RJ #D* 55ry c : t || d }t | |f S )a Special typing construct for marking user-defined type guard functions.
``TypeGuard`` can be 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_list(val: list[object]) -> TypeGuard[list[str]]:
'''Determines whether all objects in the list are strings'''
return all(isinstance(x, str) for x in val)
def func1(val: list[object]):
if is_str_list(val):
# Type of ``val`` is narrowed to ``list[str]``.
print(" ".join(val))
else:
# Type of ``val`` remains as ``list[object]``.
print("Not a list of strings!")
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] s rw rl rl ? s( b zdV+E#F GD w ''ry c H e Zd ZdZdZd
dddZddZd Zd Zd
Z d Z
d Z y)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__NF)rr c ( t |t st d| |j d rd| d}n|} t |dd }|| _ || _ d| _ d | _ || _
|| _ || _ y # t
$ r t d| w xY w) Nz*Forward reference must be a string -- got *(z,)[0]zevalz/Forward reference must be an expression -- got F)
rt ru r
startswithcompile SyntaxErrorrw rx ry rz r{ r| r} )r rv r rq rr arg_to_compilecodes rw r zForwardRef.__init__| s #s# H PQ Q
>># U^N N Y>:v>D # $ %*"!% '2$$,!"( Y OPSw WX X Ys
A9 9Bc l | j |v r| S | j r||ur||i x}}n ||}n||}| j 5t t j
j
| j d d| }|rQt | t | }}|D ]6 }|j }| j r||vs |||< |j |d 8 t t | j || d| j | j }t |||||| j hz | _ d| _ | j S )N__dict__z*Forward references must evaluate to types.)r ro r T)rw ry r} r sysmodulesgetr r r| popr r rx r{ r rz )r r r r r param
param_nametype_s rw r zForwardRef._evaluate sG ? 2K))WH-D GO%''7!" "&&2"KKOOD$;$;TBJPX $(NDM' (E!& J 44
(8R/4, J5 ) T**Hg>< 8 8$($=$= E &0!0D4H4H3I!I &D " *.D &%%%ry c . t |t st S | j r@|j r4| j |j k( xr | j
|j
k( S | j |j k( xr | j |j k( S r )rt r NotImplementedry rw rz r} r3 s rw __eq__zForwardRef.__eq__ s %,! ! % %%*E*E((E,A,AA F**e.E.EE
G$$(=(== D''5+C+CC Ery c D t | j | j f S r )hashrw r} r) s rw __hash__zForwardRef.__hash__ s T))4+B+BCDDry c t | |f S r r2 r3 s rw r5 zForwardRef.__or__ r6 ry c t || f S r r2 r3 s rw r8 zForwardRef.__ror__ r9 ry c b | j d}nd| j }d| j | dS )N z , module=z ForwardRef())r} rw )r module_reprs rw r* zForwardRef.__repr__ s@ " " * K %d&=&=%@AK T 1 1 4[MCCry TNr ) r r r r r r r r r r5 r8 r* r ry rw r r t s: 7'I
)u )0,&\EE""Dry r r returnc B t | t xr
t | dd S )N#__typing_is_unpacked_typevartuple__F)rt rs r r s rw _is_unpacked_typevartupler s( At$
$
E A?? Jry c |j }|j | }||dz d D ] }t |t st d| t | }t | }|}||z
dz
} d }
d } t
| D ]Q \ } }
t |
t rt |
dd }|s't | dk( s6|d du s>|
t d | }
|d } S |
t ||
}t | ||
z
dz
} n || z |kD rt d | d
| d |dz
g |d | | g||z
z t |||| z
| g|| z
|z
|z
dz
z ||| z
d S ) Nre z(More than one TypeVarTuple parameter in r r r .z6More than one unpacked arbitrary-length tuple argumentr Too few arguments for r z, expected at least ) r indexrt r
r r enumeraters r minr )r aliasr r typevartuple_indexr r plenrj rk var_tuple_indexfillargkrv r s rw _typevartuple_prepare_substr s
!
!F d+*Q./0 e\ * Fug NO O 1 t9D v;D D % % )EOGD/3#t$ c#CTJG3w<1,1C".#$\]]"#!!* " "4 )E4/1A56
0 8##'&(. s D1K#56 zFExpected a list of types, an ellipsis, ParamSpec, or Concatenate. Got )rt r r r r r rv s rw _paramspec_substr sU #e}%DDD J C
::=@ A A Jry c * |j }|j | }|t | k\ rt d| t | dk( rt |d s |dk( sJ |f}|S t || t r g |d | t || ||dz d }|S )Nr re r )r r r r r rt r r )r r r r is rw _paramspec_prepare_substr # s
!
!F TACI~0899
6{atAw 7Av
vw K
DGT "7bq75a>7D1J7 Kry c t |t s|f}t d |D }| t t fv }|r|st d| j
d t
d |D st d| j d t t | t | k7 rt d| j d | j D ] }t |dd }| || | } t | |t | j g }t | j | D ]8 \ }}t |t r|j | (|j! | : t | }t# | | S )
a Parameterizes a generic class.
At least, parameterizing a generic class is the *main* thing this method
does. For example, for some generic class `Foo`, this is called when we
do `Foo[int]` - there, with `cls=Foo` and `params=int`.
However, note that this method is also called when defining generic
classes in the first place with `class Foo(Generic[T]): ...`.
c 3 2 K | ] }t | y wr rx r r s rw r z)_generic_class_getitem..@ s 4V=#Vr zParameter list to z[...] cannot be emptyc 3 2 K | ] }t | y wr )r r s rw r z)_generic_class_getitem..I s 71#A&r zParameters to zF[...] must all be type variables or parameter specification variables.z[...] must all be unique__typing_prepare_subst__N)rt r r r r r allr r setr r r zipr
r r r} )r r is_generic_or_protocolr preparenew_argsnew_args rw _generic_class_getitemr 2 sk fe $
4V4
4F Wh$7 7 $S%5%5$66KL
777 /8 9:
: s6{ s6{ * .FGI
I ''E e%?FG" f- ( sFC(:(:$;< !#"4"4f =NE7% .(( >
x f %%ry c
t t |
|i | g }d| j v rt | j v }n7t | j
v xr# | j dk7 xr t | t k7 }|r t d d| j v rt | j }d }| j D ]? }t |t s|j t u s'| t d |j }A |at | }t |
|
k sDdj!
fd|D }dj! d |D } t d| d | d
|}t# | | _ y ) N__orig_bases__r z!Cannot inherit from plain Genericz0Cannot inherit from Generic[...] multiple times.r c 3 > K | ] }|vst | y wr ru )r r gvarsets rw r z)_generic_init_subclass.. s "M5aAW. s "95a3q65r zSome type variables (z ) are not listed in Generic[r )rJ r r r r __bases__r rs _TypedDictMetar r rt r} r~ r r r r ) r r rS tvarserrorgvarsbasetvarsets_varss_argsr s @rw _generic_init_subclassr c sl '3)4:6: E3<<'3---CMM) 0LLJ.0I /
;<<3<<'#C$6$67 &&D4 /OOw.$#JL L ++
' %jG%jGg% "M5"MM "95"99 "7x @::@!D E EE u Cry c J | j d xr | j d S )N__)r endswith)attrs rw
_is_dunderr s ??4 8T]]4%88ry c X e Zd ZdZddddZd Zd Zd Z fd Zd
Z d Z
fd Z xZ S )
_BaseGenericAliasa The central part of the 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.
TNinstrg c < || _ || _ || _ d | _ y r )_instr r~ r )r originr rg s rw r z_BaseGenericAlias.__init__ s
ry c | j s0t d| j d| j j d | j |i |} | |_ |S # t $ r Y |S w xY w)NzType z cannot be instantiated; use z
() instead)r r r r~ r __orig_class__ Exception)r r rS results rw r0 z_BaseGenericAlias.__call__ s zzeDJJ< 0##'??#;#;" r r r~ )r r~ r r r r r )r r s rw r z _BaseGenericAlias.__getattr__ sU / /::9 !9!9 9 4== (D1A4??D1 1 T""ry c t t | s|dv rt | || y t | j || y )N> r r _nparams)r rJ __setattr__setattrr~ )r r valrK s rw r z _BaseGenericAlias.__setattr__ s2 d t'E E G c * DOOT3 /ry c 6 | j t | S r )r@ rs r; s rw r< z#_BaseGenericAlias.__instancecheck__ s %%d3i00ry c t d )NzBSubscripted generics cannot be used with class and instance checksr r? s rw r@ z#_BaseGenericAlias.__subclasscheck__ s 5 6 6ry c t t t |
t | j
D cg c] }t
| r| c}z S c c}w r )r r rJ __dir__dirr~ r r r rK s rw r z_BaseGenericAlias.__dir__ sP C)$'$8Q$8D
4@P4$8QR S T TQs AA)
r r r r r r0 r$ r r r< r@ r rM rN s @rw r r s> (,$
#0 16T Try r c | e Zd Zddd fd
Zd Zd Zd Zd Zed Z d
Z
d Z d Z d
Z
d Z fdZd Z xZS )r} TNr c t | ||| t |t s|f}t d |D | _ t | | _ |s|j | _ y y )Nr c 3 4 K | ] }|t u rd n| yw).N)_TypingEllipsisr s rw r z)_GenericAlias.__init__.. s' /)-A &'/%9c )-r )rJ r rt r r r r r )r r r r rg rK s rw r z_GenericAlias.__init__ sc
d6$&7D /)- / /
1$ 7 $ / /DO ry c t |t st S | j |j k( xr | j |j k( S r )rt r} r r~ r r3 s rw r z_GenericAlias.__eq__ s> % /! !5#3#33 4MMU^^3 5ry c D t | j | j f S r )r r~ r r) s rw r z_GenericAlias.__hash__ s T__dmm455ry c t | |f S r r2 r rk s rw r5 z_GenericAlias.__or__ r6 ry c t || f S r r2 r rj s rw r8 z_GenericAlias.__ror__ T4Z ry c * | j t t fv rt d| | j st | d t |t s|f}t
d |D }t | }| j | }| j | }|S )Nz%Cannot subscript already-subscripted r c 3 2 K | ] }t | y wr r r s rw r z,_GenericAlias.__getitem__..( s 4t!]1%tr )
r~ r r r r rt r r _determine_new_argsr )r r r rs rw rC z_GenericAlias.__getitem__ s " ??w 1 1 CD6 JK K""tf$; <= = $&7D4t44D!++D1 NN8 $ry c
@ | j }|D ] }t |dd }| || | } t | }t | }||k7 r t d||kD rdnd d| d| d| t t || }t
| j | j | S )Nr r r r r r r ) r r r r r r r _make_substitutionr )r r r r r r r new_arg_by_params rw r z!_GenericAlias._determine_new_args. s $$E e%?FG" tT* 4y6{ 4<dTD[6e"DOTXSY Z''+fKv ? @
@ FD 12T,,T]] #G-=r B %G G &%a 6 #NN+;A+> ? #NN+;A+> ? '
&eGn 5G+//":"::z'SX?Y (*73 (GU+ $11';KLM (q r ry c h | j | j || j | j S N)rg r )rK r~ r r r r s rw r z_GenericAlias.copy_with s% ~~doot$**4::~VVry c | j rd| j z }nt | j }| j r3dj | j D cg c]
}t | c} }nd}| d| dS c c}w )Nr' r z()r r )r r r~ r r )r rg r r s rw r* z_GenericAlias.__repr__ sq :: tzz)D doo.D ==99T]] C]jm] CDD Dqa Ds A;c | j rt | j }n | j }t | j }t | dk( rt
|d t s|\ }t j ||ffS Nre r ) r globalsr~ r r r rt r r )r r r s rw r- z_GenericAlias.__reduce__ sd :: Ytzz*F__FT]]# t9>*T!We"<ED &$ //ry c D t | j t rt d| | j rt
| | S | j t u r>t |v ry|j | }||dz d D ] }t |t s|| us y | j fS )Nr! r re ) rt r~ r r r rJ r$ r r r r )r r# r r rK s rw r$ z _GenericAlias.__mro_entries__ s doo| 4 .th 78 8 ::7*51 1 ??g %5 D!A1Q34[ a!23
! !!ry c # " K t | y wr )rm r) s rw r z_GenericAlias.__iter__ s Tls
)r r r r r r r5 r8 r rC r r r r* r- r$ r rM rN s @rw r} r} s] 2 .2 05 6"! >O:<|W
!0
" ry r} c ^ e Zd Zddd fd
Zed Zd Zd Z fdZd Z d
Z
d Z xZ S ) _SpecialGenericAliasTNr c | |j }t | ||| || _ |j dk( rd|j
d| _ y d|j d|j
d| _ y )Nr r zA generic version of r| )r rJ r r r r r )r r nparamsr rg rK s rw r z _SpecialGenericAlias.__init__ sv <??D
d6
* 263F3F2GqIDL 263D3D2EQvGZGZF[[\]DLry c t |t s|f}dt fd|D }t | || j | j | S )Nr c 3 6 K | ] }t | y wr rb rc s rw r z3_SpecialGenericAlias.__getitem__.. ;Fq{1c*Frd )rt r r r r r r r s @rw rC z _SpecialGenericAlias.__getitem__ sH &%( YF:;F;;tVT]]3~~f%%ry c \ t | j || j | j S r )r} r~ r r r r s rw r z _SpecialGenericAlias.copy_with s$ T__f"&**4::? ?ry c d| j z S r& r( r) s rw r* z _SpecialGenericAlias.__repr__ r+ ry c t |t r t |j | j S t |t st || j S t
| | S r )rt r r r~ r} rJ r@ )r r rK s rw r@ z&_SpecialGenericAlias.__subclasscheck__ sN c/ 0 cnndoo> >#}- c4??3 3w(--ry c | j S r r( r) s rw r- z _SpecialGenericAlias.__reduce__ r. ry c t | |f S r r2 r s rw r5 z_SpecialGenericAlias.__or__ r6 ry c t || f S r r2 r s rw r8 z _SpecialGenericAlias.__ror__ r ry )
r r r r r rC r r* r@ r- r5 r8 rM rN s @rw r r s@ 044 ^ & &?&."!ry r c 0 e Zd Zddd fd
Z fdZ xZS )_DeprecatedGenericAliasTNr c : t | |||| || _ y )Nr )rJ r _removal_version)r r r! removal_versionr rg rK s rw r z _DeprecatedGenericAlias.__init__ s# t$? / ry c dd l } |j | j d| j | j t
| | S )Nr r| )r )warnings _deprecatedr r r0 rJ r< )r r r3 rK s rw r< z)_DeprecatedGenericAlias.__instancecheck__ sG q -d6K6K
w(..ry )r r r r r< rM rN s @rw r. r. s 8<40 / /ry r. c $ e Zd Z fdZd Z xZS )_CallableGenericAliasc | j dk( sJ | j }t | dk( r t |d rt | S ddj
|d d D cg c]
}t | c} dt |d dS c c}w ) Nr r r ztyping.Callable[[r r z], r )r r r r rJ r* r r )r r r rK s rw r* z _CallableGenericAlias.__repr__ s zzZ'''}} t9>nT!W 57#% %YYtCRy Ay!
1
y ABC3 d2h'(+ , As B
c | j }t | dk( rt |d st |d d |d f}t j
t |ffS )Nr r r )r r r r r r r r s rw r- z _CallableGenericAlias.__reduce__ sO }}D Q>$q'#:Sb ?DH,D (D!111ry )r r r r* r- rM rN s @rw r6 r6 s
,2ry r6 c ( e Zd Zd Zd Zed Zy)
_CallableTypec \ t | j || j | j S r )r6 r~ r r r' s rw r z_CallableType.copy_with s& $T__f*.**4::G Gry c t |t rt | dk7 r t d |\ }}t |t rt | |f}n||f}| j | S )Nr z6Callable must be used as Callable[[arg, ...], result].)rt r r r r __getitem_inner__)r r r r s rw rC z_CallableType.__getitem__
sf &%(CK1,< < =
= f dD !Dk6*FF^F%%f--ry c |\ }}d}t || }|t u r| j t |f S t |t
s|f}t d |D }||fz }| j | S )Nz.Callable[args, result]: result must be a type.c 3 2 K | ] }t | y wr r r s rw r z2_CallableType.__getitem_inner__..! s 84C]3'4r )r Ellipsisr r rt r )r r r r r s rw r= z _CallableType.__getitem_inner__ st f> VS) 8 >>?F";< <$&7D8488 !~~f%%ry N)r r r r rC r r= r ry rw r: r: s! G .
&
&ry r: c e Zd Zed Zy)
_TupleTypec t |t s|f}t | dk\ r:|d du r3dt fd|d d D }| j g |t S dt fd|D }| j | S )Nr r .z Tuple[t, ...]: t must be a type.c 3 6 K | ] }t | y wr rb rc s rw r z)_TupleType.__getitem__..- s D 1;q#. rd z*Tuple[t0, t1, ...]: each t must be a type.c 3 6 K | ] }t | y wr rb rc s rw r z)_TupleType.__getitem__..0 r$ rd )rt r r r r r% s @rw rC z_TupleType.__getitem__' s &%( YF v;! r
c 14CDs DDF>>"A?c > t t | j S r )r frozensetr r) s rw r z_UnionGenericAlias.__hash__@ s Idmm,--ry c | j }t | dk( rD|d t d u rdt |d dS |d t d u rdt |d dS t | S )Nr r ztyping.Optional[re r )r r rs r rJ r* r r rK s rw r* z_UnionGenericAlias.__repr__C sw }} t9>Aw$t*$)*T!W*=)>a@@aDJ&)*T!W*=)>a@@w !!ry c B | j D ] }t || s y yNTF)r rt )r r rv s rw r< z$_UnionGenericAlias.__instancecheck__L " ==C#s# ! ry c B | j D ] }t || s y yrN )r r )r r rv s rw r@ z$_UnionGenericAlias.__subclasscheck__R rO ry c @ t | \ }\ }}|t |ffS r )rJ r- r )r r r r rK s rw r- z _UnionGenericAlias.__reduce__X s( $w 1 3 nvteT]""ry ) r r r r r r r* r< r@ r- rM rN s @rw r r 4 s, J." # #ry r c d | D S )Nc 3 6 K | ] }|t | f y wr )rs r s rw r z'_value_and_type_iter..^ s -*QQQL*s r )r s rw rq rq ] s
-* --ry c e Zd Zd Zd Zy)r c t |t st S t t | j
t t |j
k( S r )rt r r r rq r r3 s rw r z_LiteralGenericAlias.__eq__b s? %!56! !'
673?STYTbTb?c;dddry c P t t t | j S r )r rJ rq r r) s rw r z _LiteralGenericAlias.__hash__h s I 24== ABCCry N)r r r r r r ry rw r r a s e Dry r c e Zd Z fdZ xZS )r c t |d t t f r
g |d d |d S t |d t rg |d d |d j }t
| | S )Nr )rt r r r r rJ r )r r rK s rw r z"_ConcatenateGenericAlias.copy_withm sm fRj4- 0.VCR[.6":. . fRj": ;9vcr{9VBZ%8%89Fw ((ry )r r r r rM rN s @rw r r l s
) )ry r c < t || d }t | |f S )a Type unpack operator.
The type unpack operator takes the child types from some container type,
such as `tuple[int, str]` or a `TypeVarTuple`, and 'pulls them out'.
For example::
# For some generic class `Foo`:
Foo[Unpack[tuple[int, str]]] # Equivalent to Foo[int, str]
Ts = TypeVarTuple('Ts')
# Specifies that `Bar` is generic in an arbitrary number of types.
# (Think of `Ts` as a tuple of an arbitrary number of individual
# `TypeVar`s, which the `Unpack` is 'pulling out' directly into the
# `Generic[]`.)
class Bar(Generic[Unpack[Ts]]): ...
Bar[int] # Valid
Bar[int, str] # Also valid
From Python 3.11, this can also be done using the `*` operator::
Foo[*tuple[int, str]]
class Bar(Generic[*Ts]): ...
And from Python 3.12, it can be done using built-in syntax for generics::
Foo[*tuple[int, str]]
class Bar[*Ts]: ...
The operator can also be used along with a `TypedDict` to annotate
`**kwargs` in a function signature::
class Movie(TypedDict):
name: str
year: int
# This function expects two keyword arguments - *name* of type `str` and
# *year* of type `int`.
def foo(**kwargs: Unpack[Movie]): ...
Note that there is only some runtime checking of this operator. Not
everything the runtime allows may be accepted by static type checkers.
For more information, see PEPs 646 and 692.
r[ )r r )r _UnpackGenericAliasr] s rw rm rm u s( ^ zdV+E#F GD d$ 99ry c D e Zd Zd Z fdZed Zed Z xZS )rZ c : dt | j d dS )Nztyping.Unpack[r r )r r r) s rw r* z _UnpackGenericAlias.__repr__ s"
4==+; < =Q??ry c > | j r|S t | | S r )r rJ rC rL s rw rC z _UnpackGenericAlias.__getitem__ s! 3 3Kw"4((ry c | j t u sJ t | j dk( sJ | j \ }t |t
t j f r)|j t ur t d |j S y )Nre z*Unpack[...] must be used with a tuple type)
r~ rm r r rt r} r r r r r s rw r z2_UnpackGenericAlias.__typing_unpacked_tuple_args__ sp &(((4==!Q&&&}} cM5+=+=> ?~~U* LMM<< ry c | j t u sJ t | j dk( sJ t | j d t
S r )r~ rm r r rt r
r) s rw r z7_UnpackGenericAlias.__typing_is_unpacked_typevartuple__ sA &(((4==!Q&&&$--*L99ry ) r r r r* rC propertyr r rM rN s @rw rZ rZ s6 @
)
: :ry rZ c e Zd ZdZy)r z(Internal placeholder for ... (ellipsis).N)r r r r r ry rw r r s 2ry r > _is_protocolr r r __type_params____protocol_attrs___is_runtime_protocol __non_callable_proto_members__> r rQ r r r r r __annotations____subclasshook____class_getitem____abstractmethods___MutableMapping__markerc t }| j dd D ]` }|j dv rt |di }g |j |D ]. }|j d r|t vs |j | 0 b |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 rg _abc_)r __mro__r r r r EXCLUDED_ATTRIBUTESadd)r attrsr annotationsr s rw _get_protocol_attrsrs s}
EE CR == 3 3 d$5r: 2dmm2k2D??7+ Nr r )r~ )r| s rw _allow_reckless_class_checksr s 5> 7 77ry ) r r0 r% r& r2 r1 r# r. r! r4 r7 BufferAbstractContextManagerAbstractAsyncContextManager)zcollections.abc
contextlibc ddl m} | S )Nr getattr_static)inspectr r s rw _lazy_load_getattr_staticr % s
' ry c ( t | j ffS r )r r~ )psargss rw _pickle_psargsr / s 6,,. ..ry c ( t | j ffS r )r r~ )pskwargss rw _pickle_pskwargsr 4 s X 0 0 2 22ry c < e Zd Z fdZ fdZ fdZ fdZ xZS )
_ProtocolMetac 6 |dk( r |t fk( rnvt |v rn|D ]i }|t t hv r|j t j |j g v r?t |t rt |dd r]t d| t | , | |||fi |S )Nr rb Fz5Protocols can only inherit from other protocols, got ) r r rv r _PROTO_ALLOWLISTr r r r r rJ rQ )mclsrg r# namespacerS r rK s rw rQ z_ProtocolMeta.__new__? s : %G:"5
VW --}}(8(<( 3 22LL$$%78KG R w(//ry c n | t u rt j | | S t | dd st | | S t | dd st s t
d t | | ryt }| j D ] } ||| }||| j vs y y# t $ r Y yw xY w)Nrb Fre r T) r rs r< r rJ r r r rd r rf )r instancer r r rK s rw r< z _ProtocolMeta.__instancecheck__p s (?))#x8 8sNE27,X6 6 3U;,. < =
= 7 $X .24**D
$Xt4 {t3+M+M M +
"
s B'' B43B4)r r r rQ r r@ r< rM rN s @rw r r < s G&>
02 ry r c | j j dd st S | j D ] }|j D ] }||j v r|j |
t c c S ;t |di }t
|t j j s^||v sct |t stt |dd s t c S y)Nrb Frg T) r r r rd rn r rt r r r( r r )r r4 r r rr s rw r r s << NE 2 &&MMDt}}$==&.)) "$(92>K; (?(?@K' ug.75.RW3X " " ! ' ry c . e Zd ZdZdZdZdZ fdZ xZS )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.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[T](Protocol):
def meth(self) -> T:
...
r TFc : t | |i | | j j dd s!t d | j
D | _ d| j vr t | _ | j r)| j t j u r t | _ y y y )Nrb Fc 3 , K | ] }|t u y wr r r r s rw r z-Protocol.__init_subclass__.. s "H-Q1=-s rh ) rJ r r r anyr rb r rh r r ru rR s rw r zProtocol.__init_subclass__ s
!4262 || 6 ""H#--"H HC S\\ 1#.C 0A0A A3CL !B ry ) r r r r r rb re r rM rN s @rw r r s% @ IL
4
4ry r c P e Zd ZdZ fdZd Zd Zd Zd Zd Z fdZ
d Z xZ S )
_AnnotatedAliasa 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.
The metadata itself is stored in a '__metadata__' attribute as a tuple.
c t |t r|j |z }|j }t | ||d || _ y )Nr rf )rt r __metadata__r~ rJ r )r r metadatarK s rw r z_AnnotatedAlias.__init__ sD fo . **X5H&&F
k: $ry c X t | dk( sJ |d }t || j S r )r r r )r r new_types rw r z_AnnotatedAlias.copy_with s0 6{a !9 x):):;;ry c dj t | j dj d | j D S )Nztyping.Annotated[{}, {}]r c 3 2 K | ] }t | y wr )r r s rw r z+_AnnotatedAlias.__repr__.. s 9'8!d1g'8r )formatr r~ r r r) s rw r* z_AnnotatedAlias.__repr__ s9 )00 t ' II9t'8'89 9
ry c b t j t | j f| j z ffS r )r r r r~ r r) s rw r- z_AnnotatedAlias.__reduce__ s1 )D,=,=="
ry c t |t st S | j |j k( xr | j |j k( S r )rt r r r~ r r3 s rw r z_AnnotatedAlias.__eq__ sB % 1! !5#3#33 <%%););; =ry c D t | j | j f S r )r r~ r r) s rw r z_AnnotatedAlias.__hash__ s T__d&7&7899ry c , |dv ryt | | S )N> r r r )rJ r r s rw r z_AnnotatedAlias.__getattr__
s / / w"4((ry c | j fS r )r~ r" s rw r$ z _AnnotatedAlias.__mro_entries__ s !!ry )
r r r r r r r* r- r r r r$ rM rN s @rw r r s0 %<
= :)
"ry r c D e Zd ZdZdZd Zd Z ed d Zd Z y )
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.
- Access the metadata via the ``__metadata__`` attribute::
assert Annotated[int, '$'].__metadata__ == ('$',)
- Nested Annotated types are flattened::
assert Annotated[Annotated[T, Ann1, Ann2], Ann3] == Annotated[T, Ann1, Ann2, Ann3]
- Instantiating an annotated type is equivalent to instantiating the
underlying type::
assert Annotated[C, Ann1](5) == C(5)
- Annotated can be used as a generic type alias::
type Optimized[T] = Annotated[T, runtime.Optimize()]
# type checker will treat Optimized[int]
# as equivalent to Annotated[int, runtime.Optimize()]
type OptimizedList[T] = Annotated[list[T], runtime.Optimize()]
# type checker will treat OptimizedList[int]
# as equivalent to Annotated[list[int], runtime.Optimize()]
- Annotated cannot be used with an unpacked TypeVarTuple::
type Variadic[*Ts] = Annotated[*Ts, Ann1] # NOT valid
This would be equivalent to::
Annotated[T1, T2, T3, ..., Ann1]
where T1, T2 etc. are TypeVars, which would be invalid, because
only one type should be passed to Annotated.
r c t d )Nz&Type Annotated cannot be instantiated.r r r rS s rw rQ zAnnotated.__new__E s @AAry c N t |t s|f} | j | g| S r )rt r _class_getitem_inner)r r s rw ri zAnnotated.__class_getitem__H s+ &%( YF's''5f55ry Tr c t | dk r t d t |d r t d d}t |d |d }t |dd }t || S ) Nr zUAnnotated[...] should be used with at least two arguments (a type and an annotation).r z?Annotated[...] should not be used with an unpacked TypeVarTuplez$Annotated[t, ...]: t must be a type.Trn re )r r r r r r )r r r r r s rw r z Annotated._class_getitem_innerM ss v;? + ,
, %VAY / 4 5
54 VAYF$ vx00ry c J t dj | j )Nz Cannot subclass {}.Annotated)r r r r s rw r zAnnotated.__init_subclass__[ s! * 1 1#.. A
ry N)
r r r r r rQ ri r r r r ry rw r r s8 -^ IB6
T 1 1
ry r c V t | t r
t | dd st d| z d| _ t | _ | j D ]7 } t t | |d }|r | j j | 9 | S # t $ r}t d|d |d}~ww xY w)a: 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!
rb FzB@runtime_checkable can be only applied to protocol classes, got %rTNz,Failed to determine whether protocol member z is a method member) r r r r re r rf rd callablerp r )r r is_callablees rw rg rg a s & c7 #73+N "$'( ) ) #C
*-C&&& ="73d#;th G% %
s B
B(B##B(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).
r )r r s rw rS rS s Jry c | S )a Ask a static type checker to confirm that the value is of the given type.
At runtime this does nothing: it returns the first argument unchanged with no
checks or side effects, no matter the actual type of the argument.
When a static 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
r )r r s rw rQ rQ s Jry c t | dd ri S t | t r?i }t | j D ] }|6t t
j j |j d di }n|}|j j di }t |t j ri }|t t | n|}||||}}|j D ]M \ } }
|
t d }
t |
t rt! |
dd }
t# |
|||j$ }
|
|| < O |r|S |j D ci c] \ } } | t' | c} } S |`t | t j( r
| j }n4| }
t+ |
d r|
j, }
t+ |
d rt |
d i }||}n||}t | dd }|,t | t. ri S t1 d
j3 | t | }t | d d }|j D ]Z \ } }
|
t d }
t |
t r't! |
t | t j( d }
t# |
||| || < \ |r|S |j D ci c] \ } } | t' | c} } S c c} } w c c} } w )
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 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 rg FT)r rr __wrapped__ __globals__z1{!r} is not a module, class, method, or function.rc r )r rt rs reversedrn r r r r r r GetSetDescriptorTyper varsitemsru r r rc _strip_annotations
ModuleTyper r _allowed_typesr r )r r r include_extrashintsr base_globalsann base_localsrg valuer r nsobjr s rw rZ rZ s > s'. #t S[[)D &s{{t'Mz[] ^ ' --##$5r:C#u 9 9:.5o$tDz*7K8#3 -8 k "yy{ e= JE eS) &u%$ OE"5, TEYEYZ #d
+# *0 'u`RWR]R]R_,`R_$!QQ0B10E-ER_,`` c5++ ,||HE% / )) % / umR8H ? G C*D 1E } c> *I ++16#;8
8 KE# 0"5K {{} e =JE eS ! *30@0@ A A E
!';Gd % #5\ekkm(\mda,>q,A)Am(\\K -aJ )]s J7 J=c t | t rt | j S t | d r0| j t
t fv rt | j d S t | t r>t d | j D }|| j k( r| S | j | S t | t rCt d | j D }|| j k( r| S t | j | S t | t j rQt d | j D }|| j k( r| S t j t j" | S | S )z(Strip the annotations from a given type.r~ r c 3 2 K | ] }t | y wr r r s rw r z%_strip_annotations.. HZ 0 3Zr c 3 2 K | ] }t | y wr r r s rw r z%_strip_annotations.. r r c 3 2 K | ] }t | y wr r r s rw r z%_strip_annotations.. r r )rt r r r~ r re rb r r} r r r r r r r r r )r
stripped_argss rw r r s !_%!!,,//q, ALLX{4K$K!!**Q-00!]# HQZZ HH
AJJ &H{{=))!\" HQZZ HH
AJJ &HALL-88!U__% HQZZ HH
AJJ &H m<< Hry c t | t rt S t | t t t
t f r | j S | t u rt S t | t j rt j S y)a Get the unsubscripted version of a type.
This supports generic types, Callable, Tuple, Union, Literal, Final, ClassVar,
Annotated, and others. Return None for unsupported types.
Examples::
>>> P = ParamSpec('P')
>>> assert get_origin(Literal[42]) is Literal
>>> assert get_origin(int) is None
>>> assert get_origin(ClassVar[int]) is ClassVar
>>> assert get_origin(Generic) is Generic
>>> assert get_origin(Generic[T]) is Generic
>>> assert get_origin(Union[T, int]) is Union
>>> assert get_origin(List[Tuple[T, T]][int]) is list
>>> assert get_origin(P.args) is P
N) rt r r r r r r r~ r r r tps rw rX rX ( s^ $ "o&"(,$o7 8}} W}"eoo& ry c * t | t r| j f| j z S t | t t
f r-| j }t | | rt |dd |d f}|S t | t j r | j S y)a Get type arguments with all substitutions performed.
For unions, basic simplifications used by Union constructor are performed.
Examples::
>>> T = TypeVar('T')
>>> assert get_args(Dict[str, int]) == (str, int)
>>> assert get_args(int) == ()
>>> assert get_args(Union[int, Union[T, int], str][int]) == (int, str)
>>> assert get_args(Union[int, Tuple[T, int]][str]) == (int, Tuple[str, int])
>>> assert get_args(Callable[[], T][int]) == ([], int)
Nr r ) rt r r~ r r} r r r r r r )r r s rw rW rW F s~ "o&
"//11"}l34kk *2s 3CR>3r7+C
"eoo&{{
ry c " t | t S )a+ Check if an annotation is a TypedDict class.
For example::
>>> from typing import TypedDict
>>> class Film(TypedDict):
... title: str
... year: int
...
>>> is_typeddict(Film)
True
>>> is_typeddict(dict)
False
)rt r r s rw r[ r[ ` s b. ))ry d rv c p t | }t | t kD r |dt dz }t d| )a Statically assert 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.
Nr z*Expected code to be unreachable, but got: )r r _ASSERT_NEVER_REPR_MAX_LENGTHAssertionError)rv r s rw rR rR u s@ &
IE
5z11445=
EeWM
NNry c t | t rt | D ] }t | | }t |d rB|j
| j
d|j k7 st |dd | j k7 r^t |t j rd|_
t |t j rd|j _
t |t st | d| _
| S # t $ r Y | S w xY 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.
r r| r NT)rt rs r r r r r r r r r
MethodType__func__r_ r )rv keyr s rw r_ r_ s #t s8C#s#CC 0###*:*:);1S\\N'KK3 d3s~~E
#u 1 12(,%#u / /015 .#t$ c"% &
$ J
J
s %C. . C;:C;c B t j fd }|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 . | i |}t | }|S r )r_ )r r r r s rw wrapped_decoratorz2no_type_check_decorator..wrapped_decorator s! $'$' T" ry )r r )r r s ` rw r` r` s( __Y
ry c t d )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.)NotImplementedError)r r s rw _overload_dummyr s
9 : :ry c t | d| } | t |j |j |j j
< t S # t $ r Y t S w xY w)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::
@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.
r )r _overload_registryr r __code__co_firstlinenor r )r fs rw rc rc sa @ j$'A
VZ1<<( 89R9RS
s 7A A A c t | d| }|j t vrg S t |j }|j |vrg S t ||j j S )z6Return all defined overloads for *func* as a sequence.r )r r r r r values)r r mod_dicts rw rY rY s` j$'A||-- !!,,/H~~X% (//1 22ry c , t j y)z$Clear all overloads in the registry.N)r clearr ry rw rT rT
s ry c B d| _ | S # t t f$ r Y | S w xY w)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. The decorator
attempts to set the ``__final__`` attribute to ``True`` on the decorated
object to allow runtime introspection.
T) __final__r r )r s rw rV rV
s5 4
H
I &
H
TKTVTT_co) covariantV_coVT_coT_contra)
contravariantCT_co)r boundrP a Deprecated alias to collections.abc.Callable.
Callable[[int], str] signifies a function that takes a single
parameter of type int and returns a 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, a ParamSpec,
Concatenate 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 rf )r )r1 r r r a] Deprecated alias to builtins.tuple.
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, ...].
rD rA rF rG r" r6 rB rC r a Deprecated alias to builtins.type.
builtins.type or typing.Type can be used 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::
def new_user[U](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 ZdZdZedefd Zy)r= z(An ABC with one abstract method __int__.r r c y r r r) s rw __int__zSupportsInt.__int__
ry N)r r r r r r intr r ry rw r= r=
s# 2I
ry r= c * e Zd ZdZdZedefd Zy)r; z*An ABC with one abstract method __float__.r r c y r r r) s rw __float__zSupportsFloat.__float__
r ry N)r r r r r r floatr r ry rw r; r;
# 4I
5
ry r; c * e Zd ZdZdZedefd Zy)r: z,An ABC with one abstract method __complex__.r r c y r r r) s rw __complex__zSupportsComplex.__complex__
r ry N)r r r r r r complexr r ry rw r: r:
s# 6I
W
ry r: c * e Zd ZdZdZedefd Zy)r9 z*An ABC with one abstract method __bytes__.r r c y r r r) s rw __bytes__zSupportsBytes.__bytes__
r ry N)r r r r r r bytesr r ry rw r9 r9
r ry r9 c * e Zd ZdZdZedefd Zy)r< z*An ABC with one abstract method __index__.r r c y r r r) s rw __index__zSupportsIndex.__index__
r ry N)r r r r r r r r r ry rw r< r<
s# 4I
3
ry r< c > d xf G fdd
} t | S )r c 4 e Zd ZW ZdZdZedW fd Zy)r8 zMAn ABC with one abstract method __abs__ that is covariant in its return type.r r c y r r r) s rw __abs__zSupportsAbs.__abs__
r ry N)r r r rc r r r r .type_paramsr s rw r8 r8
s$ WI
ry r8 r
.generic_baser r s @@rw #r"
s
X
ry c > d xf G fdd
} t | S )r c : e Zd ZW ZdZdZeddedW fd Zy)r> zOAn ABC with one abstract method __round__ that is covariant in its return type.r ndigitsr c y r r )r r% s rw __round__zSupportsRound.__round__
r ry Nr ) r r r rc r r r r r' r s rw r> r>
s+ YI
Q
ry r> r r s @@rw %r)
s
x
ry r c |D cg c] \ }}| }}}|D ci c] \ }}|t |d| d }}}t j | ||| }|x|_ |j _ |S c c}}w c c}}w )Nzfield z annotation must be a typedefaultsrq )r r
namedtuplerg rQ )rg r rq r, nr fieldsnm_tpls rw
_make_nmtupler1
s !
"EDAqaEF
"
A As*D EF
F
#
#D&-5fFF>CCFV^^ ; M
#
s
A+A1>
_makerQ _asdict_fields_sourcer _replacer __getnewargs___field_defaults> r r rg c e Zd Zd Zy)NamedTupleMetac t |v sJ |D ] }|t us |t ust d t d |D }|j di }g }|D ]M }||v r|j | |s t d| dt
| dkD rdnd d d
j | t | |j |D cg c] }|| c}|d } || _
t |v rt }
t |
| _
|D ]@ } | t v rt d
| z | t vs"| | j" vs1t% | | || B t |v r| j' | S c c}w )Nz3can only inherit from a NamedTuple type and Genericc 3 < K | ] }|t u rt n| y wr ) _NamedTupler )r r s rw r z)NamedTupleMeta.__new__.. s Ot{ 2e< rg z Non-default namedtuple field z cannot follow default fieldre sr r r r+ z&Cannot overwrite NamedTuple attribute )r= r r r r r r r r1 r r r classmethodri _prohibitedr _specialr4 r r ) r typenamer# nsr r
default_names
field_namer. r0
class_getitemr s rw rQ zNamedTupleMeta.__new__
s e###D;&4w+> IK K OOO("-
JR $$Z0 "?
| L>*-m* ? ? x 8E(F
1A
(F&( &68 ! e 2M'2='AF $Ck!$%MPS%STTH$FNN)BRW-
e $ $ &
)Gs E N)r r r rQ r ry rw r: r:
s ry r: c ||j }n
|r t d t | |t }t f|_ |S )a? Typed version of namedtuple.
Usage::
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.)
An alternative equivalent functional syntax is also accepted::
Employee = NamedTuple('Employee', [('name', str), ('id', int)])
zIEither list of fields or keywords can be provided to NamedTuple, not bothrq )r r r1 r~ rH r )rD r/ rS nts rw rH rH ! sK ( ~ C D D x :B#
B
Iry rH c $ t | v sJ t fS r )rH r= r# s rw _namedtuple_mro_entriesrN @ s >ry c " e Zd ZddZeZd ZeZy)r c
|D ]' }t | t us|t us t d t d |D rt f}nd}t j t |g |t | }t |d s||_ i }|j di } d}
| j D ci c] \ } } | t | |
|j } } } t }
t }|D ] }|j |j j di |j j dt }|
|z }
||z }|j j d t }|
|z }
||z } |j | | j D ] \ }}t! | }|t" u r t% | }|r|d
}t! | }|t& u rd }n
|t( u rd }n|}|r#|
j+ | |j- | s|j+ | |
j- | |
j/ | sJ d
| d|
d| ||_ t3 |
|_ t3 | |_ t |d s||_ |S c c} } w )a7 Create a 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 classc 3 < K | ] }t |t y wr )r r r s rw r z)_TypedDictMeta.__new__..U s 5u!z!W%ur> r r rg z?TypedDict('Name', {f0: t0, f1: t1, ...}); each t must be a typerJ __required_keys____optional_keys__r TFz,Required keys overlap with optional keys in z: required_keys=z, optional_keys= __total__) rs r r r r rQ r r r r r r r r updater rX r rW re rb rp discard
isdisjointrg rJ rR rS rT )r rg r# rE totalr generic_basetp_dictrr own_annotationsr r. r
required_keys
optional_keys
base_required
base_optionalannotation_keyannotation_typeannotation_originannotation_args is_requireds rw rQ z_TypedDictMeta.__new__H s DDz /D4G !A B B
5u5 5 #:L L,,~t5J|5JT5JBOw 01%*G " &&!2B7O )..0
02
{2s7+=+=> >0
D t}} 0 01BB G H MM - -.A35 IM ] *M ] *M MM - -.A35 IM ] *M ] *M ?+/>/D/D/F +NO *? ; I-"*?";"&5a&8O(2?(C% H, " "k1 # # !!.1 %%n5 !!.1 %%n5) 0G, ''
6
:4& A 0-!1
3
6 #. $-m$<!$-m$<!w , %G e
s *#Jc t d )Nz4TypedDict does not support instance and class checksr )r r4 s rw r@ z _TypedDictMeta.__subclasscheck__ s NOOry N)T)r r r rQ r r0 r@ r< r ry rw r r G s L\ HP *ry r rX c ||}n
|r t d |r t j dt d dt | i}t }|||d< t
| d|| }t f|_ |S ) a* A simple typed namespace. At runtime it is equivalent to a plain dict.
TypedDict creates a dictionary type such that a type checker will expect all
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.
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
>>> Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
True
The type info can be accessed via the Point2D.__annotations__ dict, and
the Point2D.__required_keys__ and Point2D.__optional_keys__ frozensets.
TypedDict supports an additional equivalent form::
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::
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 Required and NotRequired special forms can also be used to mark
individual keys as being required or not required::
class Point2D(TypedDict):
x: int # the "x" key must always be present (Required is the default)
y: NotRequired[int] # the "y" key can be omitted
See PEP 655 for more details on Required and NotRequired.
z@TypedDict takes either a dict or keyword arguments, but not bothzThe kwargs-based syntax for TypedDict definitions is deprecated in Python 3.11, will be removed in Python 3.13, and may not be understood by third-party type checkers.r
stacklevelrg r r rf ) r r3 warnDeprecationWarningr r~ r rI r )rD r/ rX rS rE rq tds rw rI rI s ^ ~ ( ) )
7
T&\ *B
YF
!< "b 6B" B
Iry rI c t fS r )
_TypedDictrM s rw ro s :-ry c N t || j d }t | |f S )a Special typing construct to mark a TypedDict key as required.
This is mainly useful for total=False TypedDicts.
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.
accepts only a single type.r r r} r] s rw re re s+ ( zdjj\1M#N OD w ''ry c N t || j d }t | |f S )a7 Special typing construct to mark a TypedDict key 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,
)
rq rr r] s rw rb rb s+ zdjj\1M#N OD w ''ry c 8 e Zd ZdZeZd Zd Zd Zd Z d Z
d Z y) r^ 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 || _ d|v r|j d d }|| _ || _ t }|dk7 r|| _ y y )Nr| r typing)r
rpartitionr
__supertype__r~ r )r rg r def_mods rw r zNewType.__init__- sN $;??3'+D
) h %DO ry c : | j G fdd }|fS )Nc e Zd Z fdZy)&NewType.__mro_entries__..Dummyc F | j }t d| d|d d )NzGCannot subclass an instance of NewType. Perhaps you were looking for: `z = NewType(r z)`)r r )r
subclass_namesuperclass_names rw r z8NewType.__mro_entries__..Dummy.__init_subclass__= s: #
%k-1B"_DUUWY ry N)r r r r )r s rw Dummyr| < s
ry r r )r r# r r s @rw r$ zNewType.__mro_entries__7 s! -- xry c 8 | j d| j S )Nr| )r r r) s rw r* zNewType.__repr__F s //"!D$5$5#677ry c | j S r )r r) s rw r- zNewType.__reduce__I s ry c t | |f S r r2 r3 s rw r5 zNewType.__or__L r6 ry c t || f S r r2 r3 s rw r8 zNewType.__ror__O r9 ry N) r r r r r
r0 r r$ r* r- r5 r8 r ry rw r^ r^ s, * H&
8!""ry r^ c e Zd ZdZdZeedefd Zeedefd Z ed!d Z
eede fd Z ede
fd Zed!d
Zede fd Zed"d e
defd
Zede fd Zed"de
defd Zed"de
dee fd Zed#de
de
de
fd Zede fd Zede
fd Zed$de
de
fd Zede fd Zedede
fd Z ed ee ddfd Z ed%d Z ed!d Z y)&rL a 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.
r r c y r r r) s rw modezIO.modej
ry c y r r r) s rw rg zIO.nameo r ry Nc y r r r) s rw closezIO.closet r ry c y r r r) s rw closedz IO.closedx r ry c y r r r) s rw filenoz IO.fileno} r ry c y r r r) s rw flushzIO.flush r ry c y r r r) s rw isattyz IO.isatty r ry r. c y r r )r r. s rw readzIO.read r ry c y r r r) s rw readablez IO.readable r ry limitc y r r )r r s rw readlinez IO.readline r ry hintc y r r )r r s rw readlinesz IO.readlines r ry offsetwhencec y r r )r r r s rw seekzIO.seek r ry c y r r r) s rw seekablez IO.seekable r ry c y r r r) s rw tellzIO.tell r ry sizec y r r )r r s rw truncatez IO.truncate r ry c y r r r) s rw writablez IO.writable r ry r? c y r r r r? s rw writezIO.write r ry linesc y r r )r r s rw
writelinesz
IO.writelines r ry c y r r r) s rw __enter__z IO.__enter__ r ry c y r r )r rs r tracebacks rw __exit__z IO.__exit__ r ry )r N)r r( r )r z
IO[AnyStr]) r r r r r r` r ru r rg r boolr r r r r rP r r r rD r r r r r r r r r r r ry rw rL rL [ sd
I
c
c
c
6
$
c
6
c
4<
3
C
$
c
S
C
$
v
#
V
ry rL c J e Zd ZdZdZedeeef de fd Z
edd Z y) rK z5Typed version of the return of open() in binary mode.r r? r c y r r r s rw r zBinaryIO.write r ry c y r r r) s rw r zBinaryIO.__enter__ r ry N)r rK ) r r r r r r r r bytearrayr r r r ry rw rK rK sH ?I
uUI -.
3
ry rK c e Zd ZdZdZeedefd Zeede fd Z
eede e fd Z eede
fd Zeedefd Zed d Zy
) rO z3Typed version of the return of open() in text mode.r r c y r r r) s rw bufferz
TextIO.buffer r ry c y r r r) s rw encodingzTextIO.encoding r ry c y r r r) s rw errorsz
TextIO.errors r ry c y r r r) s rw line_bufferingzTextIO.line_buffering r ry c y r r r) s rw newlineszTextIO.newlines r ry c y r r r) s rw r zTextIO.__enter__ r ry N)r rO )r r r r r r` r rK r ru r r r r r r r r r ry rw rO rO s =I
#
#
ry rO c e Zd Z fdZ xZS )_DeprecatedTypec |dvrD|| j v r6t j | j d| j dt d t
| | S )N> r r r z5 is deprecated, import directly from typing instead. z will be removed in Python 3.13.r rh )r r3 rj r rk rJ __getattribute__)r rg rK s rw r z _DeprecatedType.__getattribute__ s^ < < AU MM<<. !((+ ~ 6"" #
w'--ry )r r r r rM rN s @rw r r s
. .ry r c $ e Zd ZdZg dZeZeZeZy)ioz)Wrapper namespace for IO generic classes.)rL rO rK N)r r r r __all__rL rO rK r ry rw r r s 3*G B
FHry r z.ioc e Zd ZdZddgZeZeZy)rez&Wrapper namespace for re type aliases.rN rM N)r r r r r rN rM r ry rw r r
s 0'"GG Ery r z.rec d x}fd|d|fdcS )r r r c h t dt | j t j | S )a Ask a static type checker to reveal the inferred type of an expression.
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 the argument unchanged.
zRuntime type is )file)printrs r r stderrr s rw rf rf
s*
T#Y / / 2
3#**E Jry r ) .defaultsr s rw #r
s ry c * e Zd ZW fd Z Zy)_IdentityCallablec " d x}fd|d|fdcS )r rv r c y r r r s rw r0 z_IdentityCallable.__call__+
s ry r )r r
__classdict__s rw z z2_IdentityCallable.+
s q ry N)r r r r0 __classdictcell__)r s @rw r r *
s
ry r )
eq_default
order_defaultkw_only_defaultfrozen_defaultfield_specifiersr r r r r .rS c & fd}|S )as Decorator to mark an object as providing dataclass-like behaviour.
The decorator can be applied to a function, class, or metaclass.
Example usage with a decorator function::
@dataclass_transform()
def create_model[T](cls: type[T]) -> type[T]:
...
return cls
@create_model
class CustomerModel:
id: int
name: str
On a base class::
@dataclass_transform()
class ModelBase: ...
class CustomerModel(ModelBase):
id: int
name: str
On a metaclass::
@dataclass_transform()
class ModelMeta(type): ...
class ModelBase(metaclass=ModelMeta): ...
class CustomerModel(ModelBase):
id: int
name: str
The ``CustomerModel`` classes defined above will
be treated by type checkers similarly to classes created with
``@dataclasses.dataclass``.
For example, type checkers will assume these classes have
``__init__`` methods that accept ``id`` and ``name``.
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.
- ``frozen_default`` indicates whether the ``frozen`` 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()``.
- Arbitrary other keyword arguments are accepted in order to allow for
possible future extensions.
At runtime, this decorator records its arguments in the
``__dataclass_transform__`` attribute on the decorated object.
It has no other runtime effect.
See PEP 681 for more details.
c $ d| _ | S )N)r r r r r rS )__dataclass_transform__) cls_or_fnr r r r rS r s rw r z&dataclass_transform..decoratorv
s' $ * . , 0
-
) ry r )r r r r r rS r s `````` rw rU rU /
s N ry _Funcc t dt f S r )r r r ry rw r r
s Xc3h
ry c $ d d x}fd|d|fdcS )Fc t S r )r r ry rw r r
s Xry methodr c B d| _ | S # t t f$ r Y | S w xY w)a Indicate that a method is intended to override a method in a base class.
Usage::
class Base:
def method(self) -> None:
pass
class Child(Base):
@override
def method(self) -> None:
super().method()
When this decorator is applied to a method, the type checker will
validate that it overrides a method or attribute with the same name on a
base class. This helps prevent bugs that may occur when a base class is
changed without an equivalent change to a child class.
There is no runtime checking of this property. The decorator attempts to
set the ``__override__`` attribute to ``True`` on the decorated object to
allow runtime introspection.
See PEP 698 for details.
T) __override__r r )r s rw rd rd
s6 2
" M
I &
M
r r )r r s rw r
s X q ry r r )re __main__)r )NNF)r )r r r r r r collections.abccopyregr r r r stdlib_rer r r3 r r r r _typingr
r r r
r r r r r rx r r r r r r r r r r r r r r r rJ r r
r r rE rs rH r ra r] rh r\ r r r rl r r rk r rl r r r r r r r r r r r r r r} r r. r6 r: rB r rq r r rm rZ r _TYPING_INTERNALS_SPECIAL_NAMESro rs ru r~ r r r r r r r pickler r rA r r r r rg rS rQ r BuiltinFunctionTyper r r rZ r rX rW r[ r rR r_ r` r partialr r rc rY rT rV r r r r r r r r r ru rP _aliasr# r0 r3 r2 r1 r% r& r7 r. r! r4 r rF r r, r( r* r- r+ r r r r rD dequerA r rG r) r' r$ r/ r r" r r6 rB rC rE r@ r? rJ r5 r r= r; r: r9 r< r8 r> r1 rB rC r: rH rQ r= rN r$ r rI rn re rb r^ ri rj rL rK rO r r r r rN rM rf r rU r rd r ry rw r s * ( #
^ ^ o l5 PU B@
02 B
< 16 /
A
U >%
)+ %
PF F ((/6 [__00!4 +//**A . ;??,,a 0
KOO..
2
991CST Z C CQMbc
dAE/[,,amD [,,a0
$$a
( +&& * ;??,,a 0 66:
dAE/ 2
(
H
h
H
H
D E B C!T !H: ll><R@ 5
U*T U*pE EN \\.+r2
>
7 ( (. ( ($;" ;"~
`
`
F
r%y
RW
F
.d
.? BKK
""A
&y"? BKK & ! CE
QQ Q Q
Q DIc(: :C ?@
Q Q Qh ry