`typing` — Підтримка підказок типу¶

Нове в версії 3.5.

Вихідний код: Lib/typing.py

Примітка

The Python runtime does not enforce function and variable type annotations. They can be used by third party tools such as type checkers, IDEs, linters, etc.

This module provides runtime support for type hints as specified by PEP 484, PEP 526, PEP 544, PEP 586, PEP 589, and PEP 591. The most fundamental support consists of the types Any, Union, Tuple, Callable, TypeVar, and Generic. For full specification please see PEP 484. For a simplified introduction to type hints see PEP 483.

The function below takes and returns a string and is annotated as follows:

def greeting(name: str) -> str:
    return 'Hello ' + name

In the function greeting, the argument name is expected to be of type str and the return type str. Subtypes are accepted as arguments.

Псевдоніми типів¶

A type alias is defined by assigning the type to the alias. In this example, Vector and List[float] will be treated as interchangeable synonyms:

from typing import List
Vector = List[float]

def scale(scalar: float, vector: Vector) -> Vector:
    return [scalar * num for num in vector]

# typechecks; a list of floats qualifies as a Vector.
new_vector = scale(2.0, [1.0, -4.2, 5.4])

Псевдоніми типів корисні для спрощення анотацій складних типів. Наприклад:

from typing import Dict, Tuple, Sequence

ConnectionOptions = Dict[str, str]
Address = Tuple[str, int]
Server = Tuple[Address, ConnectionOptions]

def broadcast_message(message: str, servers: Sequence[Server]) -> None:
    ...

# The static type checker will treat the previous type signature as
# being exactly equivalent to this one.
def broadcast_message(
        message: str,
        servers: Sequence[Tuple[Tuple[str, int], Dict[str, str]]]) -> None:
    ...

Note that None as a type hint is a special case and is replaced by type(None).

NewType¶

Use the NewType() helper function to create distinct types:

from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)

Аналізатор типів розглядатиме новий тип як підклас вихідного типу. Це корисно для виявлення логічних помилок:

def get_user_name(user_id: UserId) -> str:
    ...

# typechecks
user_a = get_user_name(UserId(42351))

# does not typecheck; an int is not a UserId
user_b = get_user_name(-1)

Ви все ще можете виконувати всі операції int зі змінною типу UserId, але результат завжди матиме тип int. Це дозволяє передавати UserId усюди, де можна очікувати int, але запобігає випадковому створенню UserId недійсним способом:

# 'output' is of type 'int', not 'UserId'
output = UserId(23413) + UserId(54341)

Note that these checks are enforced only by the static type checker. At runtime, the statement Derived = NewType('Derived', Base) will make Derived a function that immediately returns whatever parameter you pass it. That means the expression Derived(some_value) does not create a new class or introduce any overhead beyond that of a regular function call.

Точніше, вираз some_value is Derived(some_value) завжди вірний під час виконання.

This also means that it is not possible to create a subtype of Derived since it is an identity function at runtime, not an actual type:

from typing import NewType

UserId = NewType('UserId', int)

# Fails at runtime and does not typecheck
class AdminUserId(UserId): pass

However, it is possible to create a NewType() based on a „derived“ NewType:

from typing import NewType

UserId = NewType('UserId', int)

ProUserId = NewType('ProUserId', UserId)

і аналіз типів для ProUserId працюватиме належним чином.

Дивіться PEP 484 для більш детальної інформації.

Примітка

Recall that the use of a type alias declares two types to be equivalent to one another. Doing Alias = Original will make the static type checker treat Alias as being exactly equivalent to Original in all cases. This is useful when you want to simplify complex type signatures.

На відміну, NewType оголошує один тип як підтип іншого. Якщо виконати Derived = NewType('Derived', Original), аналізатор типів розглядатиме Derived як підклас Original, що означає значення типу Original не можна використовувати там, де очікується значення типу Derived. Це корисно, коли ви хочете запобігти логічним помилкам з мінімальними витратами на виконання.

Нове в версії 3.5.2.

Callable¶

Frameworks expecting callback functions of specific signatures might be type hinted using Callable[[Arg1Type, Arg2Type], ReturnType].

Наприклад:

from typing import Callable

def feeder(get_next_item: Callable[[], str]) -> None:
    # Body

def async_query(on_success: Callable[[int], None],
                on_error: Callable[[int, Exception], None]) -> None:
    # Body

It is possible to declare the return type of a callable without specifying the call signature by substituting a literal ellipsis for the list of arguments in the type hint: Callable[..., ReturnType].

Узагальнення¶

Since type information about objects kept in containers cannot be statically inferred in a generic way, abstract base classes have been extended to support subscription to denote expected types for container elements.

