typing
— Підтримка підказок типу¶
Нове в версії 3.5.
Вихідний код: Lib/typing.py
Примітка
The Python runtime does not enforce function and variable type annotations. They can be used by third party tools such as type checkers, IDEs, linters, etc.
This module provides runtime support for type hints. The most fundamental
support consists of the types Any
, Union
, Callable
,
TypeVar
, and Generic
. For a full specification, please see
PEP 484. For a simplified introduction to type hints, see PEP 483.
The function below takes and returns a string and is annotated as follows:
def greeting(name: str) -> str:
return 'Hello ' + name
In the function greeting
, the argument name
is expected to be of type
str
and the return type str
. Subtypes are accepted as
arguments.
New features are frequently added to the typing
module.
The typing_extensions package
provides backports of these new features to older versions of Python.
Relevant PEPs¶
Since the initial introduction of type hints in PEP 484 and PEP 483, a number of PEPs have modified and enhanced Python’s framework for type annotations. These include:
- PEP 544: Protocols: Structural subtyping (static duck typing)
Introducing
Protocol
and the@runtime_checkable
decorator
- PEP 585: Type Hinting Generics In Standard Collections
Introducing
types.GenericAlias
and the ability to use standard library classes as generic types
Псевдоніми типів¶
A type alias is defined by assigning the type to the alias. In this example,
Vector
and list[float]
will be treated as interchangeable synonyms:
Vector = list[float]
def scale(scalar: float, vector: Vector) -> Vector:
return [scalar * num for num in vector]
# typechecks; a list of floats qualifies as a Vector.
new_vector = scale(2.0, [1.0, -4.2, 5.4])
Псевдоніми типів корисні для спрощення анотацій складних типів. Наприклад:
from collections.abc import Sequence
ConnectionOptions = dict[str, str]
Address = tuple[str, int]
Server = tuple[Address, ConnectionOptions]
def broadcast_message(message: str, servers: Sequence[Server]) -> None:
...
# The static type checker will treat the previous type signature as
# being exactly equivalent to this one.
def broadcast_message(
message: str,
servers: Sequence[tuple[tuple[str, int], dict[str, str]]]) -> None:
...
Note that None
as a type hint is a special case and is replaced by
type(None)
.
NewType¶
Use the NewType()
helper to create distinct types:
from typing import NewType
UserId = NewType('UserId', int)
some_id = UserId(524313)
Аналізатор типів розглядатиме новий тип як підклас вихідного типу. Це корисно для виявлення логічних помилок:
def get_user_name(user_id: UserId) -> str:
...
# typechecks
user_a = get_user_name(UserId(42351))
# does not typecheck; an int is not a UserId
user_b = get_user_name(-1)
Ви все ще можете виконувати всі операції int
зі змінною типу UserId
, але результат завжди матиме тип int
. Це дозволяє передавати UserId
усюди, де можна очікувати int
, але запобігає випадковому створенню UserId
недійсним способом:
# 'output' is of type 'int', not 'UserId'
output = UserId(23413) + UserId(54341)
Note that these checks are enforced only by the static type checker. At runtime,
the statement Derived = NewType('Derived', Base)
will make Derived
a
callable that immediately returns whatever parameter you pass it. That means
the expression Derived(some_value)
does not create a new class or introduce
any overhead beyond that of a regular function call.
Точніше, вираз some_value is Derived(some_value)
завжди вірний під час виконання.
This also means that it is not possible to create a subtype of Derived
since it is an identity function at runtime, not an actual type:
from typing import NewType
UserId = NewType('UserId', int)
# Fails at runtime and does not typecheck
class AdminUserId(UserId): pass
However, it is possible to create a NewType()
based on a „derived“ NewType
:
from typing import NewType
UserId = NewType('UserId', int)
ProUserId = NewType('ProUserId', UserId)
і аналіз типів для ProUserId
працюватиме належним чином.
Дивіться PEP 484 для більш детальної інформації.
Примітка
Recall that the use of a type alias declares two types to be equivalent to
one another. Doing Alias = Original
will make the static type checker
treat Alias
as being exactly equivalent to Original
in all cases.
This is useful when you want to simplify complex type signatures.
На відміну, NewType
оголошує один тип як підтип іншого. Якщо виконати Derived = NewType('Derived', Original)
, аналізатор типів розглядатиме Derived
як підклас Original
, що означає значення типу Original
не можна використовувати там, де очікується значення типу Derived
. Це корисно, коли ви хочете запобігти логічним помилкам з мінімальними витратами на виконання.
Нове в версії 3.5.2.
Callable¶
Frameworks expecting callback functions of specific signatures might be
type hinted using Callable[[Arg1Type, Arg2Type], ReturnType]
.
Наприклад:
from collections.abc import Callable
def feeder(get_next_item: Callable[[], str]) -> None:
# Body
def async_query(on_success: Callable[[int], None],
on_error: Callable[[int, Exception], None]) -> None:
# Body
async def on_update(value: str) -> None:
# Body
callback: Callable[[str], Awaitable[None]] = on_update
It is possible to declare the return type of a callable without specifying
the call signature by substituting a literal ellipsis
for the list of arguments in the type hint: Callable[..., ReturnType]
.
Узагальнення¶
Since type information about objects kept in containers cannot be statically inferred in a generic way, abstract base classes have been extended to support subscription to denote expected types for container elements.
from collections.abc import Mapping, Sequence
def notify_by_email(employees: Sequence[Employee],
overrides: Mapping[str, str]) -> None: ...
Generics can be parameterized by using a factory available in typing
called TypeVar
.
from collections.abc import Sequence
from typing import TypeVar
T = TypeVar('T') # Declare type variable
def first(l: Sequence[T]) -> T: # Generic function
return l[0]
Визначені користувачем загальні типи¶
Визначений користувачем клас можна визначити як загальний клас.
from typing import TypeVar, Generic
from logging import Logger
T = TypeVar('T')
class LoggedVar(Generic[T]):
def __init__(self, value: T, name: str, logger: Logger) -> None:
self.name = name
self.logger = logger
self.value = value
def set(self, new: T) -> None:
self.log('Set ' + repr(self.value))
self.value = new
def get(self) -> T:
self.log('Get ' + repr(self.value))
return self.value
def log(self, message: str) -> None:
self.logger.info('%s: %s', self.name, message)
Generic[T]
as a base class defines that the class LoggedVar
takes a
single type parameter T
. This also makes T
valid as a type within the
class body.
The Generic
base class defines __class_getitem__()
so
that LoggedVar[t]
is valid as a type:
from collections.abc import Iterable
def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
for var in vars:
var.set(0)
Загальний тип може мати будь-яку кількість змінних типу. Усі різновиди TypeVar
допустимі як параметри для загального типу:
from typing import TypeVar, Generic, Sequence
T = TypeVar('T', contravariant=True)
B = TypeVar('B', bound=Sequence[bytes], covariant=True)
S = TypeVar('S', int, str)
class WeirdTrio(Generic[T, B, S]):
...
Кожен аргумент змінної типу для Generic
має бути окремим. Таким чином, це недійсно:
from typing import TypeVar, Generic
...
T = TypeVar('T')
class Pair(Generic[T, T]): # INVALID
...
You can use multiple inheritance with Generic
:
from collections.abc import Sized
from typing import TypeVar, Generic
T = TypeVar('T')
class LinkedList(Sized, Generic[T]):
...
When inheriting from generic classes, some type variables could be fixed:
from collections.abc import Mapping
from typing import TypeVar
T = TypeVar('T')
class MyDict(Mapping[str, T]):
...
У цьому випадку MyDict
має єдиний параметр, T
.
Using a generic class without specifying type parameters assumes
Any
for each position. In the following example, MyIterable
is
not generic but implicitly inherits from Iterable[Any]
:
from collections.abc import Iterable
class MyIterable(Iterable): # Same as Iterable[Any]
User defined generic type aliases are also supported. Examples:
from collections.abc import Iterable
from typing import TypeVar, Union
S = TypeVar('S')
Response = Union[Iterable[S], int]
# Return type here is same as Union[Iterable[str], int]
def response(query: str) -> Response[str]:
...
T = TypeVar('T', int, float, complex)
Vec = Iterable[tuple[T, T]]
def inproduct(v: Vec[T]) -> T: # Same as Iterable[tuple[T, T]]
return sum(x*y for x, y in v)
Змінено в версії 3.7: Generic
більше не має спеціального метакласу.
A user-defined generic class can have ABCs as base classes without a metaclass conflict. Generic metaclasses are not supported. The outcome of parameterizing generics is cached, and most types in the typing module are hashable and comparable for equality.
Тип Any
¶
Особливий вид типу — Any
. Засіб перевірки статичних типів розглядатиме кожен тип як сумісний із Any
і Any
як сумісні з кожним типом.
Це означає, що можна виконати будь-яку операцію або викликати метод над значенням типу Any
і призначити його будь-якій змінній:
from typing import Any
a: Any = None
a = [] # OK
a = 2 # OK
s: str = ''
s = a # OK
def foo(item: Any) -> int:
# Typechecks; 'item' could be any type,
# and that type might have a 'bar' method
item.bar()
...
Notice that no typechecking is performed when assigning a value of type
Any
to a more precise type. For example, the static type checker did
not report an error when assigning a
to s
even though s
was
declared to be of type str
and receives an int
value at
runtime!
Крім того, усі функції без типу повернення або типів параметрів неявно використовуватимуть за умовчанням Any
:
def legacy_parser(text):
...
return data
# A static type checker will treat the above
# as having the same signature as:
def legacy_parser(text: Any) -> Any:
...
return data
Така поведінка дозволяє Any
використовувати як вихідний люк, коли вам потрібно змішати динамічний і статичний код.
Порівняйте поведінку Any
з поведінкою object
. Подібно до Any
, кожен тип є підтипом object
. Однак, на відміну від Any
, зворотне не вірно: object
не є підтипом будь-якого іншого типу.
Це означає, що коли тип значення object
, засіб перевірки типів відхилить майже всі операції над ним, а присвоєння його змінній (або використання її як значення, що повертається) більш спеціалізованого типу є типом помилка. Наприклад:
def hash_a(item: object) -> int:
# Fails; an object does not have a 'magic' method.
item.magic()
...
def hash_b(item: Any) -> int:
# Typechecks
item.magic()
...
# Typechecks, since ints and strs are subclasses of object
hash_a(42)
hash_a("foo")
# Typechecks, since Any is compatible with all types
hash_b(42)
hash_b("foo")
Використовуйте object
, щоб вказати, що значення може мати будь-який тип у безпечний спосіб. Використовуйте Any
, щоб вказати, що значення вводиться динамічно.
Номінальний проти структурного підтипу¶
Спочатку PEP 484 визначив систему статичних типів Python як таку, що використовує номінальний підтип. Це означає, що клас A
дозволений там, де очікується клас B
, якщо і тільки якщо A
є підкласом B
.
Ця вимога раніше також застосовувалася до абстрактних базових класів, таких як Iterable
. Проблема з цим підходом полягає в тому, що клас повинен бути явно позначений для їх підтримки, що не є пітонічним і не схожим на те, що зазвичай робили б у ідіоматичному динамічно введеному коді Python. Наприклад, це відповідає PEP 484:
from collections.abc import Sized, Iterable, Iterator
class Bucket(Sized, Iterable[int]):
...
def __len__(self) -> int: ...
def __iter__(self) -> Iterator[int]: ...
PEP 544 дозволяє вирішити цю проблему, дозволяючи користувачам писати наведений вище код без явних базових класів у визначенні класу, дозволяючи Bucket
неявно вважатися підтипом як Sized
, так і Iterable[int]
засобами перевірки статичних типів. Це відоме як структурне підтипування (або статичне качине типування):
from collections.abc import Iterator, Iterable
class Bucket: # Note: no base classes
...
def __len__(self) -> int: ...
def __iter__(self) -> Iterator[int]: ...
def collect(items: Iterable[int]) -> int: ...
result = collect(Bucket()) # Passes type check
Крім того, створивши підклас спеціального класу Protocol
, користувач може визначати нові користувальницькі протоколи, щоб повною мірою користуватися структурними підтипами (див. приклади нижче).
Зміст модуля¶
The module defines the following classes, functions and decorators.
Примітка
This module defines several types that are subclasses of pre-existing
standard library classes which also extend Generic
to support type variables inside []
.
These types became redundant in Python 3.9 when the
corresponding pre-existing classes were enhanced to support []
.
The redundant types are deprecated as of Python 3.9 but no deprecation warnings will be issued by the interpreter. It is expected that type checkers will flag the deprecated types when the checked program targets Python 3.9 or newer.
The deprecated types will be removed from the typing
module
in the first Python version released 5 years after the release of Python 3.9.0.
See details in PEP 585—Type Hinting Generics In Standard Collections.
Спеціальні примітиви типізації¶
Особливі види¶
These can be used as types in annotations and do not support []
.
-
typing.
Any
¶ Спеціальний тип, що вказує на необмежений тип.
-
typing.
NoReturn
¶ Special type indicating that a function never returns. For example:
from typing import NoReturn def stop() -> NoReturn: raise RuntimeError('no way')
Нове в версії 3.5.4.
Нове в версії 3.6.2.
Спеціальні форми¶
These can be used as types in annotations using []
, each having a unique syntax.
-
typing.
Tuple
¶ Tuple type;
Tuple[X, Y]
is the type of a tuple of two items with the first item of type X and the second of type Y. The type of the empty tuple can be written asTuple[()]
.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 literal ellipsis, e.g.
Tuple[int, ...]
. A plainTuple
is equivalent toTuple[Any, ...]
, and in turn totuple
.Застаріло починаючи з версії 3.9:
builtins.tuple
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
typing.
Union
¶ Union type;
Union[X, Y]
means either X or Y.To define a union, use e.g.
Union[int, str]
. Details:Аргументи мають бути типами і має бути принаймні один.
Союзи союзів зведені, наприклад:
Union[Union[int, str], float] == Union[int, str, float]
Союзи одного аргументу зникають, наприклад:
Union[int] == int # The constructor actually returns int
Зайві аргументи пропускаються, наприклад:
Union[int, str, int] == Union[int, str]
Під час порівняння об’єднань порядок аргументів ігнорується, наприклад:
Union[int, str] == Union[str, int]
You cannot subclass or instantiate a union.
Ви не можете писати
Union[X][Y]
.You can use
Optional[X]
as a shorthand forUnion[X, None]
.
Змінено в версії 3.7: Не видаляйте явні підкласи з об’єднань під час виконання.
-
typing.
Optional
¶ Optional type.
Optional[X]
is equivalent toUnion[X, None]
.Зауважте, що це не те саме поняття, що необов’язковий аргумент, який має значення за умовчанням. Необов’язковий аргумент із значенням за замовчуванням не потребує кваліфікатора
Optional
в анотації свого типу лише тому, що він є необов’язковим. Наприклад:def foo(arg: int = 0) -> None: ...
З іншого боку, якщо дозволено явне значення
None
, використанняOptional
є доречним, незалежно від того, чи є аргумент необов’язковим. Наприклад:def foo(arg: Optional[int] = None) -> None: ...
-
typing.
Callable
¶ Callable type;
Callable[[int], str]
is a function of (int) -> str.The subscription syntax must always be used with exactly two values: the argument list and the return type. The argument list must be a list of types or an 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.
Callable[..., ReturnType]
(literal ellipsis) can be used to type hint a callable taking any number of arguments and returningReturnType
. A plainCallable
is equivalent toCallable[..., Any]
, and in turn tocollections.abc.Callable
.Застаріло починаючи з версії 3.9:
collections.abc.Callable
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Type
(Generic[CT_co])¶ A variable annotated with
C
may accept a value of typeC
. In contrast, a variable annotated withType[C]
may accept values that are classes themselves – specifically, it will accept the class object ofC
. For example:a = 3 # Has type 'int' b = int # Has type 'Type[int]' c = type(a) # Also has type 'Type[int]'
Note that
Type[C]
is covariant:class User: ... class BasicUser(User): ... class ProUser(User): ... class TeamUser(User): ... # Accepts User, BasicUser, ProUser, TeamUser, ... def make_new_user(user_class: Type[User]) -> User: # ... return user_class()
The fact that
Type[C]
is covariant implies that all subclasses ofC
should implement the same constructor signature and class method signatures asC
. The type checker should flag violations of this, but should also allow constructor calls in subclasses that match the constructor calls in the indicated base class. How the type checker is required to handle this particular case may change in future revisions of PEP 484.The only legal parameters for
Type
are classes,Any
, type variables, and unions of any of these types. For example:def new_non_team_user(user_class: Type[Union[BasicUser, ProUser]]): ...
Type[Any]
is equivalent toType
which in turn is equivalent totype
, which is the root of Python’s metaclass hierarchy.Нове в версії 3.5.2.
Застаріло починаючи з версії 3.9:
builtins.type
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
typing.
Literal
¶ A type that 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). For example:
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[...]
, але засоби перевірки типу можуть накладати обмеження. Дивіться PEP 586 для отримання додаткової інформації про літеральні типи.Нове в версії 3.8.
-
typing.
ClassVar
¶ Конструкція спеціального типу для позначення змінних класу.
Як представлено в PEP 526, анотація змінної, загорнена в ClassVar, вказує на те, що даний атрибут призначений для використання як змінна класу і не повинен встановлюватися для екземплярів цього класу. Використання:
class Starship: stats: ClassVar[dict[str, int]] = {} # class variable damage: int = 10 # instance variable
ClassVar
приймає лише типи і не може бути підписаний далі.ClassVar
сам по собі не є класом і не повинен використовуватися зisinstance()
абоissubclass()
.ClassVar
не змінює поведінку Python під час виконання, але його можуть використовувати сторонні засоби перевірки типу. Наприклад, засіб перевірки типу може позначити наступний код як помилку:enterprise_d = Starship(3000) enterprise_d.stats = {} # Error, setting class variable on instance Starship.stats = {} # This is OK
Нове в версії 3.5.3.
-
typing.
Final
¶ A special typing construct to indicate to type checkers 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
Немає жодної перевірки цих властивостей під час виконання. Дивіться PEP 591 для більш детальної інформації.
Нове в версії 3.8.
-
typing.
Annotated
¶ A type, introduced in PEP 593 (
Flexible function and variable annotations
), to decorate existing types with context-specific metadata (possibly multiple pieces of it, asAnnotated
is variadic). Specifically, a typeT
can be annotated with metadatax
via the typehintAnnotated[T, x]
. This metadata can be used for either static analysis or at runtime. If a library (or tool) encounters a typehintAnnotated[T, x]
and has no special logic for metadatax
, it should ignore it and simply treat the type asT
. Unlike theno_type_check
functionality that currently exists in thetyping
module which completely disables typechecking annotations on a function or a class, theAnnotated
type allows for both static typechecking ofT
(which can safely ignorex
) together with runtime access tox
within a specific application.Ultimately, the responsibility of how to interpret the annotations (if at all) is the responsibility of the tool or library encountering the
Annotated
type. A tool or library encountering anAnnotated
type can scan through the annotations to determine if they are of interest (e.g., usingisinstance()
).When a tool or a library does not support annotations or encounters an unknown annotation it should just ignore it and treat annotated type as the underlying type.
It’s up to the tool consuming the annotations to decide whether the client is allowed to have several annotations on one type and how to merge those annotations.
Since the
Annotated
type allows you to put several annotations of the same (or different) type(s) on any node, the tools or libraries consuming those annotations are in charge of dealing with potential duplicates. For example, if you are doing value range analysis you might allow this:T1 = Annotated[int, ValueRange(-10, 5)] T2 = Annotated[T1, ValueRange(-20, 3)]
Passing
include_extras=True
toget_type_hints()
lets one access the extra annotations at runtime.The details of the syntax:
Перший аргумент
Анотований
має бути дійсного типуMultiple type annotations are supported (
Annotated
supports variadic arguments):Annotated[int, ValueRange(3, 10), ctype("char")]
Annotated
must be called with at least two arguments (Annotated[int]
is not valid)The order of the annotations is preserved and matters for equality checks:
Annotated[int, ValueRange(3, 10), ctype("char")] != Annotated[ int, ctype("char"), ValueRange(3, 10) ]
Nested
Annotated
types are flattened, with metadata ordered starting with the innermost annotation:Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[ int, ValueRange(3, 10), ctype("char") ]
Duplicated annotations are not removed:
Annotated[int, ValueRange(3, 10)] != Annotated[ int, ValueRange(3, 10), ValueRange(3, 10) ]
Annotated
can be used with nested and generic aliases:T = TypeVar('T') Vec = Annotated[list[tuple[T, T]], MaxLen(10)] V = Vec[int] V == Annotated[list[tuple[int, int]], MaxLen(10)]
Нове в версії 3.9.
Building generic types¶
These are not used in annotations. They are building blocks for creating generic types.
-
class
typing.
Generic
¶ Абстрактний базовий клас для загальних типів.
A generic type is typically declared by inheriting from an instantiation of this class with one or more type variables. For example, a generic mapping type might be defined as:
class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.
Потім цей клас можна використовувати наступним чином:
X = TypeVar('X') Y = TypeVar('Y') def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y: try: return mapping[key] except KeyError: return default
-
class
typing.
TypeVar
¶ Тип змінної.
Використання:
T = TypeVar('T') # Can be anything S = TypeVar('S', bound=str) # Can be any subtype of str A = TypeVar('A', str, bytes) # Must be exactly str or bytes
Type variables exist primarily for the benefit of static type checkers. They serve as the parameters for generic types as well as for generic function definitions. See
Generic
for more information on generic types. Generic functions work as follows:def repeat(x: T, n: int) -> Sequence[T]: """Return a list containing n references to x.""" return [x]*n def print_capitalized(x: S) -> S: """Print x capitalized, and return x.""" print(x.capitalize()) return x def concatenate(x: A, y: A) -> A: """Add two strings or bytes objects together.""" return x + y
Note that type variables can be bound, constrained, or neither, but cannot be both bound and constrained.
Constrained type variables and bound type variables have different semantics in several important ways. Using a constrained type variable means that the
TypeVar
can only ever be solved as being exactly one of the constraints given:a = concatenate('one', 'two') # Ok, variable 'a' has type 'str' b = concatenate(StringSubclass('one'), StringSubclass('two')) # Inferred type of variable 'b' is 'str', # despite 'StringSubclass' being passed in c = concatenate('one', b'two') # error: type variable 'A' can be either 'str' or 'bytes' in a function call, but not both
Using a bound type variable, however, means that the
TypeVar
will be solved using the most specific type possible:print_capitalized('a string') # Ok, output has type 'str' class StringSubclass(str): pass print_capitalized(StringSubclass('another string')) # Ok, output has type 'StringSubclass' print_capitalized(45) # error: int is not a subtype of str
Type variables can be bound to concrete types, abstract types (ABCs or protocols), and even unions of types:
U = TypeVar('U', bound=str|bytes) # Can be any subtype of the union str|bytes V = TypeVar('V', bound=SupportsAbs) # Can be anything with an __abs__ method
Bound type variables are particularly useful for annotating
classmethods
that serve as alternative constructors. In the following example (© Raymond Hettinger), the type variableC
is bound to theCircle
class through the use of a forward reference. Using this type variable to annotate thewith_circumference
classmethod, rather than hardcoding the return type asCircle
, means that a type checker can correctly infer the return type even if the method is called on a subclass:import math C = TypeVar('C', bound='Circle') class Circle: """An abstract circle""" def __init__(self, radius: float) -> None: self.radius = radius # Use a type variable to show that the return type # will always be an instance of whatever ``cls`` is @classmethod def with_circumference(cls: type[C], circumference: float) -> C: """Create a circle with the specified circumference""" radius = circumference / (math.pi * 2) return cls(radius) class Tire(Circle): """A specialised circle (made out of rubber)""" MATERIAL = 'rubber' c = Circle.with_circumference(3) # Ok, variable 'c' has type 'Circle' t = Tire.with_circumference(4) # Ok, variable 't' has type 'Tire' (not 'Circle')
At runtime,
isinstance(x, T)
will raiseTypeError
. In general,isinstance()
andissubclass()
should not be used with types.Type variables may be marked covariant or contravariant by passing
covariant=True
orcontravariant=True
. See PEP 484 for more details. By default, type variables are invariant.
-
typing.
AnyStr
¶ AnyStr
is aconstrained type variable
defined asAnyStr = TypeVar('AnyStr', str, bytes)
.It is meant to be used for functions that may accept any kind of string without allowing different kinds of strings to mix. For example:
def concat(a: AnyStr, b: AnyStr) -> AnyStr: return a + b concat(u"foo", u"bar") # Ok, output has type 'unicode' concat(b"foo", b"bar") # Ok, output has type 'bytes' concat(u"foo", b"bar") # Error, cannot mix unicode and bytes
-
class
typing.
Protocol
(Generic)¶ Base class for protocol classes. Protocol classes are defined like this:
class Proto(Protocol): def meth(self) -> int: ...
Такі класи в основному використовуються із засобами перевірки статичних типів, які розпізнають структурні підтипи (статичне типування), наприклад:
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
runtime_checkable()
(described later) act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures.Класи протоколів можуть бути загальними, наприклад:
class GenProto(Protocol[T]): def meth(self) -> T: ...
Нове в версії 3.8.
-
@
typing.
runtime_checkable
¶ Позначте клас протоколу як протокол виконання.
Такий протокол можна використовувати з
isinstance()
іissubclass()
. Це викликаєTypeError
, коли застосовується до непротокольного класу. Це дозволяє здійснити просту структурну перевірку, дуже схожу на «поні з одним трюком» уcollections.abc
, наприкладIterable
. Наприклад:@runtime_checkable class Closable(Protocol): def close(self): ... assert isinstance(open('/some/file'), Closable)
Примітка
runtime_checkable()
will check only the presence of the required methods, not their type signatures! For example,builtins.complex
implements__float__()
, therefore it passes anissubclass()
check againstSupportsFloat
. However, thecomplex.__float__
method exists only to raise aTypeError
with a more informative message.Нове в версії 3.8.
Інші спеціальні директиви¶
These are not used in annotations. They are building blocks for declaring types.
-
class
typing.
NamedTuple
¶ Введена версія
collections.namedtuple()
.Використання:
class Employee(NamedTuple): name: str id: int
Це еквівалентно:
Employee = collections.namedtuple('Employee', ['name', 'id'])
Щоб надати полю значення за замовчуванням, ви можете призначити йому в тілі класу:
class Employee(NamedTuple): name: str id: int = 3 employee = Employee('Guido') assert employee.id == 3
Поля зі значенням за замовчуванням мають бути після будь-яких полів без значення за замовчуванням.
Отриманий клас має додатковий атрибут
__annotations__
, що дає диктофон, який зіставляє назви полів із типами полів. (Імена полів містяться в атрибуті_fields
, а значення за замовчуванням — в атрибуті_field_defaults
, обидва з яких є частиною APInamedtuple()
.)Підкласи
NamedTuple
також можуть мати рядки документації та методи:class Employee(NamedTuple): """Represents an employee.""" name: str id: int = 3 def __repr__(self) -> str: return f'<Employee {self.name}, id={self.id}>'
Зворотно сумісне використання:
Employee = NamedTuple('Employee', [('name', str), ('id', int)])
Змінено в версії 3.6: Додано підтримку синтаксису анотації змінної PEP 526.
Змінено в версії 3.6.1: Додано підтримку стандартних значень, методів і рядків документів.
Змінено в версії 3.8: Атрибути
_field_types
і__annotations__
тепер є звичайними словниками замість екземплярівOrderedDict
.Змінено в версії 3.9: Видалено атрибут
_field_types
на користь стандартнішого атрибута__annotations__
, який містить ту саму інформацію.
-
typing.
NewType
(name, tp)¶ A helper function to indicate a distinct type to a typechecker, see NewType. At runtime it returns a function that returns its argument. Usage:
UserId = NewType('UserId', int) first_user = UserId(1)
Нове в версії 3.5.2.
-
class
typing.
TypedDict
(dict)¶ Спеціальна конструкція для додавання підказок типу до словника. Під час виконання це звичайний
dict
.TypedDict
оголошує тип словника, який очікує, що всі його екземпляри матимуть певний набір ключів, де кожен ключ пов’язаний зі значенням узгодженого типу. Це очікування не перевіряється під час виконання, а виконується лише засобами перевірки типів. Використання: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')
To allow using this feature with older versions of Python that do not support PEP 526,
TypedDict
supports two additional equivalent syntactic forms:Using a literal
dict
as the second argument:Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})
Using keyword arguments:
Point2D = TypedDict('Point2D', x=int, y=int, label=str)
The functional syntax should also be used when any of the keys are not valid identifiers, for example because they are keywords or contain hyphens. Example:
# raises SyntaxError class Point2D(TypedDict): in: int # 'in' is a keyword x-y: int # name with hyphens # OK, functional syntax Point2D = TypedDict('Point2D', {'in': int, 'x-y': int})
By default, all keys must be present in a
TypedDict
. It is possible to override this by specifying totality. Usage:class Point2D(TypedDict, total=False): x: int y: int # Alternative syntax Point2D = TypedDict('Point2D', {'x': int, 'y': int}, total=False)
Це означає, що в
Point2D
TypedDict
може бути пропущений будь-який із ключів. Очікується, що засіб перевірки типів підтримуватиме лише літералиFalse
абоTrue
як значення аргументуtotal
.True
є типовим і робить обов’язковими всі елементи, визначені в тілі класу.Тип
TypedDict
може успадкувати від одного або кількох інших типівTypedDict
за допомогою синтаксису на основі класу. Використання:class Point3D(Point2D): z: int
Point3D
має три елементи:x
,y
іz
. Це еквівалентно цьому визначенню:class Point3D(TypedDict): x: int y: int z: int
A
TypedDict
cannot inherit from a non-TypedDict
class, notably includingGeneric
. For example:class X(TypedDict): x: int class Y(TypedDict): y: int class Z(object): pass # A non-TypedDict class class XY(X, Y): pass # OK class XZ(X, Z): pass # raises TypeError T = TypeVar('T') class XT(X, Generic[T]): pass # raises TypeError
A
TypedDict
can be introspected via__annotations__
,__total__
,__required_keys__
, and__optional_keys__
.-
__total__
¶ Point2D.__total__
gives the value of thetotal
argument. Example:>>> from typing import TypedDict >>> class Point2D(TypedDict): pass >>> Point2D.__total__ True >>> class Point2D(TypedDict, total=False): pass >>> Point2D.__total__ False >>> class Point3D(Point2D): pass >>> Point3D.__total__ True
-
__required_keys__
¶
-
__optional_keys__
¶ Point2D.__required_keys__
andPoint2D.__optional_keys__
returnfrozenset
objects containing required and non-required keys, respectively. Currently the only way to declare both required and non-required keys in the sameTypedDict
is mixed inheritance, declaring aTypedDict
with one value for thetotal
argument and then inheriting it from anotherTypedDict
with a different value fortotal
. Usage:>>> class Point2D(TypedDict, total=False): ... x: int ... y: int ... >>> class Point3D(Point2D): ... z: int ... >>> Point3D.__required_keys__ == frozenset({'z'}) True >>> Point3D.__optional_keys__ == frozenset({'x', 'y'}) True
Перегляньте PEP 589 більше прикладів і детальних правил використання
TypedDict
.Нове в версії 3.8.
Generic concrete collections¶
Corresponding to built-in types¶
-
class
typing.
Dict
(dict, MutableMapping[KT, VT])¶ A generic version of
dict
. Useful for annotating return types. To annotate arguments it is preferred to use an abstract collection type such asMapping
.This type can be used as follows:
def count_words(text: str) -> Dict[str, int]: ...
Застаріло починаючи з версії 3.9:
builtins.dict
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
List
(list, MutableSequence[T])¶ Generic version of
list
. Useful for annotating return types. To annotate arguments it is preferred to use an abstract collection type such asSequence
orIterable
.This type may be used as follows:
T = TypeVar('T', int, float) def vec2(x: T, y: T) -> List[T]: return [x, y] def keep_positives(vector: Sequence[T]) -> List[T]: return [item for item in vector if item > 0]
Застаріло починаючи з версії 3.9:
builtins.list
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Set
(set, MutableSet[T])¶ A generic version of
builtins.set
. Useful for annotating return types. To annotate arguments it is preferred to use an abstract collection type such asAbstractSet
.Застаріло починаючи з версії 3.9:
builtins.set
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
FrozenSet
(frozenset, AbstractSet[T_co])¶ A generic version of
builtins.frozenset
.Застаріло починаючи з версії 3.9:
builtins.frozenset
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
Примітка
Tuple
is a special form.
Corresponding to types in collections
¶
-
class
typing.
DefaultDict
(collections.defaultdict, MutableMapping[KT, VT])¶ A generic version of
collections.defaultdict
.Нове в версії 3.5.2.
Застаріло починаючи з версії 3.9:
collections.defaultdict
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
OrderedDict
(collections.OrderedDict, MutableMapping[KT, VT])¶ A generic version of
collections.OrderedDict
.Нове в версії 3.7.2.
Застаріло починаючи з версії 3.9:
collections.OrderedDict
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
ChainMap
(collections.ChainMap, MutableMapping[KT, VT])¶ A generic version of
collections.ChainMap
.Нове в версії 3.5.4.
Нове в версії 3.6.1.
Застаріло починаючи з версії 3.9:
collections.ChainMap
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Counter
(collections.Counter, Dict[T, int])¶ A generic version of
collections.Counter
.Нове в версії 3.5.4.
Нове в версії 3.6.1.
Застаріло починаючи з версії 3.9:
collections.Counter
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Deque
(deque, MutableSequence[T])¶ A generic version of
collections.deque
.Нове в версії 3.5.4.
Нове в версії 3.6.1.
Застаріло починаючи з версії 3.9:
collections.deque
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
Other concrete types¶
-
class
typing.
IO
¶ -
class
typing.
TextIO
¶ -
class
typing.
BinaryIO
¶ Загальний тип
IO[AnyStr]
і його підкласиTextIO(IO[str])
іBinaryIO(IO[bytes])
представляють типи потоків вводу/виводу, такі як повертаютьсяopen()
.Deprecated since version 3.8, will be removed in version 3.12: These types are also in the
typing.io
namespace, which was never supported by type checkers and will be removed.
-
class
typing.
Pattern
¶ -
class
typing.
Match
¶ These type aliases correspond to the return types from
re.compile()
andre.match()
. These types (and the corresponding functions) are generic inAnyStr
and can be made specific by writingPattern[str]
,Pattern[bytes]
,Match[str]
, orMatch[bytes]
.Deprecated since version 3.8, will be removed in version 3.12: These types are also in the
typing.re
namespace, which was never supported by type checkers and will be removed.Застаріло починаючи з версії 3.9: Класи
Pattern
іMatch
відre
тепер підтримують[]
. Див. PEP 585 і Загальний тип псевдоніма.
-
class
typing.
Text
¶ Text
is an alias forstr
. It is provided to supply a forward compatible path for Python 2 code: in Python 2,Text
is an alias forunicode
.Використовуйте
Текст
, щоб вказати, що значення має містити рядок Юнікод у спосіб, сумісний як з Python 2, так і з Python 3:def add_unicode_checkmark(text: Text) -> Text: return text + u' \u2713'
Нове в версії 3.5.2.
Abstract Base Classes¶
Corresponding to collections in collections.abc
¶
-
class
typing.
AbstractSet
(Sized, Collection[T_co])¶ A generic version of
collections.abc.Set
.Застаріло починаючи з версії 3.9:
collections.abc.Set
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
ByteString
(Sequence[int])¶ A generic version of
collections.abc.ByteString
.Цей тип представляє типи
bytes
,bytearray
іmemoryview
послідовностей байтів.As a shorthand for this type,
bytes
can be used to annotate arguments of any of the types mentioned above.Застаріло починаючи з версії 3.9:
collections.abc.ByteString
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Collection
(Sized, Iterable[T_co], Container[T_co])¶ A generic version of
collections.abc.Collection
Нове в версії 3.6.0.
Застаріло починаючи з версії 3.9:
collections.abc.Collection
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Container
(Generic[T_co])¶ A generic version of
collections.abc.Container
.Застаріло починаючи з версії 3.9:
collections.abc.Container
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
ItemsView
(MappingView, Generic[KT_co, VT_co])¶ A generic version of
collections.abc.ItemsView
.Застаріло починаючи з версії 3.9:
collections.abc.ItemsView
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
KeysView
(MappingView[KT_co], AbstractSet[KT_co])¶ A generic version of
collections.abc.KeysView
.Застаріло починаючи з версії 3.9:
collections.abc.KeysView
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Mapping
(Sized, Collection[KT], Generic[VT_co])¶ A generic version of
collections.abc.Mapping
. This type can be used as follows:def get_position_in_index(word_list: Mapping[str, int], word: str) -> int: return word_list[word]
Застаріло починаючи з версії 3.9:
collections.abc.Mapping
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
MappingView
(Sized, Iterable[T_co])¶ A generic version of
collections.abc.MappingView
.Застаріло починаючи з версії 3.9:
collections.abc.MappingView
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
MutableMapping
(Mapping[KT, VT])¶ A generic version of
collections.abc.MutableMapping
.Застаріло починаючи з версії 3.9:
collections.abc.MutableMapping
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
MutableSequence
(Sequence[T])¶ A generic version of
collections.abc.MutableSequence
.Застаріло починаючи з версії 3.9:
collections.abc.MutableSequence
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
MutableSet
(AbstractSet[T])¶ A generic version of
collections.abc.MutableSet
.Застаріло починаючи з версії 3.9:
collections.abc.MutableSet
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Sequence
(Reversible[T_co], Collection[T_co])¶ A generic version of
collections.abc.Sequence
.Застаріло починаючи з версії 3.9:
collections.abc.Sequence
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
ValuesView
(MappingView[VT_co])¶ A generic version of
collections.abc.ValuesView
.Застаріло починаючи з версії 3.9:
collections.abc.ValuesView
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
Corresponding to other types in collections.abc
¶
-
class
typing.
Iterable
(Generic[T_co])¶ A generic version of
collections.abc.Iterable
.Застаріло починаючи з версії 3.9:
collections.abc.Iterable
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Iterator
(Iterable[T_co])¶ A generic version of
collections.abc.Iterator
.Застаріло починаючи з версії 3.9:
collections.abc.Iterator
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Generator
(Iterator[T_co], Generic[T_co, T_contra, V_co])¶ A generator can be annotated by the generic type
Generator[YieldType, SendType, ReturnType]
. For example:def echo_round() -> Generator[int, float, str]: sent = yield 0 while sent >= 0: sent = yield round(sent) return 'Done'
Note that unlike many other generics in the typing module, the
SendType
ofGenerator
behaves contravariantly, not covariantly or invariantly.If your generator will only yield values, set the
SendType
andReturnType
toNone
:def infinite_stream(start: int) -> Generator[int, None, None]: while True: yield start start += 1
Alternatively, annotate your generator as having a return type of either
Iterable[YieldType]
orIterator[YieldType]
:def infinite_stream(start: int) -> Iterator[int]: while True: yield start start += 1
Застаріло починаючи з версії 3.9:
collections.abc.Generator
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Hashable
¶ An alias to
collections.abc.Hashable
.
-
class
typing.
Reversible
(Iterable[T_co])¶ A generic version of
collections.abc.Reversible
.Застаріло починаючи з версії 3.9:
collections.abc.Reversible
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Sized
¶ An alias to
collections.abc.Sized
.
Asynchronous programming¶
-
class
typing.
Coroutine
(Awaitable[V_co], Generic[T_co, T_contra, V_co])¶ A generic version of
collections.abc.Coroutine
. The variance and order of type variables correspond to those ofGenerator
, for example:from collections.abc import Coroutine c: Coroutine[list[str], str, int] # Some coroutine defined elsewhere x = c.send('hi') # Inferred type of 'x' is list[str] async def bar() -> None: y = await c # Inferred type of 'y' is int
Нове в версії 3.5.3.
Застаріло починаючи з версії 3.9:
collections.abc.Coroutine
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
AsyncGenerator
(AsyncIterator[T_co], Generic[T_co, T_contra])¶ An async generator can be annotated by the generic type
AsyncGenerator[YieldType, SendType]
. For example:async def echo_round() -> AsyncGenerator[int, float]: sent = yield 0 while sent >= 0.0: rounded = await round(sent) sent = yield rounded
Unlike normal generators, async generators cannot return a value, so there is no
ReturnType
type parameter. As withGenerator
, theSendType
behaves contravariantly.If your generator will only yield values, set the
SendType
toNone
:async def infinite_stream(start: int) -> AsyncGenerator[int, None]: while True: yield start start = await increment(start)
Alternatively, annotate your generator as having a return type of either
AsyncIterable[YieldType]
orAsyncIterator[YieldType]
:async def infinite_stream(start: int) -> AsyncIterator[int]: while True: yield start start = await increment(start)
Нове в версії 3.6.1.
Застаріло починаючи з версії 3.9:
collections.abc.AsyncGenerator
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
AsyncIterable
(Generic[T_co])¶ A generic version of
collections.abc.AsyncIterable
.Нове в версії 3.5.2.
Застаріло починаючи з версії 3.9:
collections.abc.AsyncIterable
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
AsyncIterator
(AsyncIterable[T_co])¶ A generic version of
collections.abc.AsyncIterator
.Нове в версії 3.5.2.
Застаріло починаючи з версії 3.9:
collections.abc.AsyncIterator
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
Awaitable
(Generic[T_co])¶ A generic version of
collections.abc.Awaitable
.Нове в версії 3.5.2.
Застаріло починаючи з версії 3.9:
collections.abc.Awaitable
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
Context manager types¶
-
class
typing.
ContextManager
(Generic[T_co])¶ A generic version of
contextlib.AbstractContextManager
.Нове в версії 3.5.4.
Нове в версії 3.6.0.
Застаріло починаючи з версії 3.9:
contextlib.AbstractContextManager
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
-
class
typing.
AsyncContextManager
(Generic[T_co])¶ A generic version of
contextlib.AbstractAsyncContextManager
.Нове в версії 3.5.4.
Нове в версії 3.6.2.
Застаріло починаючи з версії 3.9:
contextlib.AbstractAsyncContextManager
now supports[]
. See PEP 585 and Загальний тип псевдоніма.
Протоколи¶
These protocols are decorated with runtime_checkable()
.
-
class
typing.
SupportsAbs
¶ ABC з одним абстрактним методом
__abs__
, який є коваріантним у своєму типі повернення.
-
class
typing.
SupportsBytes
¶ ABC з одним абстрактним методом
__bytes__
.
-
class
typing.
SupportsComplex
¶ ABC з одним абстрактним методом
__complex__
.
-
class
typing.
SupportsFloat
¶ ABC з одним абстрактним методом
__float__
.
-
class
typing.
SupportsIndex
¶ ABC з одним абстрактним методом
__index__
.Нове в версії 3.8.
-
class
typing.
SupportsInt
¶ ABC з одним абстрактним методом
__int__
.
-
class
typing.
SupportsRound
¶ ABC з одним абстрактним методом
__round__
, який є коваріантним у своєму типі повернення.
Функції та декоратори¶
-
typing.
cast
(typ, val)¶ Приведення значення до типу.
Це повертає значення без змін. Для засобу перевірки типів це означає, що значення, що повертається, має визначений тип, але під час виконання ми навмисно нічого не перевіряємо (ми хочемо, щоб це було якомога швидше).
-
@
typing.
overload
¶ The
@overload
decorator allows describing functions and methods that support multiple different combinations of argument types. A series of@overload
-decorated definitions must be followed by exactly one non-@overload
-decorated definition (for the same function/method). The@overload
-decorated definitions are for the benefit of the type checker only, since they will be overwritten by the non-@overload
-decorated definition, while the latter is used at runtime but should be ignored by a type checker. At runtime, calling a@overload
-decorated function directly will raiseNotImplementedError
. An example of overload that gives a more precise type than can be expressed using a union or a type variable:@overload def process(response: None) -> None: ... @overload def process(response: int) -> tuple[int, str]: ... @overload def process(response: bytes) -> str: ... def process(response): <actual implementation>
See PEP 484 for details and comparison with other typing semantics.
-
@
typing.
final
¶ A decorator to indicate to type checkers that the decorated method cannot be overridden, and the 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 ...
Немає жодної перевірки цих властивостей під час виконання. Дивіться PEP 591 для більш детальної інформації.
Нове в версії 3.8.
-
@
typing.
no_type_check
¶ Декоратор, щоб вказати, що анотації не є підказками типу.
This works as class or function decorator. With a class, it applies recursively to all methods defined in that class (but not to methods defined in its superclasses or subclasses).
This mutates the function(s) in place.
-
@
typing.
no_type_check_decorator
¶ Декоратор, щоб надати іншому декоратору ефект
no_type_check()
.Це обертає декоратор чимось, що обертає декоровану функцію в
no_type_check()
.
-
@
typing.
type_check_only
¶ Decorator to mark a class or function to be unavailable at runtime.
Сам цей декоратор недоступний під час виконання. В основному він призначений для позначення класів, визначених у файлах-заглушках типу, якщо реалізація повертає екземпляр приватного класу:
@type_check_only class Response: # private or not available at runtime code: int def get_header(self, name: str) -> str: ... def fetch_response() -> Response: ...
Зауважте, що повертати екземпляри приватних класів не рекомендується. Зазвичай бажано зробити такі заняття публічними.
Помічники в самоаналізі¶
-
typing.
get_type_hints
(obj, globalns=None, localns=None, include_extras=False)¶ Повертає словник, що містить підказки типу для функції, методу, модуля або об’єкта класу.
This is often the same as
obj.__annotations__
. In addition, forward references encoded as string literals are handled by evaluating them inglobals
andlocals
namespaces. If necessary,Optional[t]
is added for function and method annotations if a default value equal toNone
is set. For a classC
, return a dictionary constructed by merging all the__annotations__
alongC.__mro__
in reverse order.The function recursively replaces all
Annotated[T, ...]
withT
, unlessinclude_extras
is set toTrue
(seeAnnotated
for more information). For example:class Student(NamedTuple): name: Annotated[str, 'some marker'] get_type_hints(Student) == {'name': str} get_type_hints(Student, include_extras=False) == {'name': str} get_type_hints(Student, include_extras=True) == { 'name': Annotated[str, 'some marker'] }
Змінено в версії 3.9: Added
include_extras
parameter as part of PEP 593.
-
typing.
get_args
(tp)¶
-
typing.
get_origin
(tp)¶ Provide basic introspection for generic types and special typing forms.
For a typing object of the form
X[Y, Z, ...]
these functions returnX
and(Y, Z, ...)
. IfX
is a generic alias for a builtin orcollections
class, it gets normalized to the original class. IfX
is aUnion
orLiteral
contained in another generic type, the order of(Y, Z, ...)
may be different from the order of the original arguments[Y, Z, ...]
due to type caching. For unsupported objects returnNone
and()
correspondingly. Examples:assert get_origin(Dict[str, int]) is dict assert get_args(Dict[int, str]) == (int, str) assert get_origin(Union[int, str]) is Union assert get_args(Union[int, str]) == (int, str)
Нове в версії 3.8.
-
class
typing.
ForwardRef
¶ A class used for internal typing representation of string forward references. For example,
List["SomeClass"]
is implicitly transformed intoList[ForwardRef("SomeClass")]
. This class should not be instantiated by a user, but may be used by introspection tools.Примітка
PEP 585 загальні типи, такі як
list["SomeClass"]
, не будуть неявно перетворені вlist[ForwardRef("SomeClass")]
і, таким чином, не будуть автоматично перетворені вlist[ SomeClass]
.Нове в версії 3.7.4.
Постійний¶
-
typing.
TYPE_CHECKING
¶ A special constant that is assumed to be
True
by 3rd party static type checkers. It isFalse
at runtime. Usage:if TYPE_CHECKING: import expensive_mod def fun(arg: 'expensive_mod.SomeType') -> None: local_var: expensive_mod.AnotherType = other_fun()
Анотація першого типу має бути взята в лапки, що робить її «прямим посиланням», щоб приховати посилання
expensive_mod
від середовища виконання інтерпретатора. Анотації типу для локальних змінних не оцінюються, тому другу анотацію не потрібно брати в лапки.Примітка
Якщо використовується
from __future__ import annotations
, анотації не оцінюються під час визначення функції. Натомість вони зберігаються як рядки в__annotations__
. Це робить непотрібним використання лапок навколо анотації (див. PEP 563).Нове в версії 3.5.2.