> **Источник:** https://python-all.ru/3.11/library/typing.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # [`typing`](https://python-all.ru/3.11/library/typing.html#module-typing) – Поддержка аннотаций типов Новое в версии 3.5. **Исходный код:** [Lib/typing.py](https://python-all.ru/src/3.11/Lib/typing.py) > **Примечание** > > Среда выполнения Python не проверяет аннотации типов функций и переменных. Они могут использоваться сторонними инструментами, такими как [проверщики типов](https://python-all.ru/3.11/glossary.html#term-static-type-checker), IDE, линтеры и т. д. --- Этот модуль предоставляет поддержку аннотаций типов во время выполнения. Оригинальную спецификацию системы аннотаций см. в [**PEP 484**](https://python-all.ru/3.11/library/typing.html). Упрощённое введение в аннотации типов – в [**PEP 483**](https://python-all.ru/3.11/library/typing.html). Функция ниже принимает и возвращает строку и аннотирована следующим образом: ```python def greeting(name: str) -> str: return 'Hello ' + name ``` В функции `greeting` аргумент `name` ожидается типа [`str`](https://python-all.ru/3.11/library/stdtypes.html#str), а возвращаемый тип – [`str`](https://python-all.ru/3.11/library/stdtypes.html#str). Подтипы допускаются в качестве аргументов. Новые функции часто добавляются в модуль `typing`. Пакет [typing\_extensions](https://python-all.ru/3.11/library/typing.html) предоставляет бэкпорты этих новых функций для старых версий Python. Сводку устаревших возможностей и график их устаревания см. в [График устаревания основных возможностей](https://python-all.ru/3.11/library/typing.html#deprecation-timeline-of-major-features). > **См. также** > > **[«Шпаргалка по аннотациям типов»](https://python-all.ru/3.11/library/typing.html)** > > Краткий обзор аннотаций типов (размещён в документации mypy) > > **Раздел «Type System Reference» [документации mypy](https://python-all.ru/3.11/library/typing.html)** > > Система типов Python стандартизирована через PEP, поэтому данное руководство должно в целом подходить для большинства проверщиков типов Python. (Некоторые части могут по-прежнему относиться только к mypy.) > > **[«Статическая типизация в Python»](https://python-all.ru/3.11/library/typing.html)** > > Независимая от проверщика типов документация, написанная сообществом, с подробным описанием возможностей системы типов, полезных инструментов, связанных с типизацией, и лучших практик типизации. ## Соответствующие PEP С момента появления аннотаций типов в [**PEP 484**](https://python-all.ru/3.11/library/typing.html) и [**PEP 483**](https://python-all.ru/3.11/library/typing.html) ряд PEP расширили и улучшили инфраструктуру Python для аннотаций типов: Полный список PEP - **[**PEP 526**](https://python-all.ru/3.11/library/typing.html): Синтаксис аннотаций переменных** *Вводит* синтаксис аннотирования переменных вне определений функций, а также [`ClassVar`](https://python-all.ru/3.11/library/typing.html#typing.ClassVar) - **[**PEP 544**](https://python-all.ru/3.11/library/typing.html): Протоколы: структурная типизация (статическая утиная типизация)** *Вводит* [`Protocol`](https://python-all.ru/3.11/library/typing.html#typing.Protocol) и декоратор [`@runtime_checkable`](https://python-all.ru/3.11/library/typing.html#typing.runtime_checkable) - **[**PEP 585**](https://python-all.ru/3.11/library/typing.html): Обобщённые типы в стандартных коллекциях** *Вводит* [`types.GenericAlias`](https://python-all.ru/3.11/library/types.html#types.GenericAlias) и возможность использовать классы стандартной библиотеки как [обобщённые типы](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias) - **[**PEP 586**](https://python-all.ru/3.11/library/typing.html): Литеральные типы** *Вводит* [`Literal`](https://python-all.ru/3.11/library/typing.html#typing.Literal) - **[**PEP 589**](https://python-all.ru/3.11/library/typing.html): TypedDict: аннотации типов для словарей с фиксированным набором ключей** *Вводит* [`TypedDict`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict) - **[**PEP 591**](https://python-all.ru/3.11/library/typing.html): Добавление квалификатора final в typing** *Вводит* [`Final`](https://python-all.ru/3.11/library/typing.html#typing.Final) и декоратор [`@final`](https://python-all.ru/3.11/library/typing.html#typing.final) - **[**PEP 593**](https://python-all.ru/3.11/library/typing.html): Гибкие аннотации функций и переменных** *Вводит* [`Annotated`](https://python-all.ru/3.11/library/typing.html#typing.Annotated) - **[**PEP 604**](https://python-all.ru/3.11/library/typing.html): Разрешение записи объединённых типов как `X | Y`** *Вводит* [`types.UnionType`](https://python-all.ru/3.11/library/types.html#types.UnionType) и возможность использовать бинарный оператор ИЛИ `|` для обозначения [объединения типов](https://python-all.ru/3.11/library/stdtypes.html#types-union) - **[**PEP 612**](https://python-all.ru/3.11/library/typing.html): Переменные спецификации параметров** *Вводит* [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) и [`Concatenate`](https://python-all.ru/3.11/library/typing.html#typing.Concatenate) - **[**PEP 613**](https://python-all.ru/3.11/library/typing.html): Явные псевдонимы типов** *Вводит* [`TypeAlias`](https://python-all.ru/3.11/library/typing.html#typing.TypeAlias) - **[**PEP 646**](https://python-all.ru/3.11/library/typing.html): Вариативные обобщения** *Вводит* [`TypeVarTuple`](https://python-all.ru/3.11/library/typing.html#typing.TypeVarTuple) - **[**PEP 647**](https://python-all.ru/3.11/library/typing.html): Защитники типов, определяемые пользователем** *Представлен* [`TypeGuard`](https://python-all.ru/3.11/library/typing.html#typing.TypeGuard) - **[**PEP 655**](https://python-all.ru/3.11/library/typing.html): Помечение отдельных элементов TypedDict как обязательных или потенциально отсутствующих** *Представлен* [`Required`](https://python-all.ru/3.11/library/typing.html#typing.Required) и [`NotRequired`](https://python-all.ru/3.11/library/typing.html#typing.NotRequired) - **[**PEP 673**](https://python-all.ru/3.11/library/typing.html): тип Self** *Представлен* [`Self`](https://python-all.ru/3.11/library/typing.html#typing.Self) - **[**PEP 675**](https://python-all.ru/3.11/library/typing.html): произвольный тип литеральной строки** *Представлен* [`LiteralString`](https://python-all.ru/3.11/library/typing.html#typing.LiteralString) - **[**PEP 681**](https://python-all.ru/3.11/library/typing.html): преобразования классов данных** *Представлен* декоратор [`@dataclass_transform`](https://python-all.ru/3.11/library/typing.html#typing.dataclass_transform) ## Псевдонимы типов Псевдоним типа определяется присваиванием типа псевдониму. В этом примере `Vector` и `list[float]` будут рассматриваться как взаимозаменяемые синонимы: ```python Vector = list[float] def scale(scalar: float, vector: Vector) -> Vector: return [scalar * num for num in vector] # проходит проверку типов; список чисел с плавающей точкой считается Vector. new_vector = scale(2.0, [1.0, -4.2, 5.4]) ``` Псевдонимы типов полезны для упрощения сложных сигнатур типов. Например: ```python 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: ... # Статическая проверка типов будет считать предыдущую сигнатуру типа как # полностью эквивалентную этой. def broadcast_message( message: str, servers: Sequence[tuple[tuple[str, int], dict[str, str]]]) -> None: ... ``` Псевдонимы типов могут быть помечены [`TypeAlias`](https://python-all.ru/3.11/library/typing.html#typing.TypeAlias), чтобы явно указать, что это объявление псевдонима типа, а не обычное присваивание переменной: ```python from typing import TypeAlias Vector: TypeAlias = list[float] ``` ## NewType Используйте вспомогательную функцию [`NewType`](https://python-all.ru/3.11/library/typing.html#typing.NewType) для создания отдельных типов: ```python from typing import NewType UserId = NewType('UserId', int) some_id = UserId(524313) ``` Статический проверщик типов будет рассматривать новый тип как подкласс исходного типа. Это полезно для выявления логических ошибок: ```python def get_user_name(user_id: UserId) -> str: ... # проходит проверку типов user_a = get_user_name(UserId(42351)) # не проходит проверку типов; int не является UserId user_b = get_user_name(-1) ``` Можно по-прежнему выполнять все операции `int` над переменной типа `UserId`, но результат всегда будет типа `int`. Это позволяет передавать `UserId` везде, где может ожидаться `int`, но предотвращает случайное создание `UserId` недопустимым способом: ```python # 'output' имеет тип 'int', а не 'UserId' output = UserId(23413) + UserId(54341) ``` Обратите внимание, что эти проверки выполняются только статическим проверщиком типов. Во время выполнения оператор `Derived = NewType('Derived', Base)` сделает `Derived` вызываемым объектом, который немедленно возвращает любой переданный ему параметр. Это означает, что выражение `Derived(some_value)` не создаёт новый класс и не вносит значительных накладных расходов по сравнению с обычным вызовом функции. Точнее, выражение `some_value is Derived(some_value)` во время выполнения всегда истинно. Недопустимо создание подтипа `Derived`: ```python from typing import NewType UserId = NewType('UserId', int) # Завершается ошибкой во время выполнения и не проходит проверку типов class AdminUserId(UserId): pass ``` Однако можно создать [`NewType`](https://python-all.ru/3.11/library/typing.html#typing.NewType) на основе «производного» `NewType`: ```python from typing import NewType UserId = NewType('UserId', int) ProUserId = NewType('ProUserId', UserId) ``` и проверка типов для `ProUserId` будет работать как ожидается. Подробнее см. [**PEP 484**](https://python-all.ru/3.11/library/typing.html). > **Примечание** > > Напомним, что использование псевдонима типа объявляет два типа *эквивалентными* друг другу. Использование `Alias = Original` заставит статический анализатор типов считать `Alias` *точно эквивалентным* `Original` во всех случаях. Это полезно, когда требуется упростить сложные сигнатуры типов. > > В отличие от этого, `NewType` объявляет один тип *подтипом* другого. Использование `Derived = NewType('Derived', Original)` заставит статический анализатор типов считать `Derived` *подклассом* `Original`, что означает, что значение типа `Original` не может использоваться там, где ожидается значение типа `Derived`. Это полезно для предотвращения логических ошибок с минимальными затратами времени выполнения. Новое в версии 3.5.2. Изменено в версии 3.10: `NewType` теперь является классом, а не функцией. В результате имеются некоторые дополнительные расходы во время выполнения при вызове `NewType` по сравнению с обычной функцией. Изменено в версии 3.11: Производительность вызова `NewType` восстановлена до уровня Python 3.9. ## Аннотация вызываемых объектов Функции – или другие [вызываемые](https://python-all.ru/3.11/glossary.html#term-callable) объекты – могут быть аннотированы с помощью [`collections.abc.Callable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Callable) или [`typing.Callable`](https://python-all.ru/3.11/library/typing.html#typing.Callable). `Callable[[int], str]` означает функцию, которая принимает один параметр типа [`int`](https://python-all.ru/3.11/library/functions.html#int) и возвращает [`str`](https://python-all.ru/3.11/library/stdtypes.html#str). Например: ```python from collections.abc import Callable, Awaitable def feeder(get_next_item: Callable[[], str]) -> None: ... # Тело def async_query(on_success: Callable[[int], None], on_error: Callable[[int, Exception], None]) -> None: ... # Тело async def on_update(value: str) -> None: ... # Тело callback: Callable[[str], Awaitable[None]] = on_update ``` Синтаксис индексации всегда должен использоваться ровно с двумя значениями: списком аргументов и типом возвращаемого значения. Список аргументов должен быть списком типов, [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec), [`Concatenate`](https://python-all.ru/3.11/library/typing.html#typing.Concatenate) или многоточием. Тип возвращаемого значения должен быть единственным типом. Если в качестве списка аргументов указано литеральное многоточие `...`, это означает, что принимается вызываемый объект с произвольным списком параметров: ```python def concat(x: str, y: str) -> str: return x + y x: Callable[..., str] x = str # ОК x = concat # Тоже ОК ``` `Callable` не может выражать сложные сигнатуры, такие как функции, принимающие переменное количество аргументов, [перегруженные функции](https://python-all.ru/3.11/library/typing.html#overload) или функции, имеющие только ключевые параметры. Однако эти сигнатуры можно выразить, определив класс [`Protocol`](https://python-all.ru/3.11/library/typing.html#typing.Protocol) с методом [`__call__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__call__): ```python from collections.abc import Iterable from typing import Protocol class Combiner(Protocol): def __call__(self, *vals: bytes, maxlen: int | None = None) -> list[bytes]: ... def batch_proc(data: Iterable[bytes], cb_results: Combiner) -> bytes: for item in data: ... def good_cb(*vals: bytes, maxlen: int | None = None) -> list[bytes]: ... def bad_cb(*vals: bytes, maxitems: int | None) -> list[bytes]: ... batch_proc([], good_cb) # ОК batch_proc([], bad_cb) # Ошибка! Аргумент 2 имеет несовместимый тип из-за # другого имени и вида в колбэке ``` Объекты, принимающие другие вызываемые объекты в качестве аргументов, могут указать, что их типы параметров зависят друг от друга, с помощью [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec). Кроме того, если такой вызываемый объект добавляет или удаляет аргументы из других вызываемых объектов, может использоваться оператор [`Concatenate`](https://python-all.ru/3.11/library/typing.html#typing.Concatenate). Они имеют соответственно форму `Callable[ParamSpecVariable, ReturnType]` и `Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType]`. Changed in version 3.10: `Callable` now supports [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) and [`Concatenate`](https://python-all.ru/3.11/library/typing.html#typing.Concatenate). See [**PEP 612**](https://python-all.ru/3.11/library/typing.html) for more details. > **См. также** > > В документации к [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) и [`Concatenate`](https://python-all.ru/3.11/library/typing.html#typing.Concatenate) приведены примеры использования в `Callable`. ## Обобщённые типы Поскольку информацию о типах объектов, хранящихся в контейнерах, невозможно статически вывести обобщённым способом, многие классы контейнеров в стандартной библиотеке поддерживают индексацию для указания ожидаемых типов элементов контейнера. ```python from collections.abc import Mapping, Sequence class Employee: ... # Sequence[Employee] означает, что все элементы последовательности # должны быть экземплярами "Employee". # Mapping[str, str] означает, что все ключи и все значения в отображении # должны быть строками. def notify_by_email(employees: Sequence[Employee], overrides: Mapping[str, str]) -> None: ... ``` Обобщённые типы можно параметризовать с помощью фабрики, доступной в typing под названием [`TypeVar`](https://python-all.ru/3.11/library/typing.html#typing.TypeVar). ```python from collections.abc import Sequence from typing import TypeVar T = TypeVar('T') # Объявить переменную типа "T" def first(l: Sequence[T]) -> T: # Функция универсальна (обобщена) по TypeVar "T" return l[0] ``` ## Аннотация кортежей Для большинства контейнеров в Python система типов предполагает, что все элементы в контейнере будут одного типа. Например: ```python from collections.abc import Mapping # Проверка типов выведет, что все элементы в ``x`` должны иметь тип int. x: list[int] = [] # Ошибка проверки типов: ``list`` принимает только один аргумент типа: y: list[int, str] = [1, 'foo'] # Проверка типов выведет, что все ключи в ``z`` должны быть строками, # а все значения в ``z`` должны быть строками или int. z: Mapping[str, str | int] = {} ``` [`list`](https://python-all.ru/3.11/library/stdtypes.html#list) принимает только один аргумент типа, поэтому анализатор типов выдал бы ошибку на присваивании `y` выше. Аналогично, [`Mapping`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Mapping) принимает только два аргумента типа: первый указывает тип ключей, а второй – тип значений. Однако, в отличие от большинства других контейнеров Python, в идиоматическом коде Python часто встречаются кортежи, элементы которых не все одного типа. По этой причине кортежи обрабатываются особым образом в системе типов Python. [`tuple`](https://python-all.ru/3.11/library/stdtypes.html#tuple) принимает *любое количество* аргументов типа: ```python # OK: ``x`` присваивается кортежу длины 1, единственный элемент которого – int. x: tuple[int] = (5,) # OK: ``y`` присваивается кортежу длины 2; # элемент 1 – int, элемент 2 – str. y: tuple[int, str] = (5, "foo") # Ошибка: аннотация типа указывает на кортеж длины 1, # но ``z`` был присвоен кортеж длины 3. z: tuple[int] = (1, 2, 3) ``` Для обозначения кортежа, который может быть *любой* длины, и в котором все элементы одного типа `T`, используйте `tuple[T, ...]`. Для обозначения пустого кортежа используйте `tuple[()]`. Использование простого `tuple` в качестве аннотации эквивалентно использованию `tuple[Any, ...]`: ```python x: tuple[int, ...] = (1, 2) # Эти переприсваивания OK: ``tuple[int, ...]`` указывает, что x может быть любой длины. x = (1, 2, 3) x = () # Это переприсваивание – ошибка: все элементы в ``x`` должны быть int. x = ("foo", "bar") # ``y`` может быть присвоен только пустому кортежу. y: tuple[()] = () z: tuple = ("foo", "bar") # Эти переприсваивания OK: простой ``tuple`` эквивалентен ``tuple[Any, ...]``. z = (1, 2, 3) z = () ``` ## Тип объектов классов Переменная, аннотированная `C`, может принимать значение типа `C`. Напротив, переменная, аннотированная `type[C]` (или [`typing.Type[C]`](https://python-all.ru/3.11/library/typing.html#typing.Type)), может принимать значения, которые сами являются классами – в частности, она будет принимать *объект класса* `C`. Например: ```python a = 3 # Имеет тип ``int``. b = int # Имеет тип ``type[int]``. c = type(a) # Также имеет тип ``type[int]``. ``` Обратите внимание, что `type[C]` ковариантен: ```python class User: ... class ProUser(User): ... class TeamUser(User): ... def make_new_user(user_class: type[User]) -> User: # ... return user_class() make_new_user(User) # ОК make_new_user(ProUser) # Также OK: ``type[ProUser]`` – подтип ``type[User]``. make_new_user(TeamUser) # По-прежнему допустимо. make_new_user(User()) # Ошибка: ожидался ``type[User]``, но получен ``User``. make_new_user(int) # Ошибка: ``type[int]`` не является подтипом ``type[User]``. ``` Единственными допустимыми параметрами для [`type`](https://python-all.ru/3.11/library/functions.html#type) являются классы, [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any), [переменные типа](https://python-all.ru/3.11/library/typing.html#generics) и объединения любых из этих типов. Например: ```python def new_non_team_user(user_class: type[BasicUser | ProUser]): ... new_non_team_user(BasicUser) # ОК new_non_team_user(ProUser) # ОК new_non_team_user(TeamUser) # Ошибка: ``type[TeamUser]`` не является подтипом # ``type[BasicUser | ProUser]``. new_non_team_user(User) # Тоже ошибка. ``` `type[Any]` эквивалентно [`type`](https://python-all.ru/3.11/library/functions.html#type), который является корнем [иерархии метаклассов](https://python-all.ru/3.11/reference/datamodel.html#metaclasses) Python. ## Пользовательские обобщённые типы Пользовательский класс можно определить как обобщённый класс. ```python 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]` в качестве базового класса определяет, что класс `LoggedVar` принимает один параметр типа `T`. Это также делает `T` допустимым типом внутри тела класса. Базовый класс [`Generic`](https://python-all.ru/3.11/library/typing.html#typing.Generic) определяет [`__class_getitem__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__class_getitem__) так, что `LoggedVar[T]` является допустимым типом: ```python from collections.abc import Iterable def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None: for var in vars: var.set(0) ``` Обобщённый тип может иметь любое количество переменных типа. Все разновидности [`TypeVar`](https://python-all.ru/3.11/library/typing.html#typing.TypeVar) допустимы в качестве параметров обобщённого типа: ```python 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`](https://python-all.ru/3.11/library/typing.html#typing.Generic) должен быть уникальным. Поэтому такой код некорректен: ```python from typing import TypeVar, Generic ... T = TypeVar('T') class Pair(Generic[T, T]): # INVALID ... ``` Можно использовать множественное наследование с [`Generic`](https://python-all.ru/3.11/library/typing.html#typing.Generic): ```python from collections.abc import Sized from typing import TypeVar, Generic T = TypeVar('T') class LinkedList(Sized, Generic[T]): ... ``` При наследовании от обобщённых классов некоторые параметры типа могут быть фиксированными: ```python from collections.abc import Mapping from typing import TypeVar T = TypeVar('T') class MyDict(Mapping[str, T]): ... ``` В этом случае `MyDict` имеет один параметр – `T`. Использование обобщённого класса без указания параметров типа подразумевает [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) для каждой позиции. В следующем примере `MyIterable` не является обобщённым, но неявно наследуется от `Iterable[Any]`: ```python from collections.abc import Iterable class MyIterable(Iterable): # То же, что и Iterable[Any]. ... ``` Также поддерживаются пользовательские псевдонимы обобщённых типов. Примеры: ```python from collections.abc import Iterable from typing import TypeVar S = TypeVar('S') Response = Iterable[S] | int # Тип возвращаемого значения здесь такой же, как 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: # То же, что и Iterable[tuple[T, T]] return sum(x*y for x, y in v) ``` Изменено в версии 3.7: [`Generic`](https://python-all.ru/3.11/library/typing.html#typing.Generic) больше не имеет собственного метакласса. Пользовательские обобщённые типы для выражений параметров также поддерживаются через переменные спецификации параметров в форме `Generic[P]`. Поведение согласуется с описанными выше переменными типов, так как переменные спецификации параметров обрабатываются модулем typing как специализированные переменные типов. Единственное исключение состоит в том, что список типов может использоваться для подстановки [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec): ```python >>> from typing import Generic, ParamSpec, TypeVar >>> T = TypeVar('T') >>> P = ParamSpec('P') >>> class Z(Generic[T, P]): ... ... >>> Z[int, [dict, float]] __main__.Z[int, (, )] ``` Кроме того, обобщённый (generic) с единственной переменной спецификации параметра будет принимать списки параметров в виде `X[[Type1, Type2, ...]]`, а также `X[Type1, Type2, ...]` из эстетических соображений. Внутренне последний преобразуется в первый, поэтому следующие эквивалентны: ```python >>> class X(Generic[P]): ... ... >>> X[int, str] __main__.X[(, )] >>> X[[int, str]] __main__.X[(, )] ``` Обратите внимание: обобщения с [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) могут не иметь корректного `__parameters__` после подстановки в некоторых случаях, поскольку они предназначены в первую очередь для статической проверки типов. Изменено в версии 3.10: [`Generic`](https://python-all.ru/3.11/library/typing.html#typing.Generic) теперь можно параметризовать по выражениям параметров. Подробнее см. [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) и [**PEP 612**](https://python-all.ru/3.11/library/typing.html). Пользовательский обобщённый класс может иметь ABC в качестве базовых классов без конфликта метаклассов. Обобщённые метаклассы не поддерживаются. Результат параметризации обобщённых типов кэшируется, и большинство типов в модуле typing являются [хэшируемыми](https://python-all.ru/3.11/glossary.html#term-hashable) и сравнимыми на равенство. ## Тип [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) Особым видом типа является [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any). Статический проверяющий типов будет считать каждый тип совместимым с [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any), а [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) – совместимым с каждым типом. Это означает, что над значением типа [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) можно выполнять любые операции или вызовы методов и присваивать его любой переменной: ```python from typing import Any a: Any = None a = [] # ОК a = 2 # ОК s: str = '' s = a # ОК def foo(item: Any) -> int: # Проходит проверку типов; 'item' может быть любого типа, # и этот тип может иметь метод 'bar' item.bar() ... ``` Обратите внимание: при присваивании значения типа [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) более точному типу проверка типов не выполняется. Например, статический анализатор типов не сообщил об ошибке при присваивании `a` переменной `s`, хотя `s` была объявлена как тип [`str`](https://python-all.ru/3.11/library/stdtypes.html#str) и во время выполнения получает значение [`int`](https://python-all.ru/3.11/library/functions.html#int)! Кроме того, все функции без указания типа возврата или типов параметров по умолчанию неявно используют [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any): ```python def legacy_parser(text): ... return data # Статический проверщик типов будет рассматривать вышеприведенное # как имеющее ту же сигнатуру, что и: def legacy_parser(text: Any) -> Any: ... return data ``` Такое поведение позволяет использовать [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) в качестве *запасного выхода*, когда нужно смешивать динамически и статически типизированный код. Сравните поведение [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) с поведением [`object`](https://python-all.ru/3.11/library/functions.html#object). Как и [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any), каждый тип является подтипом [`object`](https://python-all.ru/3.11/library/functions.html#object). Однако, в отличие от [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any), обратное неверно: [`object`](https://python-all.ru/3.11/library/functions.html#object) *не* является подтипом любого другого типа. Это означает, что когда тип значения – [`object`](https://python-all.ru/3.11/library/functions.html#object), проверяющий типы будет отклонять почти все операции над ним, а присваивание его переменной (или использование в качестве возвращаемого значения) более специализированного типа является ошибкой типа. Например: ```python def hash_a(item: object) -> int: # Не проходит проверку типов; у объекта нет метода 'magic'. item.magic() ... def hash_b(item: Any) -> int: # Проходит проверку типов item.magic() ... # Проходит проверку типов, так как int и str являются подклассами object hash_a(42) hash_a("foo") # Проходит проверку типов, так как Any совместим со всеми типами hash_b(42) hash_b("foo") ``` Используйте [`object`](https://python-all.ru/3.11/library/functions.html#object), чтобы указать, что значение может быть любого типа в типобезопасной манере. Используйте [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any), чтобы указать, что значение динамически типизировано. ## Номинальная и структурная типизация Изначально [**PEP 484**](https://python-all.ru/3.11/library/typing.html) определял систему статической типизации Python как использующую *номинальное подтипирование*. Это означает, что класс `A` разрешён там, где ожидается класс `B`, если и только если `A` является подклассом `B`. Ранее это требование также применялось к абстрактным базовым классам, таким как [`Iterable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Iterable). Проблема такого подхода в том, что класс должен быть явно помечен для их поддержки, что непитонично и не похоже на то, что обычно делается в идиоматическом динамически типизированном коде Python. Например, следующее соответствует [**PEP 484**](https://python-all.ru/3.11/library/typing.html): ```python from collections.abc import Sized, Iterable, Iterator class Bucket(Sized, Iterable[int]): ... def __len__(self) -> int: ... def __iter__(self) -> Iterator[int]: ... ``` [**PEP 544**](https://python-all.ru/3.11/library/typing.html) позволяет решить эту проблему, разрешая пользователям писать приведённый выше код без явных базовых классов в определении класса, что позволяет `Bucket` неявно считаться подтипом как `Sized`, так и `Iterable[int]` статическими проверяющими типов. Это называется *структурной подтипизацией* (или статической утиной типизацией): ```python from collections.abc import Iterator, Iterable class Bucket: # Примечание: базовые классы отсутствуют ... def __len__(self) -> int: ... def __iter__(self) -> Iterator[int]: ... def collect(items: Iterable[int]) -> int: ... result = collect(Bucket()) # Проходит проверку типов ``` Более того, наследуя специальный класс [`Protocol`](https://python-all.ru/3.11/library/typing.html#typing.Protocol), пользователь может определять новые пользовательские протоколы, чтобы в полной мере использовать структурное подтипирование (см. примеры ниже). ## Содержимое модуля Модуль `typing` определяет следующие классы, функции и декораторы. ### Специальные примитивы типизации #### Специальные типы Их можно использовать в качестве типов в аннотациях. Они не поддерживают подписку с помощью `[]`. #### `typing.Any` Специальный тип, указывающий на неограниченный тип. - Каждый тип совместим с [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any). - [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) совместим с каждым типом. Изменено в версии 3.11: [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) теперь можно использовать в качестве базового класса. Это может быть полезно для предотвращения ошибок проверки типов в классах, которые могут использовать утиную типизацию где угодно или являются сильно динамичными. #### `typing.AnyStr` [Ограниченная переменная типа](https://python-all.ru/3.11/library/typing.html#typing-constrained-typevar). Определение: ```python AnyStr = TypeVar('AnyStr', str, bytes) ``` `AnyStr` предназначен для функций, которые могут принимать аргументы типа [`str`](https://python-all.ru/3.11/library/stdtypes.html#str) или [`bytes`](https://python-all.ru/3.11/library/stdtypes.html#bytes), но не допускают их смешивания. Например: ```python def concat(a: AnyStr, b: AnyStr) -> AnyStr: return a + b concat("foo", "bar") # OK, результат имеет тип 'str' concat(b"foo", b"bar") # OK, результат имеет тип 'bytes' concat("foo", b"bar") # Ошибка, нельзя смешивать str и bytes ``` Обратите внимание, что, несмотря на название, `AnyStr` не имеет никакого отношения к типу [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any) и не означает «любая строка». В частности, `AnyStr` и `str | bytes` отличаются друг от друга и имеют разные сценарии использования: ```python # Неверное использование AnyStr: # Переменная типа используется только один раз в сигнатуре функции, # поэтому не может быть «решена» проверщиком типов def greet_bad(cond: bool) -> AnyStr: return "hi there!" if cond else b"greetings!" # Лучший способ аннотировать эту функцию: def greet_proper(cond: bool) -> str | bytes: return "hi there!" if cond else b"greetings!" ``` #### `typing.LiteralString` Специальный тип, включающий только строковые литералы. Любой строковый литерал совместим с `LiteralString`, как и другой `LiteralString`. Однако объект, типизированный просто как `str`, – нет. Строка, созданная композицией объектов типа `LiteralString`, также приемлема как `LiteralString`. Пример: ```python def run_query(sql: LiteralString) -> None: ... def caller(arbitrary_string: str, literal_string: LiteralString) -> None: run_query("SELECT * FROM students") # ОК run_query(literal_string) # ОК run_query("SELECT * FROM " + literal_string) # ОК run_query(arbitrary_string) # ошибка проверки типов run_query( # ошибка проверки типов f"SELECT * FROM students WHERE name = {arbitrary_string}" ) ``` `LiteralString` полезен для чувствительных API, где произвольные пользовательские строки могут создавать проблемы. Например, два приведённых выше случая, которые вызывают ошибки проверки типов, могут быть уязвимы для SQL-инъекций. Подробнее см. [**PEP 675**](https://python-all.ru/3.11/library/typing.html). Новое в версии 3.11. #### `typing.Never` [Нижний тип](https://python-all.ru/3.11/library/typing.html) – тип, не имеющий членов. Это можно использовать для определения функции, которая никогда не должна вызываться, или функции, которая никогда не возвращает результат: ```python from typing import Never def never_call_me(arg: Never) -> None: pass def int_or_str(arg: int | str) -> None: never_call_me(arg) # ошибка проверки типов match arg: case int(): print("It's an int") case str(): print("It's a str") case _: never_call_me(arg) # OK, аргумент имеет тип Never ``` Новое в версии 3.11: В более старых версиях Python для выражения той же концепции может использоваться [`NoReturn`](https://python-all.ru/3.11/library/typing.html#typing.NoReturn). `Never` был добавлен, чтобы сделать предполагаемый смысл более явным. #### `typing.NoReturn` Специальный тип, указывающий, что функция никогда не возвращает результат. Например: ```python from typing import NoReturn def stop() -> NoReturn: raise RuntimeError('no way') ``` `NoReturn` также может использоваться как [нижний тип](https://python-all.ru/3.11/library/typing.html), тип, не имеющий значений. Начиная с Python 3.11, для этой концепции следует использовать тип [`Never`](https://python-all.ru/3.11/library/typing.html#typing.Never). Инструменты проверки типов должны считать их эквивалентными. Новое в версии 3.6.2. #### `typing.Self` Специальный тип для представления текущего вложенного класса. Например: ```python from typing import Self, reveal_type class Foo: def return_self(self) -> Self: ... return self class SubclassOfFoo(Foo): pass reveal_type(Foo().return_self()) # Раскрытый тип – "Foo" reveal_type(SubclassOfFoo().return_self()) # Раскрытый тип – "SubclassOfFoo" ``` Эта аннотация семантически эквивалентна следующему, хотя и в более краткой форме: ```python from typing import TypeVar Self = TypeVar("Self", bound="Foo") class Foo: def return_self(self: Self) -> Self: ... return self ``` В общем случае, если что-то возвращает `self`, как в примерах выше, следует использовать `Self` в качестве аннотации возвращаемого типа. Если `Foo.return_self` был аннотирован как возвращающий `"Foo"`, то анализатор типов выведет, что объект, возвращённый из `SubclassOfFoo.return_self`, имеет тип `Foo` , а не `SubclassOfFoo`. Другие распространённые случаи использования включают: - [`classmethod`](https://python-all.ru/3.11/library/functions.html#classmethod), которые используются как альтернативные конструкторы и возвращают экземпляры параметра `cls`. - Аннотирование метода [`__enter__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__enter__), который возвращает self. Не следует использовать `Self` в качестве аннотации возвращаемого типа, если метод не гарантирует возврат экземпляра подкласса при наследовании класса: ```python class Eggs: # Self здесь была бы некорректной аннотацией возврата, # так как возвращаемый объект всегда является экземпляром Eggs, # даже в подклассах. def returns_eggs(self) -> "Eggs": return Eggs() ``` См. [**PEP 673**](https://python-all.ru/3.11/library/typing.html) для получения дополнительных сведений. Новое в версии 3.11. #### `typing.TypeAlias` Специальная аннотация для явного объявления [псевдонима типа](https://python-all.ru/3.11/library/typing.html#type-aliases). Например: ```python from typing import TypeAlias Factors: TypeAlias = list[int] ``` `TypeAlias` особенно полезен для аннотирования псевдонимов, использующих прямые ссылки, поскольку средствам проверки типов может быть трудно отличить их от обычных присваиваний переменных: ```python from typing import Generic, TypeAlias, TypeVar T = TypeVar("T") # "Box" ещё не существует, # поэтому для прямой ссылки приходится использовать кавычки. # Использование ``TypeAlias`` сообщает тайпчекеру, что это объявление псевдонима типа, # а не присваивание переменной строкового значения. BoxOfStrings: TypeAlias = "Box[str]" class Box(Generic[T]): @classmethod def make_box_of_strings(cls) -> BoxOfStrings: ... ``` См. [**PEP 613**](https://python-all.ru/3.11/library/typing.html) для получения дополнительных сведений. Новое в версии 3.10. #### Специальные формы Их можно использовать в качестве типов в аннотациях. Они все поддерживают индексацию с помощью `[]`, но каждый из них имеет уникальный синтаксис. #### `typing.Union` Тип объединения; `Union[X, Y]` эквивалентно `X | Y` и означает X или Y. Для определения объединения используйте, например, `Union[int, str]` или сокращённую запись `int | str`. Рекомендуется использовать сокращённую запись. Подробности: - Аргументы должны быть типами, и их должно быть как минимум один. - Объединения объединений разворачиваются, например: ```python Union[Union[int, str], float] == Union[int, str, float] ``` - Объединения из одного аргумента исчезают, например: ```python Union[int] == int # Конструктор на самом деле возвращает int ``` - Повторяющиеся аргументы пропускаются, например: ```python Union[int, str, int] == Union[int, str] == int | str ``` - При сравнении объединений порядок аргументов игнорируется, например: ```python Union[int, str] == Union[str, int] ``` - Нельзя наследовать или создавать экземпляр `Union`. - Нельзя записать `Union[X][Y]`. Изменено в версии 3.7: Явные подклассы не удаляются из объединений во время выполнения. Изменено в версии 3.10: Объединения теперь можно записывать как `X | Y`. См. [выражения типов объединений](https://python-all.ru/3.11/library/stdtypes.html#types-union). #### `typing.Optional` `Optional[X]` эквивалентен `X | None` (или `Union[X, None]`). Обратите внимание, что это не то же самое, что необязательный аргумент, который имеет значение по умолчанию. Необязательный аргумент с значением по умолчанию не требует квалификатора `Optional` в своей аннотации типа только потому, что он необязателен. Например: ```python def foo(arg: int = 0) -> None: ... ``` С другой стороны, если явное значение `None` допускается, то использование `Optional` уместно, независимо от того, является ли аргумент необязательным или нет. Например: ```python def foo(arg: Optional[int] = None) -> None: ... ``` Изменено в версии 3.10: Optional теперь можно записывать как `X | None`. См. [выражения типов объединений](https://python-all.ru/3.11/library/stdtypes.html#types-union). #### `typing.Concatenate` Специальная форма для аннотирования функций высшего порядка. `Concatenate` может использоваться совместно с [Callable](https://python-all.ru/3.11/library/typing.html#annotating-callables) и [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) для аннотации вызываемого объекта высшего порядка, который добавляет, удаляет или преобразует параметры другого вызываемого объекта. Использование имеет форму `Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]`. `Concatenate` в настоящее время допустим только в качестве первого аргумента [Callable](https://python-all.ru/3.11/library/typing.html#annotating-callables). Последний параметр `Concatenate` должен быть [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) или многоточием (`...`). Например, чтобы аннотировать декоратор `with_lock`, который предоставляет [`threading.Lock`](https://python-all.ru/3.11/library/threading.html#threading.Lock) декорируемой функции, можно использовать `Concatenate`, чтобы указать, что `with_lock` ожидает вызываемый объект, который принимает `Lock` в качестве первого аргумента, и возвращает вызываемый объект с другой сигнатурой типа. В этом случае [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) указывает на то, что типы параметров возвращаемого вызываемого объекта зависят от типов параметров передаваемого вызываемого объекта: ```python from collections.abc import Callable from threading import Lock from typing import Concatenate, ParamSpec, TypeVar P = ParamSpec('P') R = TypeVar('R') # Используйте эту блокировку, чтобы гарантировать, что только один поток выполняет функцию # в любой момент времени. my_lock = Lock() def with_lock(f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]: '''Типобезопасный декоратор, предоставляющий блокировку.''' def inner(*args: P.args, **kwargs: P.kwargs) -> R: # Передайте блокировку в качестве первого аргумента. return f(my_lock, *args, **kwargs) return inner @with_lock def sum_threadsafe(lock: Lock, numbers: list[float]) -> float: '''Складывайте список чисел потокобезопасным способом.''' with lock: return sum(numbers) # Нам не нужно передавать блокировку вручную благодаря декоратору. sum_threadsafe([1.1, 2.2, 3.3]) ``` Новое в версии 3.10. > **См. также** > > - [**PEP 612**](https://python-all.ru/3.11/library/typing.html) – Переменные спецификации параметров (PEP, в котором были введены `ParamSpec` и `Concatenate`) > - [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) > - [Аннотация вызываемых объектов](https://python-all.ru/3.11/library/typing.html#annotating-callables) #### `typing.Literal` Специальная форма типизации для определения «литеральных типов». `Literal` можно использовать, чтобы указать проверяющим типа, что аннотированный объект имеет значение, эквивалентное одному из предоставленных литералов. Например: ```python def validate_simple(data: Any) -> Literal[True]: # всегда возвращает True ... Mode: TypeAlias = Literal['r', 'rb', 'w', 'wb'] def open_helper(file: str, mode: Mode) -> str: ... open_helper('/some/path', 'r') # Проходит проверку типов open_helper('/other/path', 'typo') # Ошибка в тайпчекере ``` `Literal[...]` нельзя наследовать. Во время выполнения произвольное значение допускается в качестве аргумента типа для `Literal[...]`, но проверяющие типа могут накладывать ограничения. См. [**PEP 586**](https://python-all.ru/3.11/library/typing.html) для получения дополнительных сведений о литеральных типах. Новое в версии 3.8. Изменено в версии 3.9.1: `Literal` теперь дедуплицирует параметры. Сравнения на равенство объектов `Literal` больше не зависят от порядка. Объекты `Literal` теперь будут вызывать исключение [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError) при сравнении на равенство, если один из их параметров не является [хешируемым](https://python-all.ru/3.11/glossary.html#term-hashable). #### `typing.ClassVar` Специальная конструкция типа для пометки переменных класса. Как представлено в [**PEP 526**](https://python-all.ru/3.11/library/typing.html), аннотация переменной, обёрнутая в ClassVar, указывает, что данный атрибут предназначен для использования в качестве переменной класса и не должен устанавливаться на экземплярах этого класса. Использование: ```python class Starship: stats: ClassVar[dict[str, int]] = {} # переменная класса damage: int = 10 # переменная экземпляра ``` [`ClassVar`](https://python-all.ru/3.11/library/typing.html#typing.ClassVar) принимает только типы и не может быть дополнительно индексирован. [`ClassVar`](https://python-all.ru/3.11/library/typing.html#typing.ClassVar) сам по себе не является классом и не должен использоваться с [`isinstance()`](https://python-all.ru/3.11/library/functions.html#isinstance) или [`issubclass()`](https://python-all.ru/3.11/library/functions.html#issubclass). [`ClassVar`](https://python-all.ru/3.11/library/typing.html#typing.ClassVar) не меняет поведение Python во время выполнения, но может использоваться сторонними проверяющими типов. Например, проверяющий типов может отметить следующий код как ошибочный: ```python enterprise_d = Starship(3000) enterprise_d.stats = {} # Ошибка: установка переменной класса на экземпляре Starship.stats = {} # Это корректно. ``` Новое в версии 3.5.3. #### `typing.Final` Специальная конструкция типизации для указания проверяющим типам, что имена являются финальными. Финальные имена нельзя переназначать ни в какой области видимости. Финальные имена, объявленные в области класса, нельзя переопределять в подклассах. Например: ```python MAX_SIZE: Final = 9000 MAX_SIZE += 1 # Ошибка, выдаваемая проверщиком типов class Connection: TIMEOUT: Final[int] = 10 class FastConnector(Connection): TIMEOUT = 1 # Ошибка, выдаваемая проверщиком типов ``` Проверка этих свойств во время выполнения не выполняется. Подробнее см. [**PEP 591**](https://python-all.ru/3.11/library/typing.html). Новое в версии 3.8. #### `typing.Required` Специальная конструкция типизации для пометки ключа [`TypedDict`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict) как обязательного. В основном это полезно для `total=False` TypedDict. Подробнее см. [`TypedDict`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict) и [**PEP 655**](https://python-all.ru/3.11/library/typing.html). Новое в версии 3.11. #### `typing.NotRequired` Специальная конструкция типизации для пометки ключа [`TypedDict`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict) как потенциально отсутствующего. Подробнее см. [`TypedDict`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict) и [**PEP 655**](https://python-all.ru/3.11/library/typing.html). Новое в версии 3.11. #### `typing.Annotated` Специальная форма типизации для добавления контекстно-зависимых метаданных к аннотации. Добавляет метаданные `x` к заданному типу `T` с помощью аннотации `Annotated[T, x]`. Метаданные, добавленные с помощью `Annotated`, могут использоваться инструментами статического анализа или во время выполнения. Во время выполнения метаданные хранятся в атрибуте `__metadata__`. Если библиотека или инструмент встречает аннотацию `Annotated[T, x]` и не имеет специальной логики для метаданных, он должен игнорировать метаданные и просто рассматривать аннотацию как `T`. Таким образом, `Annotated` может быть полезна для кода, который хочет использовать аннотации для целей, выходящих за рамки системы статической типизации Python. Использование `Annotated[T, x]` в качестве аннотации по-прежнему допускает статическую проверку типов для `T`, поскольку проверяющие типы просто игнорируют метаданные `x`. Таким образом, `Annotated` отличается от декоратора [`@no_type_check`](https://python-all.ru/3.11/library/typing.html#typing.no_type_check), который также можно использовать для добавления аннотаций за пределами системы типизации, но полностью отключает проверку типов для функции или класса. Ответственность за интерпретацию метаданных лежит на инструменте или библиотеке, встречающей аннотацию `Annotated`. Инструмент или библиотека, встречающие тип `Annotated`, могут просмотреть элементы метаданных, чтобы определить, представляют ли они интерес (например, с помощью [`isinstance()`](https://python-all.ru/3.11/library/functions.html#isinstance)). #### `Annotated[, ]` Вот пример того, как можно использовать `Annotated` для добавления метаданных к аннотациям типов при выполнении анализа диапазонов: ```python @dataclass class ValueRange: lo: int hi: int T1 = Annotated[int, ValueRange(-10, 5)] T2 = Annotated[T1, ValueRange(-20, 3)] ``` Подробности синтаксиса: - Первый аргумент `Annotated` должен быть допустимым типом - Можно указать несколько элементов метаданных (`Annotated` поддерживает вариативные аргументы): ```python @dataclass class ctype: kind: str Annotated[int, ValueRange(3, 10), ctype("char")] ``` Инструмент, потребляющий аннотации, сам решает, разрешено ли клиенту добавлять несколько элементов метаданных к одной аннотации и как объединять эти аннотации. - `Annotated` должен индексироваться как минимум двумя аргументами ( `Annotated[int]` недопустимо) - Порядок элементов метаданных сохраняется и важен для проверки равенства: ```python assert Annotated[int, ValueRange(3, 10), ctype("char")] != Annotated[ int, ctype("char"), ValueRange(3, 10) ] ``` - Вложенные типы `Annotated` уплощаются. Порядок элементов метаданных начинается с самой внутренней аннотации: ```python assert Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[ int, ValueRange(3, 10), ctype("char") ] ``` - Дублирующиеся элементы метаданных не удаляются: ```python assert Annotated[int, ValueRange(3, 10)] != Annotated[ int, ValueRange(3, 10), ValueRange(3, 10) ] ``` - `Annotated` можно использовать с вложенными и обобщёнными псевдонимами: ```python @dataclass class MaxLen: value: int T = TypeVar("T") Vec: TypeAlias = Annotated[list[tuple[T, T]], MaxLen(10)] assert Vec[int] == Annotated[list[tuple[int, int]], MaxLen(10)] ``` - `Annotated` нельзя использовать с распакованным [`TypeVarTuple`](https://python-all.ru/3.11/library/typing.html#typing.TypeVarTuple): ```python Variadic: TypeAlias = Annotated[*Ts, Ann1] # НЕДОПУСТИМО ``` Это будет эквивалентно: ```python Annotated[T1, T2, T3, ..., Ann1] ``` где `T1`, `T2` и т.д. являются [`TypeVars`](https://python-all.ru/3.11/library/typing.html#typing.TypeVar). Это было бы недопустимо: в Annotated следует передавать только один тип. - По умолчанию [`get_type_hints()`](https://python-all.ru/3.11/library/typing.html#typing.get_type_hints) удаляет метаданные из аннотаций. Передайте `include_extras=True`, чтобы сохранить метаданные: ```pycon >>> from typing import Annotated, get_type_hints >>> def func(x: Annotated[int, "metadata"]) -> None: pass ... >>> get_type_hints(func) {'x': , 'return': } >>> get_type_hints(func, include_extras=True) {'x': typing.Annotated[int, 'metadata'], 'return': } ``` - Во время выполнения метаданные, связанные с типом `Annotated`, можно получить через атрибут `__metadata__`: ```pycon >>> from typing import Annotated >>> X = Annotated[int, "very", "important", "metadata"] >>> X typing.Annotated[int, 'very', 'important', 'metadata'] >>> X.__metadata__ ('very', 'important', 'metadata') ``` > **См. также** > > **[**PEP 593**](https://python-all.ru/3.11/library/typing.html) – Гибкие аннотации функций и переменных** > > PEP, вводящий `Annotated` в стандартную библиотеку. Новое в версии 3.9. #### `typing.TypeGuard` Специальная конструкция типов для пометки пользовательских функций-охранников типа. `TypeGuard` можно использовать для аннотации возвращаемого типа пользовательской функции-охранника типа. `TypeGuard` принимает только один аргумент типа. Во время выполнения функции, отмеченные таким образом, должны возвращать логическое значение. `TypeGuard` направлен на использование *сужения типа* – метода, используемого статическими проверками типов для определения более точного типа выражения в потоке кода программы. Обычно сужение типа выполняется путем анализа условного потока кода и применения сужения к блоку кода. Условное выражение в этом случае иногда называют «охранником типа»: ```python def is_str(val: str | float): # защита типа "isinstance" if isinstance(val, str): # Тип ``val`` сужается до ``str`` ... else: # Иначе тип ``val`` сужается до ``float``. ... ``` Иногда бывает удобно использовать пользовательскую логическую функцию в качестве охранника типа. Такая функция должна использовать `TypeGuard[...]` в качестве своего возвращаемого типа, чтобы предупредить статические проверки типов об этом намерении. Использование `-> TypeGuard` сообщает статическому анализатору типов, что для данной функции: 1. Возвращаемое значение – boolean. 2. Если возвращаемое значение – `True`, то тип аргумента – это тип внутри `TypeGuard`. Например: ```python def is_str_list(val: list[object]) -> TypeGuard[list[str]]: '''Определяет, все ли объекты в списке являются строками''' return all(isinstance(x, str) for x in val) def func1(val: list[object]): if is_str_list(val): # Тип ``val`` сужается до ``list[str]``. print(" ".join(val)) else: # Тип ``val`` остаётся как ``list[object]``. print("Not a list of strings!") ``` Если `is_str_list` является методом класса или экземпляра, то тип в `TypeGuard` соответствует типу второго параметра после `cls` или `self`. Короче говоря, форма `def foo(arg: TypeA) -> TypeGuard[TypeB]: ...` означает, что если `foo(arg)` возвращает `True`, то `arg` сужается с `TypeA` до `TypeB`. > **Примечание** > > `TypeB` не обязательно должен быть более узкой формой `TypeA` – он может быть даже более широкой формой. Основная причина – допускать такие ситуации, как сужение `list[object]` до `list[str]`, даже если последний не является подтипом первого, поскольку `list` инвариантен. Ответственность за написание типобезопасных охранников типа возлагается на пользователя. `TypeGuard` также работает с переменными типа. См. [**PEP 647**](https://python-all.ru/3.11/library/typing.html) для подробностей. Новое в версии 3.10. #### `typing.Unpack` Оператор typing для концептуальной пометки объекта как распакованного. Например, использование оператора распаковки `*` для [кортежа переменных типа](https://python-all.ru/3.11/library/typing.html#typevartuple) эквивалентно использованию `Unpack`, чтобы пометить кортеж переменных типа как распакованный: ```python Ts = TypeVarTuple('Ts') tup: tuple[*Ts] # Фактически делает: tup: tuple[Unpack[Ts]] ``` На самом деле, `Unpack` и `*` можно использовать взаимозаменяемо в контексте типов [`typing.TypeVarTuple`](https://python-all.ru/3.11/library/typing.html#typing.TypeVarTuple) и [`builtins.tuple`](https://python-all.ru/3.11/library/stdtypes.html#tuple). В старых версиях Python можно встретить явное использование `Unpack`, когда `*` нельзя было применять в определённых местах: ```python # В старых версиях Python TypeVarTuple и Unpack # находятся в пакете обратной совместимости `typing_extensions`. from typing_extensions import TypeVarTuple, Unpack Ts = TypeVarTuple('Ts') tup: tuple[*Ts] # Синтаксическая ошибка на Python <= 3.10! tup: tuple[Unpack[Ts]] # Семантически эквивалентно и обратно совместимо ``` Новое в версии 3.11. #### Построение обобщённых типов Следующие классы не следует использовать напрямую в качестве аннотаций. Их предназначение – быть строительными блоками для создания обобщённых типов. #### `class typing.Generic` Абстрактный базовый класс для обобщённых типов. Обобщённый тип обычно объявляется наследованием от экземпляра этого класса с одной или несколькими переменными типа. Например, обобщённый тип отображения может быть определён так: ```python class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # И т.д. ``` Затем этот класс можно использовать следующим образом: ```python 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(name, *constraints, bound=None, covariant=False, contravariant=False)` Переменная типа. Использование: ```python T = TypeVar('T') # Может быть чем угодно S = TypeVar('S', bound=str) # Может быть любым подтипом str A = TypeVar('A', str, bytes) # Должно быть ровно str или bytes ``` Переменные типа существуют в первую очередь для статических проверок типов. Они служат параметрами для обобщённых типов, а также для определений обобщённых функций и псевдонимов типов. Дополнительную информацию об обобщённых типах см. в [`Generic`](https://python-all.ru/3.11/library/typing.html#typing.Generic). Обобщённые функции работают следующим образом: ```python def repeat(x: T, n: int) -> Sequence[T]: """Возвращает список, содержащий n ссылок на x.""" return [x]*n def print_capitalized(x: S) -> S: """Печатает x с заглавной буквы и возвращает x.""" print(x.capitalize()) return x def concatenate(x: A, y: A) -> A: """Складывает две строки или два объекта bytes.""" return x + y ``` Обратите внимание, что переменные типа могут быть *связаны*, *ограничены* или ни тем, ни другим, но не могут быть одновременно и связаны, *и* ограничены. Переменные типа могут быть помечены как ковариантные или контравариантные путём передачи `covariant=True` или `contravariant=True`. См. [**PEP 484**](https://python-all.ru/3.11/library/typing.html) для получения дополнительных сведений. По умолчанию переменные типа инвариантны. Связанные переменные типа и ограниченные переменные типа имеют разную семантику в нескольких важных аспектах. Использование *связанной* переменной типа означает, что `TypeVar` будет разрешена с использованием наиболее конкретного типа: ```python x = print_capitalized('a string') reveal_type(x) # выявленный тип – str class StringSubclass(str): pass y = print_capitalized(StringSubclass('another string')) reveal_type(y) # раскрытый тип – StringSubclass z = print_capitalized(45) # ошибка: int не является подтипом str ``` Переменные типа могут быть связаны с конкретными типами, абстрактными типами (ABC или протоколами) и даже объединениями типов: ```python U = TypeVar('U', bound=str|bytes) # Может быть любым подтипом объединения str|bytes V = TypeVar('V', bound=SupportsAbs) # Может быть чем угодно с методом __abs__ ``` Однако использование переменной типа с *ограничениями* означает, что `TypeVar` может быть выведен только как один из заданных ограничений: ```python a = concatenate('one', 'two') reveal_type(a) # выявленный тип – str b = concatenate(StringSubclass('one'), StringSubclass('two')) reveal_type(b) # выявленный тип – str, несмотря на то что передан StringSubclass c = concatenate('one', b'two') # ошибка: типовая переменная 'A' может быть либо str, либо bytes в вызове функции, но не обоими одновременно ``` Во время выполнения `isinstance(x, T)` вызовет [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError). #### `__name__` Имя переменной типа. #### `__covariant__` Определяет, помечена ли переменная типа как ковариантная. #### `__contravariant__` Определяет, помечена ли переменная типа как контравариантная. #### `__bound__` Граница переменной типа, если она есть. #### `__constraints__` Кортеж, содержащий ограничения переменной типа, если они есть. #### `class typing.TypeVarTuple(name)` Кортежная переменная типа. Специализированная форма [переменной типа](https://python-all.ru/3.11/library/typing.html#typevar), которая позволяет использовать *вариативные* обобщения. Использование: ```python T = TypeVar("T") Ts = TypeVarTuple("Ts") def move_first_element_to_last(tup: tuple[T, *Ts]) -> tuple[*Ts, T]: return (*tup[1:], tup[0]) ``` Обычная переменная типа позволяет параметризацию одним типом. Кортежная переменная типа, напротив, позволяет параметризацию *произвольным* количеством типов, действуя как *произвольное* количество переменных типа, упакованных в кортеж. Например: ```python # T привязан к int, Ts привязан к () # Возвращаемое значение – (1,), тип которого tuple[int] move_first_element_to_last(tup=(1,)) # T привязан к int, Ts привязан к (str,) # Возвращаемое значение – ('spam', 1), тип которого tuple[str, int] move_first_element_to_last(tup=(1, 'spam')) # T привязан к int, Ts привязан к (str, float) # Возвращаемое значение – ('spam', 3.0, 1), тип которого tuple[str, float, int] move_first_element_to_last(tup=(1, 'spam', 3.0)) # Это не проходит проверку типов (и завершается ошибкой во время выполнения) # потому что tuple[()] несовместим с tuple[T, *Ts] # (требуется хотя бы один элемент) move_first_element_to_last(tup=()) ``` Обратите внимание на использование оператора распаковки `*` в `tuple[T, *Ts]`. Концептуально можно представить `Ts` как кортеж переменных типа `(T1, T2, ...)`. Тогда `tuple[T, *Ts]` станет `tuple[T, *(T1, T2, ...)]`, что эквивалентно `tuple[T, T1, T2, ...]`. (Обратите внимание, что в более старых версиях Python это могло быть записано с использованием [`Unpack`](https://python-all.ru/3.11/library/typing.html#typing.Unpack), например, `Unpack[Ts]`.) Кортежные переменные типа *всегда* должны быть распакованы. Это помогает отличать кортежные переменные типа от обычных: ```python x: Ts # Недействительно x: tuple[Ts] # Недействительно x: tuple[*Ts] # Правильный способ сделать это ``` Кортежные переменные типа можно использовать в тех же контекстах, что и обычные переменные типа. Например, в определениях классов, аргументах и возвращаемых типах: ```python Shape = TypeVarTuple("Shape") class Array(Generic[*Shape]): def __getitem__(self, key: tuple[*Shape]) -> float: ... def __abs__(self) -> "Array[*Shape]": ... def get_shape(self) -> tuple[*Shape]: ... ``` Кортежные переменные типа можно без проблем комбинировать с обычными переменными типа: ```python DType = TypeVar('DType') Shape = TypeVarTuple('Shape') class Array(Generic[DType, *Shape]): # Это нормально pass class Array2(Generic[*Shape, DType]): # Это тоже нормально pass class Height: ... class Width: ... float_array_1d: Array[float, Height] = Array() # Совершенно нормально int_array_2d: Array[int, Height, Width] = Array() # Да, тоже нормально ``` Однако обратите внимание, что в одном списке аргументов типа или параметров типа может присутствовать не более одной кортежной переменной типа: ```python x: tuple[*Ts, *Ts] # Недействительно class Array(Generic[*Shape, *Shape]): # Недействительно pass ``` Наконец, распакованная кортежная переменная типа может использоваться в качестве аннотации типа для `*args`: ```python def call_soon( callback: Callable[[*Ts], None], *args: *Ts ) -> None: ... callback(*args) ``` В отличие от нераспакованных аннотаций `*args`, например `*args: int`, которые указывают, что *все* аргументы имеют тип `int`, `*args: *Ts` позволяет ссылаться на типы *отдельных* аргументов в `*args`. Здесь это позволяет нам убедиться, что типы `*args`, передаваемых в `call_soon`, соответствуют типам (позиционных) аргументов `callback`. Подробнее о кортежах переменных типа см. в [**PEP 646**](https://python-all.ru/3.11/library/typing.html). #### `__name__` Имя кортежа переменных типа. Новое в версии 3.11. #### `class typing.ParamSpec(name, *, bound=None, covariant=False, contravariant=False)` Переменная спецификации параметров. Специализированная версия [переменных типа](https://python-all.ru/3.11/library/typing.html#typevar). Использование: ```python P = ParamSpec('P') ``` Переменные спецификации параметров существуют в первую очередь для статических проверок типов. Они используются для передачи типов параметров одного вызываемого объекта другому вызываемому объекту – шаблон, часто встречающийся в функциях высшего порядка и декораторах. Они допустимы только при использовании в `Concatenate`, или как первый аргумент `Callable`, или как параметры пользовательских обобщённых типов (Generics). См. [`Generic`](https://python-all.ru/3.11/library/typing.html#typing.Generic) для получения дополнительной информации об обобщённых типах. Например, чтобы добавить базовое логирование в функцию, можно создать декоратор `add_logging` для логирования вызовов функций. Переменная спецификации параметров сообщает проверяющему типы, что вызываемый объект, переданный в декоратор, и новый вызываемый объект, возвращаемый им, имеют взаимозависимые параметры типа: ```python from collections.abc import Callable from typing import TypeVar, ParamSpec import logging T = TypeVar('T') P = ParamSpec('P') def add_logging(f: Callable[P, T]) -> Callable[P, T]: '''Типобезопасный декоратор для добавления логирования в функцию.''' def inner(*args: P.args, **kwargs: P.kwargs) -> T: logging.info(f'{f.__name__} was called') return f(*args, **kwargs) return inner @add_logging def add_two(x: float, y: float) -> float: '''Складывает два числа.''' return x + y ``` Без `ParamSpec` самый простой способ аннотировать это ранее заключался в использовании [`TypeVar`](https://python-all.ru/3.11/library/typing.html#typing.TypeVar) с границей `Callable[..., Any]`. Однако это вызывает две проблемы: 1. Проверяющий типы не может проверить типы функции `inner`, потому что `*args` и `**kwargs` должны быть типизированы как [`Any`](https://python-all.ru/3.11/library/typing.html#typing.Any). 2. [`cast()`](https://python-all.ru/3.11/library/typing.html#typing.cast) может потребоваться в теле декоратора `add_logging` при возврате функции `inner`, или статической проверке типов нужно указать игнорировать `return inner`. #### `args` #### `kwargs` Поскольку `ParamSpec` захватывает как позиционные, так и ключевые параметры, `P.args` и `P.kwargs` можно использовать для разделения `ParamSpec` на составляющие. `P.args` представляет кортеж позиционных параметров в заданном вызове и должен использоваться только для аннотации `*args`. `P.kwargs` представляет отображение ключевых параметров на их значения в заданном вызове и должен использоваться только для аннотации `**kwargs`. Оба атрибута требуют, чтобы аннотируемый параметр находился в области видимости. Во время выполнения `P.args` и `P.kwargs` являются экземплярами соответственно [`ParamSpecArgs`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpecArgs) и [`ParamSpecKwargs`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpecKwargs). #### `__name__` Имя спецификации параметров. Переменные спецификации параметров, созданные с помощью `covariant=True` или `contravariant=True`, можно использовать для объявления ковариантных или контравариантных обобщённых типов. Аргумент `bound` также принимается, как и в [`TypeVar`](https://python-all.ru/3.11/library/typing.html#typing.TypeVar). Однако фактическая семантика этих ключевых слов ещё не определена. Новое в версии 3.10. > **Примечание** > > Только переменные спецификации параметров, определённые в глобальной области видимости, могут быть pickled. > **См. также** > > - [**PEP 612**](https://python-all.ru/3.11/library/typing.html) – Переменные спецификации параметров (PEP, в котором были введены `ParamSpec` и `Concatenate`) > - [`Concatenate`](https://python-all.ru/3.11/library/typing.html#typing.Concatenate) > - [Аннотация вызываемых объектов](https://python-all.ru/3.11/library/typing.html#annotating-callables) #### `typing.ParamSpecArgs` #### `typing.ParamSpecKwargs` Атрибуты аргументов и именованных аргументов (keyword arguments) объекта [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec). Атрибут `P.args` объекта `ParamSpec` является экземпляром `ParamSpecArgs`, а `P.kwargs` – экземпляром `ParamSpecKwargs`. Они предназначены для интроспекции во время выполнения и не имеют особого значения для статических проверяющих типы. Вызов [`get_origin()`](https://python-all.ru/3.11/library/typing.html#typing.get_origin) для любого из этих объектов вернёт исходный `ParamSpec`: ```pycon >>> from typing import ParamSpec, get_origin >>> P = ParamSpec("P") >>> get_origin(P.args) is P True >>> get_origin(P.kwargs) is P True ``` Новое в версии 3.10. #### Другие специальные директивы Эти функции и классы не следует использовать напрямую в качестве аннотаций. Их предназначение – быть строительными блоками для создания и объявления типов. #### `class typing.NamedTuple` Типизированная версия [`collections.namedtuple()`](https://python-all.ru/3.11/library/collections.html#collections.namedtuple). Использование: ```python class Employee(NamedTuple): name: str id: int ``` Это эквивалентно: ```python Employee = collections.namedtuple('Employee', ['name', 'id']) ``` Чтобы задать полю значение по умолчанию, можно присвоить его в теле класса: ```python class Employee(NamedTuple): name: str id: int = 3 employee = Employee('Guido') assert employee.id == 3 ``` Поля со значением по умолчанию должны следовать после полей без значения по умолчанию. Полученный класс имеет дополнительный атрибут `__annotations__`, который содержит словарь, отображающий имена полей на их типы. (Имена полей находятся в атрибуте `_fields`, а значения по умолчанию – в атрибуте `_field_defaults`; оба они являются частью API [`namedtuple()`](https://python-all.ru/3.11/library/collections.html#collections.namedtuple).) Подклассы `NamedTuple` также могут иметь докстринги и методы: ```python class Employee(NamedTuple): """Представляет сотрудника.""" name: str id: int = 3 def __repr__(self) -> str: return f'' ``` Подклассы `NamedTuple` могут быть обобщёнными (generic): ```python class Group(NamedTuple, Generic[T]): key: T group: list[T] ``` Обратно совместимое использование: ```python Employee = NamedTuple('Employee', [('name', str), ('id', int)]) ``` Изменено в версии 3.6: Добавлена поддержка синтаксиса аннотации переменных [**PEP 526**](https://python-all.ru/3.11/library/typing.html). Изменено в версии 3.6.1: Добавлена поддержка значений по умолчанию, методов и строк документации. Изменено в версии 3.8: Атрибуты `_field_types` и `__annotations__` теперь являются обычными словарями, а не экземплярами `OrderedDict`. Изменено в версии 3.9: Атрибут `_field_types` удалён в пользу более стандартного атрибута `__annotations__`, который содержит ту же информацию. Изменено в версии 3.11: Добавлена поддержка обобщённых именованных кортежей (generic namedtuples). #### `class typing.NewType(name, tp)` Вспомогательный класс для создания [отдельных типов с низкими накладными расходами](https://python-all.ru/3.11/library/typing.html#distinct). `NewType` считается отдельным типом для проверщика типов. Однако во время выполнения вызов `NewType` возвращает свой аргумент без изменений. Использование: ```python UserId = NewType('UserId', int) # Объявить NewType "UserId" first_user = UserId(1) # "UserId" возвращает аргумент без изменений во время выполнения ``` #### `__module__` Модуль, в котором определён новый тип. #### `__name__` Имя нового типа. #### `__supertype__` Тип, на котором основан новый тип. Новое в версии 3.5.2. Изменено в версии 3.10: `NewType` теперь является классом, а не функцией. #### `class typing.Protocol(Generic)` Базовый класс для протокольных классов. Протокольные классы определяются следующим образом: ```python class Proto(Protocol): def meth(self) -> int: ... ``` Такие классы в основном используются со статическими проверяющими типов, которые распознают структурную подтипизацию (статическую утиную типизацию), например: ```python class C: def meth(self) -> int: return 0 def func(x: Proto) -> int: return x.meth() func(C()) # Проходит статическую проверку типов ``` См. [**PEP 544**](https://python-all.ru/3.11/library/typing.html) для получения дополнительных сведений. Классы-протоколы, декорированные [`runtime_checkable()`](https://python-all.ru/3.11/library/typing.html#typing.runtime_checkable) (описано далее), действуют как простые протоколы времени выполнения, которые проверяют только наличие заданных атрибутов, игнорируя их сигнатуры типов. Протокольные классы могут быть обобщёнными, например: ```python T = TypeVar("T") class GenProto(Protocol[T]): def meth(self) -> T: ... ``` Новое в версии 3.8. #### `@typing.runtime_checkable` Помечает протокольный класс как протокол времени выполнения. Такой протокол может использоваться с [`isinstance()`](https://python-all.ru/3.11/library/functions.html#isinstance) и [`issubclass()`](https://python-all.ru/3.11/library/functions.html#issubclass). При применении к классу, не являющемуся протоколом, возникает [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError). Это позволяет выполнять простую структурную проверку, очень похожую на “one trick ponies” в [`collections.abc`](https://python-all.ru/3.11/library/collections.abc.html#module-collections.abc), таких как [`Iterable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Iterable). Например: ```python @runtime_checkable class Closable(Protocol): def close(self): ... assert isinstance(open('/some/file'), Closable) @runtime_checkable class Named(Protocol): name: str import threading assert isinstance(threading.Thread(name='Bob'), Named) ``` > **Примечание** > > `runtime_checkable()` будет проверять только наличие требуемых методов или атрибутов, но не их сигнатуры типов или сами типы. Например, [`ssl.SSLObject`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLObject) является классом, поэтому он проходит проверку [`issubclass()`](https://python-all.ru/3.11/library/functions.html#issubclass) на соответствие [Callable](https://python-all.ru/3.11/library/typing.html#annotating-callables). Однако метод `ssl.SSLObject.__init__` существует только для того, чтобы вызвать [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError) с более информативным сообщением, что делает невозможным вызов (создание экземпляра) [`ssl.SSLObject`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLObject). > **Примечание** > > Проверка [`isinstance()`](https://python-all.ru/3.11/library/functions.html#isinstance) на соответствие протоколу с проверкой во время выполнения может быть удивительно медленной по сравнению с проверкой `isinstance()` для непротокольного класса. Рекомендуется использовать альтернативные идиомы, такие как вызовы [`hasattr()`](https://python-all.ru/3.11/library/functions.html#hasattr) для структурных проверок в коде, чувствительном к производительности. Новое в версии 3.8. #### `class typing.TypedDict(dict)` Специальная конструкция для добавления подсказок типов к словарю. Во время выполнения это обычный [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict). `TypedDict` объявляет тип словаря, который ожидает, что все его экземпляры будут иметь определённый набор ключей, где каждый ключ связан со значением согласованного типа. Это ожидание не проверяется во время выполнения, а обеспечивается только средствами проверки типов. Использование: ```python class Point2D(TypedDict): x: int y: int label: str a: Point2D = {'x': 1, 'y': 2, 'label': 'good'} # ОК b: Point2D = {'z': 3, 'label': 'bad'} # Не проходит проверку типов assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first') ``` Чтобы разрешить использование этой возможности в старых версиях Python, которые не поддерживают [**PEP 526**](https://python-all.ru/3.11/library/typing.html), `TypedDict` поддерживает две дополнительные эквивалентные синтаксические формы: - Использование литерала [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict) в качестве второго аргумента: ```python Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str}) ``` - Использование именованных аргументов: ```python Point2D = TypedDict('Point2D', x=int, y=int, label=str) ``` Устарело с версии 3.11, будет удалено в версии 3.13: Синтаксис именованных аргументов устарел в 3.11 и будет удалён в 3.13. Он также может не поддерживаться статическими проверщиками типов. Функциональный синтаксис также следует использовать, когда какой-либо из ключей не является допустимым [идентификатором](https://python-all.ru/3.11/reference/lexical_analysis.html#identifiers), например, потому что они являются ключевыми словами или содержат дефисы. Пример: ```python # возбуждает SyntaxError class Point2D(TypedDict): in: int # 'in' – ключевое слово x-y: int # имя с дефисами # ОК, функциональный синтаксис Point2D = TypedDict('Point2D', {'in': int, 'x-y': int}) ``` По умолчанию все ключи должны присутствовать в `TypedDict`. Можно пометить отдельные ключи как необязательные с помощью [`NotRequired`](https://python-all.ru/3.11/library/typing.html#typing.NotRequired): ```python class Point2D(TypedDict): x: int y: int label: NotRequired[str] # Альтернативный синтаксис Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': NotRequired[str]}) ``` Это означает, что `Point2D` `TypedDict` может не содержать ключ `label`. Также можно по умолчанию пометить все ключи как необязательные, указав totality `False`: ```python class Point2D(TypedDict, total=False): x: int y: int # Альтернативный синтаксис Point2D = TypedDict('Point2D', {'x': int, 'y': int}, total=False) ``` Это означает, что `Point2D` `TypedDict` может не содержать любой из ключей. Средство проверки типов должно поддерживать только литерал `False` или `True` в качестве значения аргумента `total`. `True` – значение по умолчанию, и оно делает все элементы, определённые в теле класса, обязательными. Отдельные ключи `total=False` `TypedDict` можно пометить как обязательные с помощью [`Required`](https://python-all.ru/3.11/library/typing.html#typing.Required): ```python class Point2D(TypedDict, total=False): x: Required[int] y: Required[int] label: str # Альтернативный синтаксис Point2D = TypedDict('Point2D', { 'x': Required[int], 'y': Required[int], 'label': str }, total=False) ``` `TypedDict` может наследоваться от одного или нескольких других типов `TypedDict` с использованием синтаксиса на основе классов. Использование: ```python class Point3D(Point2D): z: int ``` `Point3D` содержит три элемента: `x`, `y` и `z`. Это эквивалентно следующему определению: ```python class Point3D(TypedDict): x: int y: int z: int ``` `TypedDict` не может наследоваться от класса, не являющегося `TypedDict`, за исключением [`Generic`](https://python-all.ru/3.11/library/typing.html#typing.Generic). Например: ```python class X(TypedDict): x: int class Y(TypedDict): y: int class Z(object): pass # Класс, не являющийся TypedDict class XY(X, Y): pass # ОК class XZ(X, Z): pass # вызывает TypeError ``` `TypedDict` может быть обобщённым: ```python T = TypeVar("T") class Group(TypedDict, Generic[T]): key: T group: list[T] ``` `TypedDict` может быть проанализирован с помощью словарей аннотаций (см. [Лучшие практики работы с аннотациями](https://python-all.ru/3.11/howto/annotations.html#annotations-howto) для получения дополнительной информации о лучших практиках работы с аннотациями), [`__total__`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict.__total__), [`__required_keys__`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict.__required_keys__) и [`__optional_keys__`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict.__optional_keys__). #### `__total__` `Point2D.__total__` возвращает значение аргумента `total`. Пример: ```pycon >>> 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 ``` Этот атрибут отражает *только* значение аргумента `total` текущего класса `TypedDict`, а не то, является ли класс семантически полным. Например, `TypedDict` с `__total__`, установленным в True, может иметь ключи, помеченные с помощью [`NotRequired`](https://python-all.ru/3.11/library/typing.html#typing.NotRequired), или наследовать от другого `TypedDict` с `total=False`. Поэтому для интроспекции обычно лучше использовать [`__required_keys__`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict.__required_keys__) и [`__optional_keys__`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict.__optional_keys__). #### `__required_keys__` Новое в версии 3.9. #### `__optional_keys__` `Point2D.__required_keys__` и `Point2D.__optional_keys__` возвращают объекты [`frozenset`](https://python-all.ru/3.11/library/stdtypes.html#frozenset), содержащие обязательные и необязательные ключи соответственно. Ключи, помеченные [`Required`](https://python-all.ru/3.11/library/typing.html#typing.Required), всегда будут появляться в `__required_keys__`, а ключи, помеченные [`NotRequired`](https://python-all.ru/3.11/library/typing.html#typing.NotRequired), всегда будут появляться в `__optional_keys__`. Для обратной совместимости с Python 3.10 и ниже также можно использовать наследование для объявления как обязательных, так и необязательных ключей в одном `TypedDict`. Это делается путём объявления `TypedDict` с одним значением аргумента `total`, а затем наследования от него в другом `TypedDict` с другим значением для `total`: ```pycon >>> 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 ``` Новое в версии 3.9. > **Примечание** > > Если используется `from __future__ import annotations` или аннотации заданы в виде строк, аннотации не вычисляются при определении `TypedDict`. Поэтому анализ во время выполнения, на который полагаются `__required_keys__` и `__optional_keys__`, может работать неправильно, и значения атрибутов могут быть неверными. Смотрите [**PEP 589**](https://python-all.ru/3.11/library/typing.html) для дополнительных примеров и подробных правил использования `TypedDict`. Новое в версии 3.8. Изменено в версии 3.11: Добавлена поддержка пометки отдельных ключей как [`Required`](https://python-all.ru/3.11/library/typing.html#typing.Required) или [`NotRequired`](https://python-all.ru/3.11/library/typing.html#typing.NotRequired). См. [**PEP 655**](https://python-all.ru/3.11/library/typing.html). Изменено в версии 3.11: Добавлена поддержка обобщённых `TypedDict`. ### Протоколы Следующие протоколы предоставляются модулем typing. Все они декорированы [`@runtime_checkable`](https://python-all.ru/3.11/library/typing.html#typing.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__` ковариантным по возвращаемому типу. ### Абстрактные базовые классы для работы с IO #### `class typing.IO` #### `class typing.TextIO` #### `class typing.BinaryIO` Обобщённый тип `IO[AnyStr]` и его подклассы `TextIO(IO[str])` и `BinaryIO(IO[bytes])` представляют типы потоков ввода-вывода, такие как возвращаемые [`open()`](https://python-all.ru/3.11/library/functions.html#open). ### Функции и декораторы #### `typing.cast(typ, val)` Приводит значение к типу. Это возвращает значение без изменений. Для проверщика типов это сигнализирует, что возвращаемое значение имеет указанный тип, но во время выполнения мы намеренно ничего не проверяем (мы хотим, чтобы это было как можно быстрее). #### `typing.assert_type(val, typ, /)` Запросить у статического проверщика типов подтверждение, что *val* имеет выведенный тип *typ*. Во время выполнения эта функция ничего не делает: она возвращает первый аргумент без изменений, без проверок или побочных эффектов, независимо от фактического типа аргумента. Когда статический проверщик типов встречает вызов `assert_type()`, он выдает ошибку, если значение не относится к указанному типу: ```python def greet(name: str) -> None: assert_type(name, str) # ОК, выведенный тип `name` – `str` assert_type(name, int) # ошибка проверки типов ``` Эта функция полезна для проверки того, что понимание скрипта проверщиком типов соответствует намерениям разработчика: ```python def complex_function(arg: object): # Выполнить сложную логику сужения типа, # после чего ожидается, что выведенный тип станет `int` ... # Проверить, правильно ли проверщик типов понимает нашу функцию assert_type(arg, int) ``` Новое в версии 3.11. #### `typing.assert_never(arg, /)` Попросить статический проверщик типов подтвердить, что строка кода недостижима. Пример: ```python 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 _ as unreachable: assert_never(unreachable) ``` Здесь аннотации позволяют проверщику типов вывести, что последний случай никогда не выполнится, поскольку `arg` является либо [`int`](https://python-all.ru/3.11/library/functions.html#int), либо [`str`](https://python-all.ru/3.11/library/stdtypes.html#str), и оба варианта уже покрыты предыдущими случаями. Если проверщик типов обнаружит, что вызов `assert_never()` достижим, он выдаст ошибку. Например, если бы аннотация типа для `arg` вместо этого была `int | str | float`, проверщик типов выдал бы ошибку, указывающую, что `unreachable` имеет тип [`float`](https://python-all.ru/3.11/library/functions.html#float). Для того чтобы вызов `assert_never` прошел проверку типов, выведенный тип переданного аргумента должен быть нижним типом [`Never`](https://python-all.ru/3.11/library/typing.html#typing.Never) и ничем иным. Во время выполнения эта функция выбрасывает исключение при вызове. > **См. также** > > В разделе [Unreachable Code and Exhaustiveness Checking](https://python-all.ru/3.11/library/typing.html) содержится дополнительная информация о проверке полноты с помощью статической типизации. Новое в версии 3.11. #### `typing.reveal_type(obj, /)` Попросить статический проверщик типов показать выведенный тип выражения. Когда статический проверщик типов встречает вызов этой функции, он выдает диагностическое сообщение с выведенным типом аргумента. Например: ```python x: int = 1 reveal_type(x) # Раскрытый тип – "builtins.int" ``` Это может быть полезно для отладки того, как проверщик типов обрабатывает конкретный фрагмент кода. Во время выполнения эта функция выводит тип аргумента во время выполнения в [`sys.stderr`](https://python-all.ru/3.11/library/sys.html#sys.stderr) и возвращает аргумент без изменений (что позволяет использовать вызов внутри выражения): ```python x = reveal_type(1) # выводит «Runtime type is int» print(x) # выводит "1" ``` Обратите внимание, что тип во время выполнения может отличаться от статически выведенного типа (быть более или менее конкретным). Большинство проверщиков типов поддерживают `reveal_type()` в любом месте, даже если имя не импортировано из `typing`. Однако импорт имени из `typing` позволяет коду выполняться без ошибок времени выполнения и более четко выражает намерения. Новое в версии 3.11. #### `@typing.dataclass_transform(*, eq_default=True, order_default=False, kw_only_default=False, field_specifiers=(), **kwargs)` Декоратор для пометки объекта как предоставляющего поведение, подобное [`dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass). `dataclass_transform` может использоваться для декорирования класса, метакласса или функции, которая сама является декоратором. Наличие `@dataclass_transform()` сообщает статическому проверщику типов, что декорированный объект выполняет во время выполнения «магию», преобразующую класс аналогично [`@dataclasses.dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass). Пример использования с функцией-декоратором: ```python T = TypeVar("T") @dataclass_transform() def create_model(cls: type[T]) -> type[T]: ... return cls @create_model class CustomerModel: id: int name: str ``` На базовом классе: ```python @dataclass_transform() class ModelBase: ... class CustomerModel(ModelBase): id: int name: str ``` На метаклассе: ```python @dataclass_transform() class ModelMeta(type): ... class ModelBase(metaclass=ModelMeta): ... class CustomerModel(ModelBase): id: int name: str ``` Классы `CustomerModel`, определенные выше, будут обрабатываться проверщиками типов аналогично классам, созданным с помощью [`@dataclasses.dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass). Например, проверщики типов будут предполагать, что эти классы имеют методы `__init__`, которые принимают `id` и `name`. Декорированный класс, метакласс или функция могут принимать следующие булевы аргументы, которые, как будет считать проверщик типов, имеют тот же эффект, что и для декоратора [`@dataclasses.dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass): `init`, `eq`, `order`, `unsafe_hash`, `frozen`, `match_args`, `kw_only` и `slots`. Значения этих аргументов (`True` или `False`) должны быть статически вычислимыми. Аргументы декоратора `dataclass_transform` могут использоваться для настройки поведения по умолчанию декорированного класса, метакласса или функции: **Параметры:** - **eq\_default** ([*bool*](https://python-all.ru/3.11/library/functions.html#bool)) – Указывает, предполагается ли параметр `eq` равным `True` или `False`, если он опущен вызывающей стороной. По умолчанию `True`. - **order\_default** ([*bool*](https://python-all.ru/3.11/library/functions.html#bool)) – Указывает, предполагается ли параметр `order` равным `True` или `False`, если он опущен вызывающей стороной. По умолчанию `False`. - **kw\_only\_default** ([*bool*](https://python-all.ru/3.11/library/functions.html#bool)) – Указывает, предполагается ли параметр `kw_only` равным `True` или `False`, если он опущен вызывающей стороной. По умолчанию `False`. - **field\_specifiers** ([*tuple*](https://python-all.ru/3.11/library/stdtypes.html#tuple)*\[*[*Callable*](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Callable)*\[**...**,* *Any**\]**,* *...**\]*) – Задаёт статический список поддерживаемых классов или функций, описывающих поля, аналогично [`dataclasses.field()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.field). По умолчанию `()`. - **\*\*kwargs** (*Any*) – Допускаются произвольные другие именованные аргументы, чтобы обеспечить возможность будущих расширений. Проверщики типов распознают следующие необязательные параметры в спецификаторах полей: | Имя параметра | Описание | | --- | --- | | `init` | Указывает, должно ли поле быть включено в синтезируемый метод `__init__`. Если не указано, `init` по умолчанию равно `True`. | | `default` | Предоставляет значение по умолчанию для поля. | | `default_factory` | Предоставляет колбэк времени выполнения, возвращающий значение по умолчанию для поля. Если не указаны ни `default`, ни `default_factory`, считается, что поле не имеет значения по умолчанию, и при создании экземпляра класса для него должно быть предоставлено значение. | | `factory` | Псевдоним для параметра `default_factory` в спецификаторах полей. | | `kw_only` | Указывает, должно ли поле быть помечено как keyword-only. Если `True`, поле будет keyword-only. Если `False`, оно не будет keyword-only. Если не указано, будет использовано значение параметра `kw_only` объекта, декорированного с помощью `dataclass_transform`, или, если оно не указано, значение `kw_only_default` на `dataclass_transform`. | | `alias` | Предоставляет альтернативное имя для поля. Это альтернативное имя используется в синтезируемом методе `__init__`. | Во время выполнения этот декоратор записывает свои аргументы в атрибут `__dataclass_transform__` декорированного объекта. Других эффектов во время выполнения нет. Подробнее см. [**PEP 681**](https://python-all.ru/3.11/library/typing.html). Новое в версии 3.11. #### `@typing.overload` Декоратор для создания перегруженных функций и методов. Декоратор `@overload` позволяет описывать функции и методы, поддерживающие несколько различных комбинаций типов аргументов. За серией определений, декорированных `@overload`, должно следовать ровно одно определение, не декорированное `@overload` (для той же функции/метода). Определения, декорированные `@overload`, предназначены только для проверщика типов, поскольку они будут перезаписаны определением, не декорированным `@overload`. Определение, не декорированное `@overload`, в свою очередь, будет использоваться во время выполнения, но должно игнорироваться проверщиком типов. Во время выполнения прямой вызов функции, декорированной `@overload`, вызовет [`NotImplementedError`](https://python-all.ru/3.11/library/exceptions.html#NotImplementedError). Пример перегрузки, которая даёт более точный тип, чем можно выразить с помощью объединения или переменной типа: ```python @overload def process(response: None) -> None: ... @overload def process(response: int) -> tuple[int, str]: ... @overload def process(response: bytes) -> str: ... def process(response): ... # здесь находится фактическая реализация ``` Подробнее и сравнение с другими семантиками типизации см. [**PEP 484**](https://python-all.ru/3.11/library/typing.html). Изменено в версии 3.11: Перегруженные функции теперь можно интроспектировать во время выполнения с помощью [`get_overloads()`](https://python-all.ru/3.11/library/typing.html#typing.get_overloads). #### `typing.get_overloads(func)` Возвращает последовательность определений, декорированных [`@overload`](https://python-all.ru/3.11/library/typing.html#typing.overload), для *func*. *func* – это объект функции для реализации перегруженной функции. Например, если дано определение `process` в документации для [`@overload`](https://python-all.ru/3.11/library/typing.html#typing.overload), `get_overloads(process)` вернёт последовательность из трёх объектов функций для трёх определённых перегрузок. Если вызвана для функции без перегрузок, `get_overloads()` возвращает пустую последовательность. `get_overloads()` можно использовать для интроспекции перегруженной функции во время выполнения. Новое в версии 3.11. #### `typing.clear_overloads()` Очищает все зарегистрированные перегрузки во внутреннем реестре. Это можно использовать для освобождения памяти, занятой реестром. Новое в версии 3.11. #### `@typing.final` Декоратор для указания окончательных методов и окончательных классов. Декорирование метода с помощью `@final` указывает проверщику типов, что метод не может быть переопределён в подклассе. Декорирование класса с помощью `@final` указывает, что от него нельзя наследовать. Например: ```python class Base: @final def done(self) -> None: ... class Sub(Base): def done(self) -> None: # Ошибка, выдаваемая проверщиком типов ... @final class Leaf: ... class Other(Leaf): # Ошибка, выдаваемая проверщиком типов ... ``` Проверка этих свойств во время выполнения не выполняется. Подробнее см. [**PEP 591**](https://python-all.ru/3.11/library/typing.html). Новое в версии 3.8. Изменено в версии 3.11: Декоратор теперь будет пытаться установить атрибут `__final__` в значение `True` на декорированном объекте. Таким образом, проверку вида `if getattr(obj, "__final__", False)` можно использовать во время выполнения, чтобы определить, был ли объект `obj` помечен как окончательный (final). Если декорированный объект не поддерживает установку атрибутов, декоратор возвращает объект без изменений, не вызывая исключения. #### `@typing.no_type_check` Декоратор, указывающий, что аннотации не являются подсказками типов. Это работает как [декоратор](https://python-all.ru/3.11/glossary.html#term-decorator) класса или функции. Для класса он применяется рекурсивно ко всем методам и классам, определённым в этом классе (но не к методам, определённым в его суперклассах или подклассах). Средства проверки типов будут игнорировать все аннотации в функции или классе с этим декоратором. `@no_type_check` изменяет декорированный объект на месте. #### `@typing.no_type_check_decorator` Декоратор, придающий другому декоратору эффект [`no_type_check()`](https://python-all.ru/3.11/library/typing.html#typing.no_type_check). Он оборачивает декоратор чем-то, что оборачивает декорированную функцию в [`no_type_check()`](https://python-all.ru/3.11/library/typing.html#typing.no_type_check). #### `@typing.type_check_only` Декоратор для пометки класса или функции как недоступных во время выполнения. Сам этот декоратор недоступен во время выполнения. Он в основном предназначен для пометки классов, определённых в файлах заглушек типов (type stub), если реализация возвращает экземпляр закрытого класса: ```python @type_check_only class Response: # приватный или недоступный во время выполнения 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)` Возвращает словарь, содержащий аннотации типов для функции, метода, модуля или объекта класса. Это часто то же самое, что и `obj.__annotations__`. Кроме того, прямые ссылки, закодированные как строковые литералы, обрабатываются путём их вычисления в пространствах имён `globals` и `locals`. Для класса `C` возвращает словарь, построенный слиянием всех `__annotations__` вдоль `C.__mro__` в обратном порядке. Функция рекурсивно заменяет все `Annotated[T, ...]` на `T`, если только `include_extras` не установлено в `True` (см. [`Annotated`](https://python-all.ru/3.11/library/typing.html#typing.Annotated) для получения дополнительной информации). Например: ```python class Student(NamedTuple): name: Annotated[str, 'some marker'] assert get_type_hints(Student) == {'name': str} assert get_type_hints(Student, include_extras=False) == {'name': str} assert get_type_hints(Student, include_extras=True) == { 'name': Annotated[str, 'some marker'] } ``` > **Примечание** > > [`get_type_hints()`](https://python-all.ru/3.11/library/typing.html#typing.get_type_hints) не работает с импортированными [псевдонимами типов](https://python-all.ru/3.11/library/typing.html#type-aliases), которые содержат прямые ссылки. Включение отложенного вычисления аннотаций ([**PEP 563**](https://python-all.ru/3.11/library/typing.html)) может устранить необходимость в большинстве прямых ссылок. Изменено в версии 3.9: Добавлен параметр `include_extras` в рамках [**PEP 593**](https://python-all.ru/3.11/library/typing.html). См. документацию по [`Annotated`](https://python-all.ru/3.11/library/typing.html#typing.Annotated) для получения дополнительных сведений. Изменено в версии 3.11: Ранее `Optional[t]` добавлялась для аннотаций функций и методов, если было установлено значение по умолчанию, равное `None`. Теперь аннотация возвращается без изменений. #### `typing.get_origin(tp)` Возвращает неиндексированную версию типа: для объекта typing вида `X[Y, Z, ...]` возвращает `X`. Если `X` – это псевдоним из модуля typing для встроенного класса или класса [`collections`](https://python-all.ru/3.11/library/collections.html#module-collections), он будет нормализован до исходного класса. Если `X` является экземпляром [`ParamSpecArgs`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpecArgs) или [`ParamSpecKwargs`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpecKwargs), возвращается базовый [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec). Для неподдерживаемых объектов возвращается `None`. Примеры: ```python assert get_origin(str) is None assert get_origin(Dict[str, int]) is dict assert get_origin(Union[int, str]) is Union P = ParamSpec('P') assert get_origin(P.args) is P assert get_origin(P.kwargs) is P ``` Новое в версии 3.8. #### `typing.get_args(tp)` Возвращает аргументы типа после выполнения всех подстановок: для объекта typing вида `X[Y, Z, ...]` возвращает `(Y, Z, ...)`. Если `X` является объединением (union) или [`Literal`](https://python-all.ru/3.11/library/typing.html#typing.Literal) содержится в другом обобщённом типе, порядок `(Y, Z, ...)` может отличаться от порядка исходных аргументов `[Y, Z, ...]` из-за кеширования типов. Для неподдерживаемых объектов возвращается `()`. Примеры: ```python assert get_args(int) == () assert get_args(Dict[int, str]) == (int, str) assert get_args(Union[int, str]) == (int, str) ``` Новое в версии 3.8. #### `typing.is_typeddict(tp)` Проверяет, является ли тип [`TypedDict`](https://python-all.ru/3.11/library/typing.html#typing.TypedDict). Например: ```python class Film(TypedDict): title: str year: int assert is_typeddict(Film) assert not is_typeddict(list | str) # TypedDict – это фабрика для создания типизированных словарей, # а не сам типизированный словарь assert not is_typeddict(TypedDict) ``` Новое в версии 3.10. #### `class typing.ForwardRef` Класс для внутреннего представления строковых прямых ссылок в typing. Например, `List["SomeClass"]` неявно преобразуется в `List[ForwardRef("SomeClass")]`. `ForwardRef` не должен создаваться пользователем, но может использоваться инструментами интроспекции. > **Примечание** > > обобщённые типы [**PEP 585**](https://python-all.ru/3.11/library/typing.html), такие как `list["SomeClass"]`, не будут неявно преобразовываться в `list[ForwardRef("SomeClass")]` и, следовательно, не будут автоматически разрешаться в `list[SomeClass]`. Новое в версии 3.7.4. ### Константа #### `typing.TYPE_CHECKING` Специальная константа, которая, как считается, равна `True` для сторонних статических анализаторов типов. Во время выполнения её значение – `False`. Использование: ```python if TYPE_CHECKING: import expensive_mod def fun(arg: 'expensive_mod.SomeType') -> None: local_var: expensive_mod.AnotherType = other_fun() ``` Первую аннотацию типа необходимо заключать в кавычки, превращая её в «прямую ссылку» (forward reference), чтобы скрыть ссылку `expensive_mod` от интерпретатора во время выполнения. Аннотации типов для локальных переменных не вычисляются, поэтому вторую аннотацию не нужно заключать в кавычки. > **Примечание** > > Если используется `from __future__ import annotations`, аннотации не вычисляются во время определения функции. Вместо этого они сохраняются как строки в `__annotations__`. Это избавляет от необходимости заключать аннотацию в кавычки (см. [**PEP 563**](https://python-all.ru/3.11/library/typing.html)). Новое в версии 3.5.2. ### Устаревшие псевдонимы Этот модуль определяет несколько устаревших псевдонимов для уже существующих классов стандартной библиотеки. Изначально они были включены в модуль typing для поддержки параметризации этих обобщённых классов с помощью `[]`. Однако эти псевдонимы стали избыточными в Python 3.9, когда соответствующие существующие классы были расширены для поддержки `[]` (см. [**PEP 585**](https://python-all.ru/3.11/library/typing.html)). Избыточные типы считаются устаревшими начиная с Python 3.9. Однако, хотя псевдонимы могут быть удалены в какой-то момент, их удаление в настоящее время не планируется. Поэтому в настоящее время интерпретатор не выдаёт предупреждений об устаревании для этих псевдонимов. Если в какой-то момент будет принято решение удалить эти устаревшие псевдонимы, интерпретатор будет выдавать предупреждение об устаревании как минимум за два релиза до удаления. Псевдонимы гарантированно останутся в модуле typing без предупреждений об устаревании как минимум до Python 3.14. Проверяющим типы рекомендуется отмечать использование устаревших типов, если проверяемая программа нацелена на минимальную версию Python 3.9 или новее. #### Псевдонимы встроенных типов #### `class typing.Dict(dict, MutableMapping[KT, VT])` Устаревший псевдоним [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict). Обратите внимание, что для аннотации аргументов предпочтительнее использовать абстрактный тип коллекции, такой как [`Mapping`](https://python-all.ru/3.11/library/typing.html#typing.Mapping), а не [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict) или `typing.Dict`. Этот тип можно использовать следующим образом: ```python def count_words(text: str) -> Dict[str, int]: ... ``` Deprecated since version 3.9: [`builtins.dict`](https://python-all.ru/3.11/library/stdtypes.html#dict) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.List(list, MutableSequence[T])` Устаревший псевдоним [`list`](https://python-all.ru/3.11/library/stdtypes.html#list). Обратите внимание, что для аннотации аргументов предпочтительнее использовать абстрактный тип коллекции, такой как [`Sequence`](https://python-all.ru/3.11/library/typing.html#typing.Sequence) или [`Iterable`](https://python-all.ru/3.11/library/typing.html#typing.Iterable), а не [`list`](https://python-all.ru/3.11/library/stdtypes.html#list) или `typing.List`. Этот тип можно использовать следующим образом: ```python 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] ``` Deprecated since version 3.9: [`builtins.list`](https://python-all.ru/3.11/library/stdtypes.html#list) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Set(set, MutableSet[T])` Устаревший псевдоним [`builtins.set`](https://python-all.ru/3.11/library/stdtypes.html#set). Обратите внимание, что для аннотации аргументов предпочтительнее использовать абстрактный тип коллекции, такой как [`AbstractSet`](https://python-all.ru/3.11/library/typing.html#typing.AbstractSet), а не [`set`](https://python-all.ru/3.11/library/stdtypes.html#set) или `typing.Set`. Deprecated since version 3.9: [`builtins.set`](https://python-all.ru/3.11/library/stdtypes.html#set) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.FrozenSet(frozenset, AbstractSet[T_co])` Устаревший псевдоним [`builtins.frozenset`](https://python-all.ru/3.11/library/stdtypes.html#frozenset). Deprecated since version 3.9: [`builtins.frozenset`](https://python-all.ru/3.11/library/stdtypes.html#frozenset) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `typing.Tuple` Устаревший псевдоним для [`tuple`](https://python-all.ru/3.11/library/stdtypes.html#tuple). [`tuple`](https://python-all.ru/3.11/library/stdtypes.html#tuple) и `Tuple` являются особыми случаями в системе типов; см. [Аннотирование кортежей](https://python-all.ru/3.11/library/typing.html#annotating-tuples) для получения дополнительной информации. Deprecated since version 3.9: [`builtins.tuple`](https://python-all.ru/3.11/library/stdtypes.html#tuple) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Type(Generic[CT_co])` Устаревший псевдоним [`type`](https://python-all.ru/3.11/library/functions.html#type). См. [Тип объектов класса](https://python-all.ru/3.11/library/typing.html#type-of-class-objects) для подробностей об использовании [`type`](https://python-all.ru/3.11/library/functions.html#type) или `typing.Type` в аннотациях типов. Новое в версии 3.5.2. Deprecated since version 3.9: [`builtins.type`](https://python-all.ru/3.11/library/functions.html#type) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### Псевдонимы типов в [`collections`](https://python-all.ru/3.11/library/collections.html#module-collections) #### `class typing.DefaultDict(collections.defaultdict, MutableMapping[KT, VT])` Устаревший псевдоним [`collections.defaultdict`](https://python-all.ru/3.11/library/collections.html#collections.defaultdict). Новое в версии 3.5.2. Deprecated since version 3.9: [`collections.defaultdict`](https://python-all.ru/3.11/library/collections.html#collections.defaultdict) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.OrderedDict(collections.OrderedDict, MutableMapping[KT, VT])` Устаревший псевдоним [`collections.OrderedDict`](https://python-all.ru/3.11/library/collections.html#collections.OrderedDict). Добавлено в версии 3.7.2. Deprecated since version 3.9: [`collections.OrderedDict`](https://python-all.ru/3.11/library/collections.html#collections.OrderedDict) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.ChainMap(collections.ChainMap, MutableMapping[KT, VT])` Устаревший псевдоним [`collections.ChainMap`](https://python-all.ru/3.11/library/collections.html#collections.ChainMap). Новое в версии 3.6.1. Deprecated since version 3.9: [`collections.ChainMap`](https://python-all.ru/3.11/library/collections.html#collections.ChainMap) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Counter(collections.Counter, Dict[T, int])` Устаревший псевдоним [`collections.Counter`](https://python-all.ru/3.11/library/collections.html#collections.Counter). Новое в версии 3.6.1. Deprecated since version 3.9: [`collections.Counter`](https://python-all.ru/3.11/library/collections.html#collections.Counter) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Deque(deque, MutableSequence[T])` Устаревший псевдоним [`collections.deque`](https://python-all.ru/3.11/library/collections.html#collections.deque). Новое в версии 3.6.1. Deprecated since version 3.9: [`collections.deque`](https://python-all.ru/3.11/library/collections.html#collections.deque) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### Псевдонимы для других конкретных типов #### `class typing.Pattern` #### `class typing.Match` Устаревшие псевдонимы, соответствующие типам возвращаемых значений из [`re.compile()`](https://python-all.ru/3.11/library/re.html#re.compile) и [`re.match()`](https://python-all.ru/3.11/library/re.html#re.match). Эти типы (и соответствующие функции) являются обобщёнными относительно [`AnyStr`](https://python-all.ru/3.11/library/typing.html#typing.AnyStr). `Pattern` может быть специализирован как `Pattern[str]` или `Pattern[bytes]`; `Match` может быть специализирован как `Match[str]` или `Match[bytes]`. Устарело с версии 3.8, будет удалено в версии 3.13: Пространство имён `typing.re` устарело и будет удалено. Эти типы следует импортировать напрямую из `typing`. Устарело с версии 3.9: Классы `Pattern` и `Match` из [`re`](https://python-all.ru/3.11/library/re.html#module-re) теперь поддерживают `[]`. См. [**PEP 585**](https://python-all.ru/3.11/library/typing.html) и [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Text` Устаревший псевдоним для [`str`](https://python-all.ru/3.11/library/stdtypes.html#str). `Text` предоставляется для обеспечения совместимости с кодом Python 2: в Python 2 `Text` является псевдонимом для `unicode`. Используйте `Text`, чтобы указать, что значение должно содержать строку Unicode, совместимую как с Python 2, так и с Python 3: ```python def add_unicode_checkmark(text: Text) -> Text: return text + u' \u2713' ``` Новое в версии 3.5.2. Устарело с версии 3.11: Python 2 больше не поддерживается, и большинство проверщиков типов также больше не поддерживают проверку типов для кода Python 2. Удаление псевдонима в настоящее время не планируется, но пользователям рекомендуется использовать [`str`](https://python-all.ru/3.11/library/stdtypes.html#str) вместо `Text`. #### Псевдонимы для контейнерных ABC в [`collections.abc`](https://python-all.ru/3.11/library/collections.abc.html#module-collections.abc) #### `class typing.AbstractSet(Collection[T_co])` Устаревший псевдоним [`collections.abc.Set`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Set). Deprecated since version 3.9: [`collections.abc.Set`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Set) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.ByteString(Sequence[int])` Этот тип представляет типы [`bytes`](https://python-all.ru/3.11/library/stdtypes.html#bytes), [`bytearray`](https://python-all.ru/3.11/library/stdtypes.html#bytearray) и [`memoryview`](https://python-all.ru/3.11/library/stdtypes.html#memoryview) последовательностей байтов. Устарело с версии 3.9, будет удалено в версии 3.14: Предпочтительнее использовать `typing_extensions.Buffer` или объединение наподобие `bytes | bytearray | memoryview`. #### `class typing.Collection(Sized, Iterable[T_co], Container[T_co])` Устаревший псевдоним [`collections.abc.Collection`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Collection). Новое в версии 3.6. Deprecated since version 3.9: [`collections.abc.Collection`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Collection) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Container(Generic[T_co])` Устаревший псевдоним [`collections.abc.Container`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Container). Deprecated since version 3.9: [`collections.abc.Container`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Container) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.ItemsView(MappingView, AbstractSet[tuple[KT_co, VT_co]])` Устаревший псевдоним [`collections.abc.ItemsView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.ItemsView). Deprecated since version 3.9: [`collections.abc.ItemsView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.ItemsView) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.KeysView(MappingView, AbstractSet[KT_co])` Устаревший псевдоним [`collections.abc.KeysView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.KeysView). Deprecated since version 3.9: [`collections.abc.KeysView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.KeysView) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Mapping(Collection[KT], Generic[KT, VT_co])` Устаревший псевдоним [`collections.abc.Mapping`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Mapping). Этот тип можно использовать следующим образом: ```python def get_position_in_index(word_list: Mapping[str, int], word: str) -> int: return word_list[word] ``` Deprecated since version 3.9: [`collections.abc.Mapping`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Mapping) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.MappingView(Sized)` Устаревший псевдоним [`collections.abc.MappingView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MappingView). Deprecated since version 3.9: [`collections.abc.MappingView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MappingView) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.MutableMapping(Mapping[KT, VT])` Устаревший псевдоним [`collections.abc.MutableMapping`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MutableMapping). Deprecated since version 3.9: [`collections.abc.MutableMapping`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MutableMapping) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.MutableSequence(Sequence[T])` Устаревший псевдоним [`collections.abc.MutableSequence`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MutableSequence). Deprecated since version 3.9: [`collections.abc.MutableSequence`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MutableSequence) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.MutableSet(AbstractSet[T])` Устаревший псевдоним [`collections.abc.MutableSet`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MutableSet). Deprecated since version 3.9: [`collections.abc.MutableSet`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MutableSet) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Sequence(Reversible[T_co], Collection[T_co])` Устаревший псевдоним [`collections.abc.Sequence`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Sequence). Deprecated since version 3.9: [`collections.abc.Sequence`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Sequence) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.ValuesView(MappingView, Collection[_VT_co])` Устаревший псевдоним [`collections.abc.ValuesView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.ValuesView). Deprecated since version 3.9: [`collections.abc.ValuesView`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.ValuesView) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### Псевдонимы для асинхронных ABC в [`collections.abc`](https://python-all.ru/3.11/library/collections.abc.html#module-collections.abc) #### `class typing.Coroutine(Awaitable[ReturnType], Generic[YieldType, SendType, ReturnType])` Устаревший псевдоним [`collections.abc.Coroutine`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Coroutine). Вариативность и порядок переменных типа соответствуют тому же, что и в [`Generator`](https://python-all.ru/3.11/library/typing.html#typing.Generator), например: ```python from collections.abc import Coroutine c: Coroutine[list[str], str, int] # Некоторая корутина, определённая в другом месте. x = c.send('hi') # Выведенный тип 'x' – list[str]. async def bar() -> None: y = await c # Выведенный тип 'y' – int. ``` Новое в версии 3.5.3. Deprecated since version 3.9: [`collections.abc.Coroutine`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Coroutine) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.AsyncGenerator(AsyncIterator[YieldType], Generic[YieldType, SendType])` Устаревший псевдоним [`collections.abc.AsyncGenerator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.AsyncGenerator). Асинхронный генератор можно аннотировать обобщённым типом `AsyncGenerator[YieldType, SendType]`. Например: ```python async def echo_round() -> AsyncGenerator[int, float]: sent = yield 0 while sent >= 0.0: rounded = await round(sent) sent = yield rounded ``` В отличие от обычных генераторов, асинхронные генераторы не могут возвращать значение, поэтому параметр типа `ReturnType` отсутствует. Как и в случае с [`Generator`](https://python-all.ru/3.11/library/typing.html#typing.Generator), `SendType` ведёт себя контравариантно. Если генератор только выдаёт значения, установите `SendType` в `None`: ```python async def infinite_stream(start: int) -> AsyncGenerator[int, None]: while True: yield start start = await increment(start) ``` В качестве альтернативы аннотируйте генератор как имеющий тип возвращаемого значения либо `AsyncIterable[YieldType]`, либо `AsyncIterator[YieldType]`: ```python async def infinite_stream(start: int) -> AsyncIterator[int]: while True: yield start start = await increment(start) ``` Новое в версии 3.6.1. Deprecated since version 3.9: [`collections.abc.AsyncGenerator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.AsyncGenerator) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.AsyncIterable(Generic[T_co])` Устаревший псевдоним [`collections.abc.AsyncIterable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.AsyncIterable). Новое в версии 3.5.2. Deprecated since version 3.9: [`collections.abc.AsyncIterable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.AsyncIterable) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.AsyncIterator(AsyncIterable[T_co])` Устаревший псевдоним [`collections.abc.AsyncIterator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.AsyncIterator). Новое в версии 3.5.2. Deprecated since version 3.9: [`collections.abc.AsyncIterator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.AsyncIterator) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Awaitable(Generic[T_co])` Устаревший псевдоним [`collections.abc.Awaitable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Awaitable). Новое в версии 3.5.2. Deprecated since version 3.9: [`collections.abc.Awaitable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Awaitable) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### Псевдонимы для других ABC в [`collections.abc`](https://python-all.ru/3.11/library/collections.abc.html#module-collections.abc) #### `class typing.Iterable(Generic[T_co])` Устаревший псевдоним [`collections.abc.Iterable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Iterable). Deprecated since version 3.9: [`collections.abc.Iterable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Iterable) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Iterator(Iterable[T_co])` Устаревший псевдоним [`collections.abc.Iterator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Iterator). Deprecated since version 3.9: [`collections.abc.Iterator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Iterator) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `typing.Callable` Устаревший псевдоним [`collections.abc.Callable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Callable). See [Annotating callable objects](https://python-all.ru/3.11/library/typing.html#annotating-callables) for details on how to use [`collections.abc.Callable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Callable) and `typing.Callable` in type annotations. Deprecated since version 3.9: [`collections.abc.Callable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Callable) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). Changed in version 3.10: `Callable` now supports [`ParamSpec`](https://python-all.ru/3.11/library/typing.html#typing.ParamSpec) and [`Concatenate`](https://python-all.ru/3.11/library/typing.html#typing.Concatenate). See [**PEP 612**](https://python-all.ru/3.11/library/typing.html) for more details. #### `class typing.Generator(Iterator[YieldType], Generic[YieldType, SendType, ReturnType])` Устаревший псевдоним [`collections.abc.Generator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Generator). Генератор можно аннотировать обобщённым типом `Generator[YieldType, SendType, ReturnType]`. Например: ```python def echo_round() -> Generator[int, float, str]: sent = yield 0 while sent >= 0: sent = yield round(sent) return 'Done' ``` Обратите внимание: в отличие от многих других обобщённых типов в модуле typing, `SendType` из [`Generator`](https://python-all.ru/3.11/library/typing.html#typing.Generator) ведёт себя контравариантно, а не ковариантно или инвариантно. Если ваш генератор будет только выдавать значения, установите `SendType` и `ReturnType` в `None`: ```python def infinite_stream(start: int) -> Generator[int, None, None]: while True: yield start start += 1 ``` В качестве альтернативы аннотируйте генератор как имеющий тип возвращаемого значения либо `Iterable[YieldType]`, либо `Iterator[YieldType]`: ```python def infinite_stream(start: int) -> Iterator[int]: while True: yield start start += 1 ``` Deprecated since version 3.9: [`collections.abc.Generator`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Generator) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Hashable` Псевдоним для [`collections.abc.Hashable`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Hashable). #### `class typing.Reversible(Iterable[T_co])` Устаревший псевдоним [`collections.abc.Reversible`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Reversible). Deprecated since version 3.9: [`collections.abc.Reversible`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Reversible) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.Sized` Псевдоним для [`collections.abc.Sized`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.Sized). #### Псевдонимы для [`contextlib`](https://python-all.ru/3.11/library/contextlib.html#module-contextlib) ABCs #### `class typing.ContextManager(Generic[T_co])` Устаревший псевдоним [`contextlib.AbstractContextManager`](https://python-all.ru/3.11/library/contextlib.html#contextlib.AbstractContextManager). Новое в версии 3.5.4. Deprecated since version 3.9: [`contextlib.AbstractContextManager`](https://python-all.ru/3.11/library/contextlib.html#contextlib.AbstractContextManager) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). #### `class typing.AsyncContextManager(Generic[T_co])` Устаревший псевдоним [`contextlib.AbstractAsyncContextManager`](https://python-all.ru/3.11/library/contextlib.html#contextlib.AbstractAsyncContextManager). Новое в версии 3.6.2. Deprecated since version 3.9: [`contextlib.AbstractAsyncContextManager`](https://python-all.ru/3.11/library/contextlib.html#contextlib.AbstractAsyncContextManager) now supports subscripting (`[]`). See [**PEP 585**](https://python-all.ru/3.11/library/typing.html) and [Generic Alias Type](https://python-all.ru/3.11/library/stdtypes.html#types-genericalias). ## Хронология устаревания основных возможностей Некоторые возможности в `typing` устарели и могут быть удалены в будущей версии Python. Для удобства ниже приведена таблица с основными устаревшими элементами. Она может изменяться, и в ней перечислены не все устаревшие возможности. | Возможность | Устарело в | Планируемое удаление | PEP/issue | | --- | --- | --- | --- | | `typing.io` и `typing.re` подмодули | 3.8 | 3.13 | [bpo-38291](https://python-all.ru/3.11/library/typing.html) | | `typing` версии стандартных коллекций | 3.9 | Не определено (см. [устаревшие псевдонимы](https://python-all.ru/3.11/library/typing.html#deprecated-typing-aliases) для дополнительной информации) | [**PEP 585**](https://python-all.ru/3.11/library/typing.html) | | [`typing.ByteString`](https://python-all.ru/3.11/library/typing.html#typing.ByteString) | 3.9 | 3.14 | [gh-91896](https://python-all.ru/3.11/library/typing.html) | | [`typing.Text`](https://python-all.ru/3.11/library/typing.html#typing.Text) | 3.11 | Не определено | [gh-92332](https://python-all.ru/3.11/library/typing.html) |