from typing import Mapping, Sequence

def notify_by_email(employees: Sequence[Employee],
                    overrides: Mapping[str, str]) -> None: ...

Generics can be parameterized by using a new factory available in typing called TypeVar.

from typing import Sequence, TypeVar

T = TypeVar('T')      # Declare type variable

def first(l: Sequence[T]) -> T:   # Generic function
    return l[0]

Визначені користувачем загальні типи¶

Визначений користувачем клас можна визначити як загальний клас.

from typing import TypeVar, Generic
from logging import Logger

T = TypeVar('T')

class LoggedVar(Generic[T]):
    def __init__(self, value: T, name: str, logger: Logger) -> None:
        self.name = name
        self.logger = logger
        self.value = value

    def set(self, new: T) -> None:
        self.log('Set ' + repr(self.value))
        self.value = new

    def get(self) -> T:
        self.log('Get ' + repr(self.value))
        return self.value

    def log(self, message: str) -> None:
        self.logger.info('%s: %s', self.name, message)

Generic[T] as a base class defines that the class LoggedVar takes a single type parameter T . This also makes T valid as a type within the class body.

The Generic base class defines __class_getitem__() so that LoggedVar[t] is valid as a type:

from typing import Iterable

def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
    for var in vars:
        var.set(0)

A generic type can have any number of type variables, and type variables may be constrained:

from typing import TypeVar, Generic
...

T = TypeVar('T')
S = TypeVar('S', int, str)

class StrangePair(Generic[T, S]):
    ...

Кожен аргумент змінної типу для Generic має бути окремим. Таким чином, це недійсно:

from typing import TypeVar, Generic
...

T = TypeVar('T')

class Pair(Generic[T, T]):   # INVALID
    ...

You can use multiple inheritance with Generic:

from typing import TypeVar, Generic, Sized

T = TypeVar('T')

class LinkedList(Sized, Generic[T]):
    ...

When inheriting from generic classes, some type variables could be fixed:

from typing import TypeVar, Mapping

T = TypeVar('T')

class MyDict(Mapping[str, T]):
    ...

У цьому випадку MyDict має єдиний параметр, T.

Using a generic class without specifying type parameters assumes Any for each position. In the following example, MyIterable is not generic but implicitly inherits from Iterable[Any]:

from typing import Iterable

class MyIterable(Iterable): # Same as Iterable[Any]

User defined generic type aliases are also supported. Examples:

from typing import TypeVar, Iterable, Tuple, Union
S = TypeVar('S')
Response = Union[Iterable[S], int]

# Return type here is same as Union[Iterable[str], int]
def response(query: str) -> Response[str]:
    ...

T = TypeVar('T', int, float, complex)
Vec = Iterable[Tuple[T, T]]

def inproduct(v: Vec[T]) -> T: # Same as Iterable[Tuple[T, T]]
    return sum(x*y for x, y in v)

Змінено в версії 3.7: Generic більше не має спеціального метакласу.

A user-defined generic class can have ABCs as base classes without a metaclass conflict. Generic metaclasses are not supported. The outcome of parameterizing generics is cached, and most types in the typing module are hashable and comparable for equality.

Тип `Any`¶

Особливий вид типу — Any. Засіб перевірки статичних типів розглядатиме кожен тип як сумісний із Any і Any як сумісні з кожним типом.

Це означає, що можна виконати будь-яку операцію або викликати метод над значенням типу Any і призначити його будь-якій змінній:

from typing import Any

a = None    # type: Any
a = []      # OK
a = 2       # OK

s = ''      # type: str
s = a       # OK

def foo(item: Any) -> int:
    # Typechecks; 'item' could be any type,
    # and that type might have a 'bar' method
    item.bar()
    ...

Notice that no typechecking is performed when assigning a value of type Any to a more precise type. For example, the static type checker did not report an error when assigning a to s even though s was declared to be of type str and receives an int value at runtime!

Крім того, усі функції без типу повернення або типів параметрів неявно використовуватимуть за умовчанням Any:

def legacy_parser(text):
    ...
    return data

# A static type checker will treat the above
# as having the same signature as:
def legacy_parser(text: Any) -> Any:
    ...
    return data

Така поведінка дозволяє Any використовувати як вихідний люк, коли вам потрібно змішати динамічний і статичний код.

Порівняйте поведінку Any з поведінкою object. Подібно до Any, кожен тип є підтипом object. Однак, на відміну від Any, зворотне не вірно: object не є підтипом будь-якого іншого типу.

Це означає, що коли тип значення object, засіб перевірки типів відхилить майже всі операції над ним, а присвоєння його змінній (або використання її як значення, що повертається) більш спеціалізованого типу є типом помилка. Наприклад:

def hash_a(item: object) -> int:
    # Fails; an object does not have a 'magic' method.
    item.magic()
    ...

def hash_b(item: Any) -> int:
    # Typechecks
    item.magic()
    ...

# Typechecks, since ints and strs are subclasses of object
hash_a(42)
hash_a("foo")

# Typechecks, since Any is compatible with all types
hash_b(42)
hash_b("foo")

Використовуйте object, щоб вказати, що значення може мати будь-який тип у безпечний спосіб. Використовуйте Any, щоб вказати, що значення вводиться динамічно.

Номінальний проти структурного підтипу¶

Initially PEP 484 defined Python static type system as using nominal subtyping. This means that a class A is allowed where a class B is expected if and only if A is a subclass of B.

Ця вимога раніше також застосовувалася до абстрактних базових класів, таких як Iterable. Проблема з цим підходом полягає в тому, що клас повинен бути явно позначений для їх підтримки, що не є пітонічним і не схожим на те, що зазвичай робили б у ідіоматичному динамічно введеному коді Python. Наприклад, це відповідає PEP 484:

from typing import Sized, Iterable, Iterator

class Bucket(Sized, Iterable[int]):
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...

PEP 544 дозволяє вирішити цю проблему, дозволяючи користувачам писати наведений вище код без явних базових класів у визначенні класу, дозволяючи Bucket неявно вважатися підтипом як Sized, так і Iterable[int] засобами перевірки статичних типів. Це відоме як структурне підтипування (або статичне качине типування):

from typing import Iterator, Iterable

class Bucket:  # Note: no base classes
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...

def collect(items: Iterable[int]) -> int: ...
result = collect(Bucket())  # Passes type check

Крім того, створивши підклас спеціального класу Protocol, користувач може визначати нові користувальницькі протоколи, щоб повною мірою користуватися структурними підтипами (див. приклади нижче).

Classes, functions, and decorators¶

The module defines the following classes, functions and decorators:

class typing.TypeVar¶

Тип змінної.

Використання:

T = TypeVar('T')  # Can be anything
A = TypeVar('A', str, bytes)  # Must be str or bytes

Type variables exist primarily for the benefit of static type checkers. They serve as the parameters for generic types as well as for generic function definitions. See class Generic for more information on generic types. Generic functions work as follows:

def repeat(x: T, n: int) -> Sequence[T]:
    """Return a list containing n references to x."""
    return [x]*n

def longest(x: A, y: A) -> A:
    """Return the longest of two strings."""
    return x if len(x) >= len(y) else y

The latter example’s signature is essentially the overloading of (str, str) -> str and (bytes, bytes) -> bytes. Also note that if the arguments are instances of some subclass of str, the return type is still plain str.

At runtime, isinstance(x, T) will raise TypeError. In general, isinstance() and issubclass() should not be used with types.

Type variables may be marked covariant or contravariant by passing covariant=True or contravariant=True. See PEP 484 for more details. By default type variables are invariant. Alternatively, a type variable may specify an upper bound using bound=<type>. This means that an actual type substituted (explicitly or implicitly) for the type variable must be a subclass of the boundary type, see PEP 484.

class typing.Generic¶

Абстрактний базовий клас для загальних типів.

A generic type is typically declared by inheriting from an instantiation of this class with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
        # Etc.

Потім цей клас можна використовувати наступним чином:

X = TypeVar('X')
Y = TypeVar('Y')

def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y:
    try:
        return mapping[key]
    except KeyError:
        return default

class typing.Protocol(Generic)¶

Base class for protocol classes. Protocol classes are defined like this:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Такі класи в основному використовуються із засобами перевірки статичних типів, які розпізнають структурні підтипи (статичне типування), наприклад:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with runtime_checkable() (described later) act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures.

Класи протоколів можуть бути загальними, наприклад:

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...

Нове в версії 3.8.

class typing.Type(Generic[CT_co])¶

A variable annotated with C may accept a value of type C. In contrast, a variable annotated with Type[C] may accept values that are classes themselves – specifically, it will accept the class object of C. For example:

a = 3         # Has type 'int'
b = int       # Has type 'Type[int]'
c = type(a)   # Also has type 'Type[int]'

Note that Type[C] is covariant:

class User: ...
class BasicUser(User): ...
class ProUser(User): ...
class TeamUser(User): ...

# Accepts User, BasicUser, ProUser, TeamUser, ...
def make_new_user(user_class: Type[User]) -> User:
    # ...
    return user_class()

The fact that Type[C] is covariant implies that all subclasses of C should implement the same constructor signature and class method signatures as C. The type checker should flag violations of this, but should also allow constructor calls in subclasses that match the constructor calls in the indicated base class. How the type checker is required to handle this particular case may change in future revisions of PEP 484.

The only legal parameters for Type are classes, Any, type variables, and unions of any of these types. For example:

def new_non_team_user(user_class: Type[Union[BasicUser, ProUser]]): ...

Type[Any] is equivalent to Type which in turn is equivalent to type, which is the root of Python’s metaclass hierarchy.

Нове в версії 3.5.2.

class typing.Iterable(Generic[T_co])¶: A generic version of collections.abc.Iterable.

class typing.Iterator(Iterable[T_co])¶: A generic version of collections.abc.Iterator.

class typing.Reversible(Iterable[T_co])¶: A generic version of collections.abc.Reversible.

class typing.SupportsInt¶: ABC з одним абстрактним методом __int__.

class typing.SupportsFloat¶: ABC з одним абстрактним методом __float__.

class typing.SupportsComplex¶: ABC з одним абстрактним методом __complex__.

class typing.SupportsBytes¶: ABC з одним абстрактним методом __bytes__.

class typing.SupportsIndex¶: ABC з одним абстрактним методом __index__.

Нове в версії 3.8.

class typing.SupportsAbs¶: ABC з одним абстрактним методом __abs__, який є коваріантним у своєму типі повернення.

class typing.SupportsRound¶: ABC з одним абстрактним методом __round__, який є коваріантним у своєму типі повернення.

class typing.Container(Generic[T_co])¶: A generic version of collections.abc.Container.

class typing.Hashable¶: An alias to collections.abc.Hashable

class typing.Sized¶: An alias to collections.abc.Sized

class typing.Collection(Sized, Iterable[T_co], Container[T_co])¶: A generic version of collections.abc.Collection

Нове в версії 3.6.0.

class typing.AbstractSet(Sized, Collection[T_co])¶: A generic version of collections.abc.Set.

class typing.MutableSet(AbstractSet[T])¶: A generic version of collections.abc.MutableSet.

class typing.Mapping(Sized, Collection[KT], Generic[VT_co])¶

A generic version of collections.abc.Mapping. This type can be used as follows:

def get_position_in_index(word_list: Mapping[str, int], word: str) -> int:
    return word_list[word]

class typing.MutableMapping(Mapping[KT, VT])¶: A generic version of collections.abc.MutableMapping.

class typing.Sequence(Reversible[T_co], Collection[T_co])¶: A generic version of collections.abc.Sequence.

class typing.MutableSequence(Sequence[T])¶: A generic version of collections.abc.MutableSequence.

class typing.ByteString(Sequence[int])¶

A generic version of collections.abc.ByteString.

Цей тип представляє типи bytes, bytearray і memoryview послідовностей байтів.

As a shorthand for this type, bytes can be used to annotate arguments of any of the types mentioned above.

class typing.Deque(deque, MutableSequence[T])¶: A generic version of collections.deque.

Нове в версії 3.5.4.

Нове в версії 3.6.1.

class typing.List(list, MutableSequence[T])¶

Generic version of list. Useful for annotating return types. To annotate arguments it is preferred to use an abstract collection type such as Sequence or Iterable.

Цей тип можна використовувати наступним чином:

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]

class typing.Set(set, MutableSet[T])¶: A generic version of builtins.set. Useful for annotating return types. To annotate arguments it is preferred to use an abstract collection type such as AbstractSet.

class typing.FrozenSet(frozenset, AbstractSet[T_co])¶: A generic version of builtins.frozenset.

class typing.MappingView(Sized, Iterable[T_co])¶: A generic version of collections.abc.MappingView.

class typing.KeysView(MappingView[KT_co], AbstractSet[KT_co])¶: A generic version of collections.abc.KeysView.

class typing.ItemsView(MappingView, Generic[KT_co, VT_co])¶: A generic version of collections.abc.ItemsView.

class typing.ValuesView(MappingView[VT_co])¶: A generic version of collections.abc.ValuesView.

class typing.Awaitable(Generic[T_co])¶: A generic version of collections.abc.Awaitable.

Нове в версії 3.5.2.

class typing.Coroutine(Awaitable[V_co], Generic[T_co, T_contra, V_co])¶

A generic version of collections.abc.Coroutine. The variance and order of type variables correspond to those of Generator, for example:

from typing import List, Coroutine
c = None # type: Coroutine[List[str], str, int]
...
x = c.send('hi') # type: List[str]
async def bar() -> None:
    x = await c # type: int

Нове в версії 3.5.3.

class typing.AsyncIterable(Generic[T_co])¶: A generic version of collections.abc.AsyncIterable.

Нове в версії 3.5.2.

class typing.AsyncIterator(AsyncIterable[T_co])¶: A generic version of collections.abc.AsyncIterator.

Нове в версії 3.5.2.

class typing.ContextManager(Generic[T_co])¶: A generic version of contextlib.AbstractContextManager.

Нове в версії 3.5.4.

Нове в версії 3.6.0.

class typing.AsyncContextManager(Generic[T_co])¶: A generic version of contextlib.AbstractAsyncContextManager.

Нове в версії 3.5.4.

Нове в версії 3.6.2.

class typing.Dict(dict, MutableMapping[KT, VT])¶

A generic version of dict. Useful for annotating return types. To annotate arguments it is preferred to use an abstract collection type such as Mapping.

Цей тип можна використовувати наступним чином:

def count_words(text: str) -> Dict[str, int]:
    ...

class typing.DefaultDict(collections.defaultdict, MutableMapping[KT, VT])¶: A generic version of collections.defaultdict.

Нове в версії 3.5.2.

class typing.OrderedDict(collections.OrderedDict, MutableMapping[KT, VT])¶: A generic version of collections.OrderedDict.

Нове в версії 3.7.2.

class typing.Counter(collections.Counter, Dict[T, int])¶: A generic version of collections.Counter.

Нове в версії 3.5.4.

Нове в версії 3.6.1.

class typing.ChainMap(collections.ChainMap, MutableMapping[KT, VT])¶: A generic version of collections.ChainMap.

Нове в версії 3.5.4.

Нове в версії 3.6.1.

class typing.Generator(Iterator[T_co], Generic[T_co, T_contra, V_co])¶

Генератор може бути анотований загальним типом Generator[YieldType, SendType, ReturnType]. Наприклад:

def echo_round() -> Generator[int, float, str]:
    sent = yield 0
    while sent >= 0:
        sent = yield round(sent)
    return 'Done'

Зауважте, що на відміну від багатьох інших загальних засобів у модулі введення, SendType Generator поводиться контраваріантно, а не коваріантно чи інваріантно.

If your generator will only yield values, set the SendType and ReturnType to None:

def infinite_stream(start: int) -> Generator[int, None, None]:
    while True:
        yield start
        start += 1

Крім того, позначте свій генератор як такий, що має тип повернення Iterable[YieldType] або Iterator[YieldType]:

def infinite_stream(start: int) -> Iterator[int]:
    while True:
        yield start
        start += 1

class typing.AsyncGenerator(AsyncIterator[T_co], Generic[T_co, T_contra])¶

Асинхронний генератор може бути анотований загальним типом AsyncGenerator[YieldType, SendType]. Наприклад:

async def echo_round() -> AsyncGenerator[int, float]:
    sent = yield 0
    while sent >= 0.0:
        rounded = await round(sent)
        sent = yield rounded

На відміну від звичайних генераторів, асинхронні генератори не можуть повертати значення, тому немає параметра типу ReturnType. Як і Generator, SendType поводиться протилежно.

If your generator will only yield values, set the SendType to None:

async def infinite_stream(start: int) -> AsyncGenerator[int, None]:
    while True:
        yield start
        start = await increment(start)

Крім того, позначте свій генератор як такий, що має тип повернення AsyncIterable[YieldType] або AsyncIterator[YieldType]:

async def infinite_stream(start: int) -> AsyncIterator[int]:
    while True:
        yield start
        start = await increment(start)

Нове в версії 3.6.1.

class typing.Text¶

Text is an alias for str. It is provided to supply a forward compatible path for Python 2 code: in Python 2, Text is an alias for unicode.

Використовуйте Текст, щоб вказати, що значення має містити рядок Юнікод у спосіб, сумісний як з Python 2, так і з Python 3:

def add_unicode_checkmark(text: Text) -> Text:
    return text + u' \u2713'

Нове в версії 3.5.2.

class typing.IO¶
class typing.TextIO¶
class typing.BinaryIO¶: Загальний тип IO[AnyStr] і його підкласи TextIO(IO[str]) і BinaryIO(IO[bytes]) представляють типи потоків вводу/виводу, такі як повертаються open().

class typing.Pattern¶
class typing.Match¶: These type aliases correspond to the return types from re.compile() and re.match(). These types (and the corresponding functions) are generic in AnyStr and can be made specific by writing Pattern[str], Pattern[bytes], Match[str], or Match[bytes].

class typing.NamedTuple¶

Введена версія collections.namedtuple().

Використання:

class Employee(NamedTuple):
    name: str
    id: int

Це еквівалентно:

Employee = collections.namedtuple('Employee', ['name', 'id'])

Щоб надати полю значення за замовчуванням, ви можете призначити йому в тілі класу:

class Employee(NamedTuple):
    name: str
    id: int = 3

employee = Employee('Guido')
assert employee.id == 3

Поля зі значенням за замовчуванням мають бути після будь-яких полів без значення за замовчуванням.

The resulting class has an extra attribute __annotations__ giving a dict that maps the field names to the field types. (The field names are in the _fields attribute and the default values are in the _field_defaults attribute both of which are part of the namedtuple API.)

Підкласи NamedTuple також можуть мати рядки документації та методи:

class Employee(NamedTuple):
    """Represents an employee."""
    name: str
    id: int = 3

    def __repr__(self) -> str:
        return f'<Employee {self.name}, id={self.id}>'

Зворотно сумісне використання:

Employee = NamedTuple('Employee', [('name', str), ('id', int)])

Змінено в версії 3.6: Додано підтримку синтаксису анотації змінної PEP 526.

Змінено в версії 3.6.1: Додано підтримку стандартних значень, методів і рядків документів.

Deprecated since version 3.8, will be removed in version 3.9: Deprecated the _field_types attribute in favor of the more standard __annotations__ attribute which has the same information.

Змінено в версії 3.8: Атрибути _field_types і __annotations__ тепер є звичайними словниками замість екземплярів OrderedDict.

class typing.TypedDict(dict)¶

A simple typed namespace. At runtime it is equivalent to a plain dict.

TypedDict creates a dictionary type that expects all of its instances to have a certain set of keys, where each key is associated with a value of a consistent type. This expectation is not checked at runtime but is only enforced by type checkers. Usage:

class Point2D(TypedDict):
    x: int
    y: int
    label: str

a: Point2D = {'x': 1, 'y': 2, 'label': 'good'}  # OK
b: Point2D = {'z': 3, 'label': 'bad'}           # Fails type check

assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')

The type info for introspection can be accessed via Point2D.__annotations__ and Point2D.__total__. To allow using this feature with older versions of Python that do not support PEP 526, TypedDict supports two additional equivalent syntactic forms:

Point2D = TypedDict('Point2D', x=int, y=int, label=str)
Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})

By default, all keys must be present in a TypedDict. It is possible to override this by specifying totality. Usage:

class point2D(TypedDict, total=False):
    x: int
    y: int

This means that a point2D TypedDict can have any of the keys omitted. A type checker is only expected to support a literal False or True as the value of the total argument. True is the default, and makes all items defined in the class body be required.

Перегляньте PEP 589 більше прикладів і детальних правил використання TypedDict.

Нове в версії 3.8.

class typing.ForwardRef¶: A class used for internal typing representation of string forward references. For example, List["SomeClass"] is implicitly transformed into List[ForwardRef("SomeClass")]. This class should not be instantiated by a user, but may be used by introspection tools.

Нове в версії 3.7.4.

typing.NewType(name, tp)¶

A helper function to indicate a distinct type to a typechecker, see NewType. At runtime it returns a function that returns its argument. Usage:

UserId = NewType('UserId', int)
first_user = UserId(1)

Нове в версії 3.5.2.

typing.cast(typ, val)¶

Приведення значення до типу.

Це повертає значення без змін. Для засобу перевірки типів це означає, що значення, що повертається, має визначений тип, але під час виконання ми навмисно нічого не перевіряємо (ми хочемо, щоб це було якомога швидше).

typing.get_type_hints(obj[, globals[, locals]])¶

Повертає словник, що містить підказки типу для функції, методу, модуля або об’єкта класу.

This is often the same as obj.__annotations__. In addition, forward references encoded as string literals are handled by evaluating them in globals and locals namespaces. If necessary, Optional[t] is added for function and method annotations if a default value equal to None is set. For a class C, return a dictionary constructed by merging all the __annotations__ along C.__mro__ in reverse order.

typing.get_origin(tp)¶

typing.get_args(tp)¶

Provide basic introspection for generic types and special typing forms.

For a typing object of the form X[Y, Z, ...] these functions return X and (Y, Z, ...). If X is a generic alias for a builtin or collections class, it gets normalized to the original class. For unsupported objects return None and () correspondingly. Examples:

assert get_origin(Dict[str, int]) is dict
assert get_args(Dict[int, str]) == (int, str)

assert get_origin(Union[int, str]) is Union
assert get_args(Union[int, str]) == (int, str)

Нове в версії 3.8.

@typing.overload¶

The @overload decorator allows describing functions and methods that support multiple different combinations of argument types. A series of @overload-decorated definitions must be followed by exactly one non-@overload-decorated definition (for the same function/method). The @overload-decorated definitions are for the benefit of the type checker only, since they will be overwritten by the non-@overload-decorated definition, while the latter is used at runtime but should be ignored by a type checker. At runtime, calling a @overload-decorated function directly will raise NotImplementedError. An example of overload that gives a more precise type than can be expressed using a union or a type variable:

@overload
def process(response: None) -> None:
    ...
@overload
def process(response: int) -> Tuple[int, str]:
    ...
@overload
def process(response: bytes) -> str:
    ...
def process(response):
    <actual implementation>

See PEP 484 for details and comparison with other typing semantics.

@typing.final¶

A decorator to indicate to type checkers that the decorated method cannot be overridden, and the decorated class cannot be subclassed. For example:

class Base:
    @final
    def done(self) -> None:
        ...
class Sub(Base):
    def done(self) -> None:  # Error reported by type checker
          ...

@final
class Leaf:
    ...
class Other(Leaf):  # Error reported by type checker
    ...

Немає жодної перевірки цих властивостей під час виконання. Дивіться PEP 591 для більш детальної інформації.

Нове в версії 3.8.

@typing.no_type_check¶

Декоратор, щоб вказати, що анотації не є підказками типу.

This works as class or function decorator. With a class, it applies recursively to all methods defined in that class (but not to methods defined in its superclasses or subclasses).

This mutates the function(s) in place.

@typing.no_type_check_decorator¶

Декоратор, щоб надати іншому декоратору ефект no_type_check().

Це обертає декоратор чимось, що обертає декоровану функцію в no_type_check().

@typing.type_check_only¶

Decorator to mark a class or function to be unavailable at runtime.

Сам цей декоратор недоступний під час виконання. В основному він призначений для позначення класів, визначених у файлах-заглушках типу, якщо реалізація повертає екземпляр приватного класу:

@type_check_only
class Response:  # private or not available at runtime
    code: int
    def get_header(self, name: str) -> str: ...

def fetch_response() -> Response: ...

Зауважте, що повертати екземпляри приватних класів не рекомендується. Зазвичай бажано зробити такі заняття публічними.

@typing.runtime_checkable¶

Позначте клас протоколу як протокол виконання.

Такий протокол можна використовувати з isinstance() і issubclass(). Це викликає TypeError, коли застосовується до непротокольного класу. Це дозволяє здійснити просту структурну перевірку, дуже схожу на «поні з одним трюком» у collections.abc, наприклад Iterable. Наприклад:

@runtime_checkable
class Closable(Protocol):
    def close(self): ...

assert isinstance(open('/some/file'), Closable)

Warning: this will check only the presence of the required methods, not their type signatures!

Нове в версії 3.8.

typing.Any¶

Спеціальний тип, що вказує на необмежений тип.

Кожен тип сумісний з Any.
Any сумісний з усіма типами.

typing.NoReturn¶

Special type indicating that a function never returns. For example:

from typing import NoReturn

def stop() -> NoReturn:
    raise RuntimeError('no way')

Нове в версії 3.5.4.

Нове в версії 3.6.2.

typing.Union¶

Union type; Union[X, Y] means either X or Y.

To define a union, use e.g. Union[int, str]. Details:

Аргументи мають бути типами і має бути принаймні один.

Союзи союзів зведені, наприклад:

Union[Union[int, str], float] == Union[int, str, float]

Союзи одного аргументу зникають, наприклад:
```
Union[int] == int  # The constructor actually returns int
```
Зайві аргументи пропускаються, наприклад:
```
Union[int, str, int] == Union[int, str]
```
Під час порівняння об’єднань порядок аргументів ігнорується, наприклад:
```
Union[int, str] == Union[str, int]
```
You cannot subclass or instantiate a union.
Ви не можете писати Union[X][Y].
You can use Optional[X] as a shorthand for Union[X, None].

Змінено в версії 3.7: Не видаляйте явні підкласи з об’єднань під час виконання.

typing.Optional¶

Optional type.

Optional[X] is equivalent to Union[X, None].

Зауважте, що це не те саме поняття, що необов’язковий аргумент, який має значення за умовчанням. Необов’язковий аргумент із значенням за замовчуванням не потребує кваліфікатора Optional в анотації свого типу лише тому, що він є необов’язковим. Наприклад:

def foo(arg: int = 0) -> None:
    ...

З іншого боку, якщо дозволено явне значення None, використання Optional є доречним, незалежно від того, чи є аргумент необов’язковим. Наприклад:

def foo(arg: Optional[int] = None) -> None:
    ...

typing.Tuple¶

Tuple type; Tuple[X, Y] is the type of a tuple of two items with the first item of type X and the second of type Y. The type of the empty tuple can be written as Tuple[()].

Example: Tuple[T1, T2] is a tuple of two elements corresponding to type variables T1 and T2. Tuple[int, float, str] is a tuple of an int, a float and a string.

To specify a variable-length tuple of homogeneous type, use literal ellipsis, e.g. Tuple[int, ...]. A plain Tuple is equivalent to Tuple[Any, ...], and in turn to tuple.

typing.Callable¶

Callable type; Callable[[int], str] is a function of (int) -> str.

The subscription syntax must always be used with exactly two values: the argument list and the return type. The argument list must be a list of types or an ellipsis; the return type must be a single type.

There is no syntax to indicate optional or keyword arguments; such function types are rarely used as callback types. Callable[..., ReturnType] (literal ellipsis) can be used to type hint a callable taking any number of arguments and returning ReturnType. A plain Callable is equivalent to Callable[..., Any], and in turn to collections.abc.Callable.

typing.Literal¶

A type that can be used to indicate to type checkers that the corresponding variable or function parameter has a value equivalent to the provided literal (or one of several literals). For example:

def validate_simple(data: Any) -> Literal[True]:  # always returns True
    ...

MODE = Literal['r', 'rb', 'w', 'wb']
def open_helper(file: str, mode: MODE) -> str:
    ...

open_helper('/some/path', 'r')  # Passes type check
open_helper('/other/path', 'typo')  # Error in type checker

Літерал[...] не може бути підкласом. Під час виконання довільне значення допускається як аргумент типу для Literal[...], але засоби перевірки типу можуть накладати обмеження. Дивіться PEP 586 для отримання додаткової інформації про літеральні типи.

Нове в версії 3.8.

typing.ClassVar¶

Конструкція спеціального типу для позначення змінних класу.

Як представлено в PEP 526, анотація змінної, загорнена в ClassVar, вказує на те, що даний атрибут призначений для використання як змінна класу і не повинен встановлюватися для екземплярів цього класу. Використання:

class Starship:
    stats: ClassVar[Dict[str, int]] = {} # class variable
    damage: int = 10                     # instance variable

ClassVar приймає лише типи і не може бути підписаний далі.

ClassVar сам по собі не є класом і не повинен використовуватися з isinstance() або issubclass(). ClassVar не змінює поведінку Python під час виконання, але його можуть використовувати сторонні засоби перевірки типу. Наприклад, засіб перевірки типу може позначити наступний код як помилку:

enterprise_d = Starship(3000)
enterprise_d.stats = {} # Error, setting class variable on instance
Starship.stats = {}     # This is OK

Нове в версії 3.5.3.

typing.Final¶

A special typing construct to indicate to type checkers that a name cannot be re-assigned or overridden in a subclass. For example:

MAX_SIZE: Final = 9000
MAX_SIZE += 1  # Error reported by type checker

class Connection:
    TIMEOUT: Final[int] = 10

class FastConnector(Connection):
    TIMEOUT = 1  # Error reported by type checker

Немає жодної перевірки цих властивостей під час виконання. Дивіться PEP 591 для більш детальної інформації.

Нове в версії 3.8.

typing.AnyStr¶

AnyStr is a type variable defined as AnyStr = TypeVar('AnyStr', str, bytes).

It is meant to be used for functions that may accept any kind of string without allowing different kinds of strings to mix. For example:

def concat(a: AnyStr, b: AnyStr) -> AnyStr:
    return a + b

concat(u"foo", u"bar")  # Ok, output has type 'unicode'
concat(b"foo", b"bar")  # Ok, output has type 'bytes'
concat(u"foo", b"bar")  # Error, cannot mix unicode and bytes

typing.TYPE_CHECKING¶

A special constant that is assumed to be True by 3rd party static type checkers. It is False at runtime. Usage:

if TYPE_CHECKING:
    import expensive_mod

def fun(arg: 'expensive_mod.SomeType') -> None:
    local_var: expensive_mod.AnotherType = other_fun()

Note that the first type annotation must be enclosed in quotes, making it a «forward reference», to hide the expensive_mod reference from the interpreter runtime. Type annotations for local variables are not evaluated, so the second annotation does not need to be enclosed in quotes.

Нове в версії 3.5.2.

`typing` — Підтримка підказок типу¶

Псевдоніми типів¶

NewType¶

Callable¶

Узагальнення¶

Визначені користувачем загальні типи¶

Тип `Any`¶

Номінальний проти структурного підтипу¶

Classes, functions, and decorators¶

Table of Contents

Попередній розділ

Наступна тема

Ця сторінка

typing — Підтримка підказок типу¶

Псевдоніми типів¶

NewType¶

Callable¶

Узагальнення¶

Визначені користувачем загальні типи¶

Тип Any¶

Номінальний проти структурного підтипу¶

Classes, functions, and decorators¶

`typing` — Підтримка підказок типу¶

Тип `Any`¶