typing — 형 힌트 지원

버전 3.5에 추가.

소스 코드: Lib/typing.py

참고

파이썬 런타임은 함수와 변수 형 어노테이션을 강제하지 않습니다. 형 어노테이션은 형 검사기, IDE, 린터(linter) 등과 같은 제삼자 도구에서 사용할 수 있습니다.

This module provides runtime support for type hints. The most fundamental support consists of the types Any, Union, Callable, TypeVar, and Generic. For a full specification, please see PEP 484. For a simplified introduction to type hints, see PEP 483.

아래의 함수는 문자열을 취하고 반환하며 다음과 같이 어노테이트 되었습니다:

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

함수 greeting에서, 인자 name은 형 str로, 반환형은 str로 기대됩니다. 서브 형은 인자로 허용됩니다.

New features are frequently added to the typing module. The typing_extensions package provides backports of these new features to older versions of Python.

Relevant PEPs

Since the initial introduction of type hints in PEP 484 and PEP 483, a number of PEPs have modified and enhanced Python’s framework for type annotations. These include:

형 에일리어스

형 에일리어스는 별칭에 형을 대입하여 정의됩니다. 이 예에서, Vector와 list[float]는 교환 가능한 동의어로 취급됩니다:

Vector = list[float]

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

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

형 에일리어스는 복잡한 형 서명을 단순화하는 데 유용합니다. 예를 들면:

from collections.abc import Sequence

ConnectionOptions = dict[str, str]
Address = tuple[str, int]
Server = tuple[Address, ConnectionOptions]

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

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

형 힌트로서의 None은 특별한 경우이며 type(None)으로 치환됨에 유의하십시오.

NewType

Use the NewType() helper to create distinct types:

from typing import NewType

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

정적 형 검사기는 새 형을 원래 형의 서브 클래스인 것처럼 다룹니다. 논리 에러를 잡는 데 유용합니다:

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

# typechecks
user_a = get_user_name(UserId(42351))

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

UserId 형의 변수에 대해 모든 int 연산을 여전히 수행할 수 있지만, 결과는 항상 int 형이 됩니다. 이것은 int가 기대되는 모든 곳에 UserId를 전달할 수 있지만, 잘못된 방식으로 의도하지 않게 UserId를 만들지 않도록 합니다:

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

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

더욱 정확하게, 표현식 some_value is Derived(some_value)는 실행 시간에 항상 참입니다.

이것은 또한 Derived의 서브 형을 만들 수 없다는 것을 의미하는데, 실행 시간에 항등함수(identity function)일 뿐 실제 형이 아니기 때문입니다:

from typing import NewType

UserId = NewType('UserId', int)

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

그러나, ‘파생된’ NewType을 기반으로 NewType()을 만들 수 있습니다:

from typing import NewType

UserId = NewType('UserId', int)

ProUserId = NewType('ProUserId', UserId)

그리고 ProUserId에 대한 형 검사는 예상대로 작동합니다.

자세한 내용은 PEP 484를 참조하십시오.

참고

형 에일리어스를 사용하면 두 형이 서로 동등한 것으로 선언됨을 상기하십시오. Alias = Original은 모든 경우 정적 형 검사기가 Alias를 Original과 정확히 동등한 것으로 취급하게 합니다. 이것은 복잡한 형 서명을 단순화하려는 경우에 유용합니다.

반면에, NewType은 한 형을 다른 형의 서브 형으로 선언합니다. Derived = NewType('Derived', Original)은 정적 형 검사기가 Derived를 Original의 서브 클래스로 취급하게 합니다. 이는 Original 형의 값이 Derived 형의 값이 예상되는 위치에서 사용될 수 없음을 의미합니다. 실행 시간 비용을 최소화하면서 논리 에러를 방지하려는 경우에 유용합니다.

버전 3.5.2에 추가.

Callable

특정 서명의 콜백 함수를 기대하는 프레임워크는 Callable[[Arg1Type, Arg2Type], ReturnType]을 사용하여 형 힌트를 제공할 수 있습니다.

예를 들면:

from collections.abc import Callable

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

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

async def on_update(value: str) -> None:
    # Body
callback: Callable[[str], Awaitable[None]] = on_update

형 힌트에서 인자 리스트를 리터럴 줄임표(ellipsis)로 대체하여 호출 서명을 지정하지 않고 콜러블의 반환 값을 선언할 수 있습니다: Callable[..., ReturnType].

제네릭

컨테이너에 보관된 객체에 대한 형 정보는 일반적인 방식으로 정적으로 유추될 수 없기 때문에, 컨테이너 요소에 대해 기대되는 형을 나타내는 서명을 지원하도록 추상 베이스 클래스가 확장되었습니다.

from collections.abc import Mapping, Sequence

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

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

from collections.abc import Sequence
from typing import TypeVar

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

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

사용자 정의 제네릭 형

사용자 정의 클래스는 제네릭 클래스로 정의 할 수 있습니다.

from typing import TypeVar, Generic
from logging import Logger

T = TypeVar('T')

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

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

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

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

베이스 클래스로서의 Generic[T]는 클래스 LoggedVar가 단일한 형 매개 변수 T를 취한다는 것을 정의합니다. 이는 또한 T를 클래스 바디 내에서 형으로 유효하게 만듭니다.

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

from collections.abc import Iterable

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

A generic type can have any number of type variables. All varieties of TypeVar are permissible as parameters for a generic type:

from typing import TypeVar, Generic, Sequence

T = TypeVar('T', contravariant=True)
B = TypeVar('B', bound=Sequence[bytes], covariant=True)
S = TypeVar('S', int, str)

class WeirdTrio(Generic[T, B, S]):
    ...

Generic에 대한 각 형 변수 인자는 달라야 합니다. 그래서 이것은 잘못되었습니다:

from typing import TypeVar, Generic
...

T = TypeVar('T')

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

Generic으로 다중 상속을 사용할 수 있습니다:

from collections.abc import Sized
from typing import TypeVar, Generic

T = TypeVar('T')

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

제네릭 클래스에서 상속할 때, 일부 형 변수를 고정할 수 있습니다:

from collections.abc import Mapping
from typing import TypeVar

T = TypeVar('T')

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

이 경우 MyDict는 단일 매개 변수 T를 갖습니다.

형 매개 변수를 지정하지 않고 제네릭 클래스를 사용하는 것은 각 위치에 대해 Any를 가정합니다. 다음 예제에서, MyIterable은 제네릭이 아니지만 Iterable[Any]를 묵시적으로 상속합니다:

from collections.abc import Iterable

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

사용자 정의 제네릭 형 에일리어스도 지원됩니다. 예:

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

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

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

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

버전 3.7에서 변경: Generic에는 더는 사용자 정의 메타 클래스가 없습니다.

사용자 정의 제네릭 클래스는 메타 클래스 충돌 없이 베이스 클래스로 ABC를 가질 수 있습니다. 제네릭 메타 클래스는 지원되지 않습니다. 제네릭을 매개 변수화한 결과가 캐시 되며, typing 모듈의 대부분 형이 해시 가능하고 동등성을 비교할 수 있습니다.

Any 형

특수한 종류의 형은 Any입니다. 정적 형 검사기는 모든 형을 Any와 호환되는 것으로, Any를 모든 형과 호환되는 것으로 취급합니다.

이것은 Any 형의 값에 대해 어떤 연산이나 메서드 호출을 수행하고, 그것을 임의의 변수에 대입할 수 있다는 것을 의미합니다:

from typing import Any

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

s: str = ''
s = a           # OK

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

Any 형의 값을 보다 구체적인 형에 대입할 때 형 검사가 수행되지 않음에 유의하십시오. 예를 들어, 정적 형 검사기는 s가 형 str로 선언되고 실행 시간에 int 값을 수신하더라도 a를 s에 대입할 때 에러를 보고하지 않았습니다!

또한, 반환형이나 매개 변수 형이 없는 모든 함수는 묵시적으로 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 the 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과 같은 추상 베이스 클래스에도 적용되었습니다. 이 접근 방식의 문제점은 이것을 지원하려면 클래스를 명시적으로 표시해야만 한다는 점입니다. 이는 파이썬답지 않고 관용적인 동적으로 형이 지정된 파이썬 코드에서 일반적으로 수행하는 것과는 다릅니다. 예를 들어, 이것은 PEP 484를 만족합니다:

from collections.abc import Sized, Iterable, Iterator

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

PEP 544는 사용자가 클래스 정의에서 명시적인 베이스 클래스 없이 위의 코드를 작성할 수 있게 함으로써 이 문제를 풀도록 합니다. 정적 형 검사기가 Bucket을 Sized와 Iterable[int]의 서브 형으로 묵시적으로 취급하도록 합니다. 이것은 구조적 서브 타이핑(structural subtyping)(또는 정적 덕 타이핑)으로 알려져 있습니다:

from collections.abc import Iterator, Iterable

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

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

또한, 특별한 클래스 Protocol을 서브 클래싱 함으로써, 사용자는 새로운 사용자 정의 프로토콜을 정의하여 구조적 서브 타이핑을 완전히 누릴 수 있습니다 (아래 예를 참조하십시오).

모듈 내용

모듈은 다음 클래스, 함수 및 데코레이터를 정의합니다.

참고

이 모듈은 [] 내부의 형 변수를 지원하도록 Generic를 확장하기도 하는 기존 표준 라이브러리 클래스의 서브 클래스인 여러 형을 정의합니다. 이러한 형은 해당하는 기존 클래스가 []를 지원하도록 개선되었을 때 파이썬 3.9에서 중복되었습니다.

중복된 형은 파이썬 3.9부터 폐지되었지만, 인터프리터에서 폐지 경고가 발생하지 않습니다. 검사되는 프로그램이 파이썬 3.9 이상을 대상으로 할 때 형 검사기가 폐지된 형을 표시할 것으로 예상됩니다.

폐지된 형은 파이썬 3.9.0 릴리스 5년 후에 릴리스 되는 첫 번째 파이썬 버전의 typing 모듈에서 제거됩니다. 자세한 내용은 PEP 585-표준 컬렉션의 형 힌트 제네릭을 참조하십시오.

특수 타이핑 프리미티브

특수형

이들은 어노테이션에서 형으로 사용할 수 있으며 []를 지원하지 않습니다.

typing.Any

제한되지 않는 형을 나타내는 특수형.

  • 모든 형은 Any와 호환됩니다.

  • Any는 모든 형과 호환됩니다.

typing.NoReturn

함수가 절대 반환하지 않는 것을 나타내는 특수한 형. 예를 들면:

from typing import NoReturn

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

버전 3.5.4에 추가.

버전 3.6.2에 추가.

특수 형태

이들은 []를 사용하여 어노테이션에서 형으로 사용할 수 있는데, 각기 고유한 문법을 가집니다.

typing.Tuple

튜플 형; Tuple[X, Y]는 첫 번째 항목의 형이 X이고 두 번째 항목의 형이 Y인 두 항목의 튜플 형입니다. 빈 튜플의 형은 Tuple[()]로 쓸 수 있습니다.

예: Tuple[T1, T2]는 각각 형 변수 T1과 T2에 해당하는 두 요소의 튜플입니다. Tuple[int, float, str]은 int, float 및 문자열의 튜플입니다.

같은 형의 가변 길이 튜플을 지정하려면 리터럴 생략 부호(ellipsis)를 사용하십시오, 예를 들어 Tuple[int, ...]. 단순한 Tuple은 Tuple[Any, ...]와 동등하고, 이는 다시 tuple과 동등합니다.

버전 3.9부터 폐지: builtins.tuple은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

typing.Union

공용체 형; Union[X, Y]는 X나 Y를 의미합니다.

공용체를 정의하려면, 예를 들어 Union[int, str]을 사용하십시오. 세부 사항:

  • 인자는 형이어야 하며 적어도 하나 있어야 합니다.

  • 공용체의 공용체는 펼쳐집니다, 예를 들어:

    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]

  • 공용체를 서브 클래스 화하거나 인스턴스 화할 수 없습니다.

  • Union[X][Y]라고 쓸 수 없습니다.

  • Optional[X]를 Union[X, None]의 줄임 표현으로 사용할 수 있습니다.

버전 3.7에서 변경: 실행 시간에 공용체의 명시적 서브 클래스를 제거하지 않습니다.

typing.Optional

선택적 형.

Optional[X]는 Union[X, None]과 동등합니다.

이는 기본값을 갖는 선택적 인자와 같은 개념이 아님에 유의하십시오. 단지 선택적이기 때문에 기본값을 갖는 선택적 인자가 형 어노테이션에 Optional 한정자가 필요하지는 않습니다. 예를 들면:

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

한편, 명시적인 None 값이 허용되면, 인자가 선택적인지와 관계없이 Optional을 사용하는 것이 적합합니다. 예를 들면:

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

콜러블 형; Callable[[int], str]은 (int) -> str 인 함수입니다.

서브스크립션 문법은 항상 정확히 두 개의 값으로 사용되어야 합니다: 인자 리스트와 반환형. 인자 리스트는 형의 리스트거나 생략 부호(ellipsis)여야 합니다. 반환형은 단일한 형이어야 합니다.

선택적이나 키워드 인자를 나타내는 문법은 없습니다; 그런 함수 형은 거의 콜백 형으로 사용되지 않습니다. Callable[..., ReturnType](리터럴 생략 부호)은 임의의 수의 인자를 취하고 ReturnType을 반환하는 콜러블에 형 힌트를 주는 데 사용할 수 있습니다. 단순한 Callable은 Callable[..., Any]와 동등하며, 이는 다시 collections.abc.Callable과 동등합니다.

버전 3.9부터 폐지: collections.abc.Callable은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Type(Generic[CT_co])

C로 어노테이트 된 변수는 C 형의 값을 받아들일 수 있습니다. 대조적으로, Type[C]로 어노테이트 된 변수는 클래스 자신인 값을 받아들일 수 있습니다 – 구체적으로, C의 클래스 객체를 허용합니다. 예를 들면:

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

Type[C]는 공변적(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()

Type[C]가 공변적(covariant)이라는 사실은 C의 모든 서브 클래스가 C와 같은 생성자 서명과 클래스 메서드 서명을 구현해야 함을 의미합니다. 형 검사기는 이 위반을 표시해야 하지만, 표시된 베이스 클래스의 생성자 호출과 일치하는 서브 클래스의 생성자 호출을 허용해야 합니다. 이 특별한 경우를 처리하기 위한 형 검사기의 요구 사항은 향후 PEP 484 개정판에서 변경될 수 있습니다.

Type의 합법적인 매개 변수는 클래스, Any, 형 변수 및 이러한 형들의 공용체(union)뿐입니다. 예를 들면:

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

Type[Any]는 Type과 동등하며, 이는 다시 파이썬의 메타 클래스 계층 구조의 루트인 type과 동등합니다.

버전 3.5.2에 추가.

버전 3.9부터 폐지: builtins.type은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

typing.Literal

대응하는 변수나 함수 매개 변수가 제공된 리터럴(또는 여러 리터럴 중 하나)과 동등한 값을 가짐을 형 검사기에 알리는 데 사용할 수 있는 형. 예를 들면:

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[...]은 서브 클래싱 될 수 없습니다. 실행 시간에는, 임의의 값이 Literal[...]에 대한 형 인자로 허용되지만, 형 검사기는 제한을 부과할 수 있습니다. 리터럴 형에 대한 자세한 내용은 PEP 586을 참조하십시오.

버전 3.8에 추가.

버전 3.9.1에서 변경: Literal now de-duplicates parameters. Equality comparisons of Literal objects are no longer order dependent. Literal objects will now raise a TypeError exception during equality comparisons if one of their parameters are not hashable.

typing.ClassVar

클래스 변수를 표시하기 위한 특수 형 구조물.

PEP 526에서 소개된 것처럼, ClassVar로 감싼 변수 어노테이션은 주어진 어트리뷰트가 클래스 변수로 사용되도록 의도되었으며 해당 클래스의 인스턴스에 설정되어서는 안 됨을 나타냅니다. 용법:

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

ClassVar는 형만 받아들이며 더는 서브 스크립트 할 수 없습니다.

ClassVar는 클래스 자체가 아니므로, isinstance()나 issubclass()와 함께 사용하면 안 됩니다. ClassVar는 파이썬 실행 시간 동작을 변경하지 않지만, 제삼자 형 검사기에서 사용할 수 있습니다. 예를 들어, 형 검사기는 다음 코드를 에러로 표시 할 수 있습니다:

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

버전 3.5.3에 추가.

typing.Final

형 검사기에 이름이 다시 대입되거나 서브 클래스에서 재정의될 수 없다는 것을 나타내는 특수한 typing 구조물. 예를 들면:

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

class Connection:
    TIMEOUT: Final[int] = 10

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

이러한 속성에 대한 실행 시간 검사는 없습니다. 자세한 내용은 PEP 591을 참조하십시오.

버전 3.8에 추가.

typing.Annotated

A type, introduced in PEP 593 (Flexible function and variable annotations), to decorate existing types with context-specific metadata (possibly multiple pieces of it, as Annotated is variadic). Specifically, a type T can be annotated with metadata x via the typehint Annotated[T, x]. This metadata can be used for either static analysis or at runtime. If a library (or tool) encounters a typehint Annotated[T, x] and has no special logic for metadata x, it should ignore it and simply treat the type as T. Unlike the no_type_check functionality that currently exists in the typing module which completely disables typechecking annotations on a function or a class, the Annotated type allows for both static typechecking of T (which can safely ignore x) together with runtime access to x within a specific application.

궁극적으로, 어노테이션을 해석하는 방법에 대한 책임은 (있기는 하다면) Annotated 형을 만나는 도구나 라이브러리의 책임입니다. Annotated 형을 만나는 도구나 라이브러리는 어노테이션을 통해 스캔하여 관심이 있는 것인지 판별합니다 (예를 들어, isinstance()를 사용하여).

도구나 라이브러리가 어노테이션을 지원하지 않거나 알 수 없는 어노테이션을 만나면, 이를 무시하고 어노테이트 된 형을 하부 형으로 처리해야 합니다.

클라이언트가 한 형에 여러 어노테이션을 갖도록 허용되는지와 해당 어노테이션들을 병합하는 방법을 결정하는 것은 어노테이션을 소비하는 도구에 달려 있습니다.

Annotated 형을 사용하면 임의의 노드에 같은 (또는 다른) 형의 여러 어노테이션을 넣을 수 있도록 하므로, 이 어노테이션을 소비하는 도구나 라이브러리는 잠재적 중복을 처리해야 합니다. 예를 들어, 값 범위 분석을 수행하는 경우 다음처럼 허용할 수 있습니다:

T1 = Annotated[int, ValueRange(-10, 5)]
T2 = Annotated[T1, ValueRange(-20, 3)]

include_extras=True를 get_type_hints()로 전달하면 실행 시간에 추가 어노테이션에 액세스 할 수 있습니다.

문법의 세부 사항:

  • Annotated의 첫 번째 인자는 유효한 형이어야 합니다

  • 여러 개의 형 주석이 지원됩니다 (Annotated는 가변 인자를 지원합니다):

    Annotated[int, ValueRange(3, 10), ctype("char")]

  • Annotated는 최소한 두 개의 인자로 호출해야 합니다 (Annotated[int]는 유효하지 않습니다)

  • 어노테이션의 순서는 유지되며 동등(equality) 검사의 경우 중요합니다:

    Annotated[int, ValueRange(3, 10), ctype("char")] != Annotated[
    int, ctype("char"), ValueRange(3, 10)
]

  • 중첩된 Annotated 형은 가장 안쪽 주석으로 시작하는 메타 데이터로 평탄화됩니다:

    Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[
    int, ValueRange(3, 10), ctype("char")
]

  • 중복된 어노테이션은 제거되지 않습니다:

    Annotated[int, ValueRange(3, 10)] != Annotated[
    int, ValueRange(3, 10), ValueRange(3, 10)
]

  • Annotated는 중첩되고 제네릭한 에일리어스와 함께 사용할 수 있습니다:

    T = TypeVar('T')
Vec = Annotated[list[tuple[T, T]], MaxLen(10)]
V = Vec[int]

V == Annotated[list[tuple[int, int]], MaxLen(10)]

버전 3.9에 추가.

제네릭 형 구축하기

이들은 어노테이션에는 사용되지 않습니다. 제네릭 형을 만들기 위한 빌딩 블록입니다.

class typing.Generic

제네릭 형을 위한 추상 베이스 클래스.

제네릭 형은 일반적으로 이 클래스를 하나 이상의 형 변수로 인스턴스 화한 것을 상속하여 선언됩니다. 예를 들어, 제네릭 매핑형은 다음과 같이 정의할 수 있습니다:

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

이 클래스는 다음과 같이 사용할 수 있습니다:

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

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

형 변수.

용법:

T = TypeVar('T')  # Can be anything
S = TypeVar('S', bound=str)  # Can be any subtype of str
A = TypeVar('A', str, bytes)  # Must be exactly str or bytes

형 변수는 주로 정적 형 검사기를 위해 존재합니다. 이들은 제네릭 함수 정의뿐만 아니라 제네릭 형의 매개 변수 역할을 합니다. 제네릭 형에 대한 자세한 내용은 Generic을 참조하십시오. 제네릭 함수는 다음과 같이 작동합니다:

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


def print_capitalized(x: S) -> S:
    """Print x capitalized, and return x."""
    print(x.capitalize())
    return x


def concatenate(x: A, y: A) -> A:
    """Add two strings or bytes objects together."""
    return x + y

Note that type variables can be bound, constrained, or neither, but cannot be both bound and constrained.

Constrained type variables and bound type variables have different semantics in several important ways. Using a constrained type variable means that the TypeVar can only ever be solved as being exactly one of the constraints given:

a = concatenate('one', 'two')  # Ok, variable 'a' has type 'str'
b = concatenate(StringSubclass('one'), StringSubclass('two'))  # Inferred type of variable 'b' is 'str',
                                                               # despite 'StringSubclass' being passed in
c = concatenate('one', b'two')  # error: type variable 'A' can be either 'str' or 'bytes' in a function call, but not both

Using a bound type variable, however, means that the TypeVar will be solved using the most specific type possible:

print_capitalized('a string')  # Ok, output has type 'str'

class StringSubclass(str):
    pass

print_capitalized(StringSubclass('another string'))  # Ok, output has type 'StringSubclass'
print_capitalized(45)  # error: int is not a subtype of str

Type variables can be bound to concrete types, abstract types (ABCs or protocols), and even unions of types:

U = TypeVar('U', bound=str|bytes)  # Can be any subtype of the union str|bytes
V = TypeVar('V', bound=SupportsAbs)  # Can be anything with an __abs__ method

Bound type variables are particularly useful for annotating classmethods that serve as alternative constructors. In the following example (© Raymond Hettinger), the type variable C is bound to the Circle class through the use of a forward reference. Using this type variable to annotate the with_circumference classmethod, rather than hardcoding the return type as Circle, means that a type checker can correctly infer the return type even if the method is called on a subclass:

import math

C = TypeVar('C', bound='Circle')

class Circle:
    """An abstract circle"""

    def __init__(self, radius: float) -> None:
        self.radius = radius

    # Use a type variable to show that the return type
    # will always be an instance of whatever ``cls`` is
    @classmethod
    def with_circumference(cls: type[C], circumference: float) -> C:
        """Create a circle with the specified circumference"""
        radius = circumference / (math.pi * 2)
        return cls(radius)


class Tire(Circle):
    """A specialised circle (made out of rubber)"""

    MATERIAL = 'rubber'


c = Circle.with_circumference(3)  # Ok, variable 'c' has type 'Circle'
t = Tire.with_circumference(4)  # Ok, variable 't' has type 'Tire' (not 'Circle')

실행 시간에, isinstance(x, T)는 TypeError를 발생시킵니다. 일반적으로, isinstance()와 issubclass()는 형과 함께 사용하면 안 됩니다.

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.

typing.AnyStr

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

다른 종류의 문자열을 섞지 않고 모든 종류의 문자열을 받아들일 수 있는 함수에 사용하기 위한 것입니다. 예를 들면:

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

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

프로토콜 클래스의 베이스 클래스. 프로토콜 클래스는 다음과 같이 정의됩니다:

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

자세한 내용은 PEP 544를 참조하십시오. runtime_checkable()(아래에서 설명합니다)로 데코레이트 된 프로토콜 클래스는 주어진 어트리뷰트의 존재 여부만 확인하고 형 서명을 무시하는 단순한 실행 시간 프로토콜로 작동합니다.

프로토콜 클래스는 제네릭일 수 있습니다, 예를 들어:

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

버전 3.8에 추가.

@typing.runtime_checkable

프로토콜 클래스를 실행 시간 프로토콜로 표시합니다.

이러한 프로토콜은 isinstance()와 issubclass()와 함께 사용할 수 있습니다. 이것은 비 프로토콜 클래스에 적용될 때 TypeError를 발생시킵니다. 이것은 collections.abc에 있는 Iterable처럼 “한 가지만 잘하는” 것과 매우 유사한 단순한 구조적 검사를 허용합니다. 예를 들면:

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

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

참고

runtime_checkable()은 필요한 메서드의 존재만 검사할 뿐, 그것들의 형 서명은 검사하지 않습니다! 예를 들어, builtins.complex는 __float__()를 구현하므로, SupportsFloat에 대해 issubclass() 검사를 통과합니다. 그러나, complex.__float__ 메서드는 더 많은 정보를 제공하는 메시지와 함께 TypeError를 발생시키기 위해서만 존재합니다.

버전 3.8에 추가.

기타 특수 지시자

이들은 어노테이션에는 사용되지 않습니다. 형 선언을 위한 빌딩 블록입니다.

class typing.NamedTuple

형 지정된(typed) 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에서 변경: 기본값, 메서드 및 독스트링에 대한 지원을 추가했습니다.

버전 3.8에서 변경: _field_types와 __annotations__ 어트리뷰트는 이제 OrderedDict 인스턴스가 아닌 일반 딕셔너리입니다.

버전 3.9에서 변경: _field_types 어트리뷰트를 제거하고, 같은 정보를 가지는 더 표준적인 __annotations__ 어트리뷰트로 대체했습니다.

typing.NewType(name, tp)

형 검사기에 구별되는 형을 가리키는 도우미 함수, NewType을 참조하십시오. 실행 시간에 인자를 반환하는 함수를 반환합니다. 용법:

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

버전 3.5.2에 추가.

class typing.TypedDict(dict)

딕셔너리에 형 힌트를 추가하는 특수 구조. 실행 시간에 일반 dict입니다.

TypedDict는 모든 인스턴스가 각 키가 일관된 형의 값에 연관되는, 특정한 키 집합을 갖도록 기대되는 딕셔너리 형을 선언합니다. 이 기대는 실행 시간에는 검사되지 않고, 형 검사기에서만 강제됩니다. 사용법:

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

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

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

To allow using this feature with older versions of Python that do not support PEP 526, TypedDict supports two additional equivalent syntactic forms:

  • Using a literal dict as the second argument:

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

  • Using keyword arguments:

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

The functional syntax should also be used when any of the keys are not valid identifiers, for example because they are keywords or contain hyphens. Example:

# raises SyntaxError
class Point2D(TypedDict):
    in: int  # 'in' is a keyword
    x-y: int  # name with hyphens

# OK, functional syntax
Point2D = TypedDict('Point2D', {'in': int, 'x-y': int})

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

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

# Alternative syntax
Point2D = TypedDict('Point2D', {'x': int, 'y': int}, total=False)

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 required.

It is possible for a TypedDict type to inherit from one or more other TypedDict types using the class-based syntax. Usage:

class Point3D(Point2D):
    z: int

Point3D has three items: x, y and z. It is equivalent to this definition:

class Point3D(TypedDict):
    x: int
    y: int
    z: int

A TypedDict cannot inherit from a non-TypedDict class, notably including Generic. For example:

class X(TypedDict):
    x: int

class Y(TypedDict):
    y: int

class Z(object): pass  # A non-TypedDict class

class XY(X, Y): pass  # OK

class XZ(X, Z): pass  # raises TypeError

T = TypeVar('T')
class XT(X, Generic[T]): pass  # raises TypeError

A TypedDict can be introspected via __annotations__, __total__, __required_keys__, and __optional_keys__.

__total__

Point2D.__total__ gives the value of the total argument. Example:

>>> from typing import TypedDict
>>> class Point2D(TypedDict): pass
>>> Point2D.__total__
True
>>> class Point2D(TypedDict, total=False): pass
>>> Point2D.__total__
False
>>> class Point3D(Point2D): pass
>>> Point3D.__total__
True
__required_keys__
__optional_keys__

Point2D.__required_keys__ and Point2D.__optional_keys__ return frozenset objects containing required and non-required keys, respectively. Currently the only way to declare both required and non-required keys in the same TypedDict is mixed inheritance, declaring a TypedDict with one value for the total argument and then inheriting it from another TypedDict with a different value for total. Usage:

>>> class Point2D(TypedDict, total=False):
...     x: int
...     y: int
...
>>> class Point3D(Point2D):
...     z: int
...
>>> Point3D.__required_keys__ == frozenset({'z'})
True
>>> Point3D.__optional_keys__ == frozenset({'x', 'y'})
True

추가 예제와 TypedDict를 사용하는 자세한 규칙은 PEP 589를 참조하십시오.

버전 3.8에 추가.

제네릭 구상 컬렉션

내장형에 해당하는 것들

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

dict의 제네릭 버전. 반환형을 어노테이트하는 데 유용합니다. 인자를 어노테이트 하려면 Mapping과 같은 추상 컬렉션 형을 사용하는 것이 좋습니다.

이 형은 다음과 같이 사용할 수 있습니다:

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

버전 3.9부터 폐지: builtins.dict는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

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

list의 제네릭 버전. 반환형을 어노테이트하는 데 유용합니다. 인자를 어노테이트 하려면 Sequence나 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]

버전 3.9부터 폐지: builtins.list는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Set(set, MutableSet[T])

builtins.set의 제네릭 버전. 반환형을 어노테이트하는 데 유용합니다. 인자를 어노테이트 하려면 AbstractSet과 같은 추상 컬렉션 형을 사용하는 것이 좋습니다.

버전 3.9부터 폐지: builtins.set은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.FrozenSet(frozenset, AbstractSet[T_co])

builtins.frozenset의 제네릭 버전.

버전 3.9부터 폐지: builtins.frozenset은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

참고

Tuple은 특수 형태입니다.

collections의 형에 해당하는 것들

class typing.DefaultDict(collections.defaultdict, MutableMapping[KT, VT])

collections.defaultdict의 제네릭 버전.

버전 3.5.2에 추가.

버전 3.9부터 폐지: collections.defaultdict는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.OrderedDict(collections.OrderedDict, MutableMapping[KT, VT])

collections.OrderedDict의 제네릭 버전.

버전 3.7.2에 추가.

버전 3.9부터 폐지: collections.OrderedDict는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.ChainMap(collections.ChainMap, MutableMapping[KT, VT])

collections.ChainMap의 제네릭 버전.

버전 3.5.4에 추가.

버전 3.6.1에 추가.

버전 3.9부터 폐지: collections.ChainMap은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Counter(collections.Counter, Dict[T, int])

collections.Counter의 제네릭 버전.

버전 3.5.4에 추가.

버전 3.6.1에 추가.

버전 3.9부터 폐지: collections.Counter는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Deque(deque, MutableSequence[T])

collections.deque의 제네릭 버전.

버전 3.5.4에 추가.

버전 3.6.1에 추가.

버전 3.9부터 폐지: collections.deque는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

기타 구상형

class typing.IO
class typing.TextIO
class typing.BinaryIO

Generic type IO[AnyStr] and its subclasses TextIO(IO[str]) and BinaryIO(IO[bytes]) represent the types of I/O streams such as returned by open().

Deprecated since version 3.8, will be removed in version 3.12: These types are also in the typing.io namespace, which was never supported by type checkers and will be removed.

class typing.Pattern
class typing.Match

These type aliases correspond to the return types from re.compile() 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].

Deprecated since version 3.8, will be removed in version 3.12: These types are also in the typing.re namespace, which was never supported by type checkers and will be removed.

버전 3.9부터 폐지: re의 클래스 Pattern과 Match는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Text

Text는 str의 별칭입니다. 파이썬 2 코드를 위한 상위 호환 경로를 제공하기 위해 제공됩니다: 파이썬 2에서, Text는 unicode의 별칭입니다.

Text를 사용하여 값이 파이썬 2와 파이썬 3 모두와 호환되는 방식으로 유니코드 문자열을 포함해야 함을 나타내십시오:

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

버전 3.5.2에 추가.

추상 베이스 클래스

collections.abc의 컬렉션에 해당하는 것들

class typing.AbstractSet(Sized, Collection[T_co])

collections.abc.Set의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.Set은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.ByteString(Sequence[int])

collections.abc.ByteString의 제네릭 버전.

이 형은 bytes, bytearray 및 바이트 시퀀스의 memoryview 형을 나타냅니다.

이 형의 줄임 표현으로, bytes는 위에 언급된 모든 형의 인자를 어노테이트하는 데 사용될 수 있습니다.

버전 3.9부터 폐지: collections.abc.ByteString은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Collection(Sized, Iterable[T_co], Container[T_co])

collections.abc.Collection의 제네릭 버전

버전 3.6.0에 추가.

버전 3.9부터 폐지: collections.abc.Collection은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Container(Generic[T_co])

collections.abc.Container의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.Container는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.ItemsView(MappingView, Generic[KT_co, VT_co])

collections.abc.ItemsView의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.ItemsView는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.KeysView(MappingView[KT_co], AbstractSet[KT_co])

collections.abc.KeysView의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.KeysView는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

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

collections.abc.Mapping의 제네릭 버전. 이 형은 다음과 같이 사용할 수 있습니다:

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

버전 3.9부터 폐지: collections.abc.Mapping은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.MappingView(Sized, Iterable[T_co])

collections.abc.MappingView의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.MappingView는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.MutableMapping(Mapping[KT, VT])

collections.abc.MutableMapping의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.MutableMapping은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.MutableSequence(Sequence[T])

collections.abc.MutableSequence의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.MutableSequence는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.MutableSet(AbstractSet[T])

collections.abc.MutableSet의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.MutableSet은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Sequence(Reversible[T_co], Collection[T_co])

collections.abc.Sequence의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.Sequence는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.ValuesView(MappingView[VT_co])

collections.abc.ValuesView의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.ValuesView는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

collections.abc의 기타 형에 해당하는 것들

class typing.Iterable(Generic[T_co])

collections.abc.Iterable의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.Iterable은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Iterator(Iterable[T_co])

collections.abc.Iterator의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.Iterator는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

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'

typing 모듈의 다른 많은 제네릭과 달리 Generator의 SendType은 공변적(covariant)이거나 불변적(invariant)이 아니라 반변적(contravariant)으로 행동함에 유의하십시오.

제너레이터가 값을 일드(yield)하기만 하면, SendType과 ReturnType을 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

버전 3.9부터 폐지: collections.abc.Generator는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Hashable

An alias to collections.abc.Hashable.

class typing.Reversible(Iterable[T_co])

collections.abc.Reversible의 제네릭 버전.

버전 3.9부터 폐지: collections.abc.Reversible은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Sized

An alias to collections.abc.Sized.

비동기 프로그래밍

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

collections.abc.Coroutine의 제네릭 버전. 형 변수의 변화와 순서는 Generator의 것과 같습니다, 예를 들어:

from collections.abc import Coroutine
c: Coroutine[list[str], str, int]  # Some coroutine defined elsewhere
x = c.send('hi')                   # Inferred type of 'x' is list[str]
async def bar() -> None:
    y = await c                    # Inferred type of 'y' is int

버전 3.5.3에 추가.

버전 3.9부터 폐지: collections.abc.Coroutine은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

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은 반변적(contravariant)으로 행동합니다.

제너레이터가 값을 일드(yield)하기만 하면, SendType을 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에 추가.

버전 3.9부터 폐지: collections.abc.AsyncGenerator는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.AsyncIterable(Generic[T_co])

collections.abc.AsyncIterable의 제네릭 버전.

버전 3.5.2에 추가.

버전 3.9부터 폐지: collections.abc.AsyncIterable은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.AsyncIterator(AsyncIterable[T_co])

collections.abc.AsyncIterator의 제네릭 버전.

버전 3.5.2에 추가.

버전 3.9부터 폐지: collections.abc.AsyncIterator는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.Awaitable(Generic[T_co])

collections.abc.Awaitable의 제네릭 버전.

버전 3.5.2에 추가.

버전 3.9부터 폐지: collections.abc.Awaitable은 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

컨텍스트 관리자 형

class typing.ContextManager(Generic[T_co])

contextlib.AbstractContextManager 의 제네릭 버전.

버전 3.5.4에 추가.

버전 3.6.0에 추가.

버전 3.9부터 폐지: collections.contextlib.AbstractContextManager는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

class typing.AsyncContextManager(Generic[T_co])

contextlib.AbstractAsyncContextManager 의 제네릭 버전.

버전 3.5.4에 추가.

버전 3.6.2에 추가.

버전 3.9부터 폐지: collections.contextlib.AbstractAsyncContextManager는 이제 []를 지원합니다. PEP 585와 제네릭 에일리어스 형을 참조하십시오.

프로토콜

이 프로토콜은 runtime_checkable()로 데코레이트 되어 있습니다.

class typing.SupportsAbs

반환형이 공변적(covariant)인 하나의 추상 메서드 __abs__를 가진 ABC.

class typing.SupportsBytes

하나의 추상 메서드 __bytes__를 가진 ABC.

class typing.SupportsComplex

하나의 추상 메서드 __complex__를 가진 ABC.

class typing.SupportsFloat

하나의 추상 메서드 __float__를 가진 ABC.

class typing.SupportsIndex

하나의 추상 메서드 __index__를 가진 ABC.

버전 3.8에 추가.

class typing.SupportsInt

하나의 추상 메서드 __int__를 가진 ABC.

class typing.SupportsRound

반환형이 공변적(covariant)인 하나의 추상 메서드 __round__를 가진 ABC.

함수와 데코레이터

typing.cast(typ, val)

값을 형으로 변환합니다.

값을 변경하지 않고 반환합니다. 형 검사기에서는 반환 값이 지정된 형임을 나타내지만, 실행 시간에는 의도적으로 아무것도 확인하지 않습니다 (우리는 이것이 가능한 한 빠르기를 원합니다).

@typing.overload

@overload 데코레이터는 여러 가지 다양한 인자형의 조합을 지원하는 함수와 메서드를 기술할 수 있도록 합니다. @overload로 데코레이트 된 일련의 정의에는 (같은 함수/메서드에 대해) 정확히 하나의 @overload로 데코레이트 되지 않은 정의가 뒤따라야 합니다. @overload로 데코레이트 된 정의는 @overload로 데코레이트 되지 않은 정의에 의해 덮어 쓰이기 때문에 형 검사기만을 위한 것입니다. 후자는 실행 시간에 사용되지만, 형 검사기에서는 무시되어야 합니다. 실행 시간에, @overload로 데코레이트 된 함수를 직접 호출하면 NotImplementedError 가 발생합니다. 공용체(union)나 형 변수를 사용하여 표현할 수 있는 것보다 더 정밀한 형을 제공하는 오버로드의 예:

@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>

자세한 내용과 다른 typing 의미와의 비교는 PEP 484를 참조하십시오.

@typing.final

데코레이트 된 메서드가 재정의될 수 없고, 데코레이트 된 클래스가 서브 클래싱 될 수 없음을 형 검사기에 알리는 데코레이터. 예를 들면:

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

어노테이션이 형 힌트가 아님을 나타내는 데코레이터.

이것은 클래스나 함수 데코레이터로 작동합니다. 클래스일 때, 해당 클래스에 정의된 모든 메서드에 재귀적으로 적용됩니다 (하지만 슈퍼 클래스나 서브 클래스에 정의된 메서드에는 적용되지 않습니다).

함수가 제자리에서(in place) 변경됩니다.

@typing.no_type_check_decorator

다른 데코레이터에 no_type_check() 효과를 주는 데코레이터.

이것은 데코레이트 된 함수를 no_type_check()로 감싸는 무언가로 데코레이터를 감쌉니다.

@typing.type_check_only

실행 시간에 클래스나 함수를 사용할 수 없도록 표시하는 데코레이터.

이 데코레이터 자체는 실행 시간에 사용할 수 없습니다. 주로, 구현이 비공개 클래스의 인스턴스를 반환할 때, 형 스텁 파일에 정의된 클래스를 표시하기 위한 용도입니다:

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

def fetch_response() -> Response: ...

비공개 클래스의 인스턴스를 반환하는 것은 좋지 않음에 유의하십시오. 일반적으로 그러한 클래스를 공개로 만드는 것이 바람직합니다.

인트로스펙션 도우미

typing.get_type_hints(obj, globalns=None, localns=None, include_extras=False)

함수, 메서드, 모듈 또는 클래스 객체에 대한 형 힌트가 포함된 딕셔너리를 반환합니다.

이것은 종종 obj.__annotations__와 같습니다. 또한, 문자열 리터럴로 인코딩된 전방 참조는 globals와 locals 이름 공간에서 이를 평가하여 처리됩니다. 필요하면, 기본값이 None으로 설정되면 함수와 메서드 어노테이션에 Optional[t]가 추가됩니다. 클래스 C에 대해, C.__mro__의 역순으로 모든 __annotations__를 병합하여 만든 딕셔너리를 반환합니다.

include_extras가 True로 설정되어 있지 않은 한, 이 함수는 모든 Annotated[T, ...]를 T로 재귀적으로 치환합니다 (자세한 내용은 Annotated를 참조하십시오). 예를 들면:

class Student(NamedTuple):
    name: Annotated[str, 'some marker']

get_type_hints(Student) == {'name': str}
get_type_hints(Student, include_extras=False) == {'name': str}
get_type_hints(Student, include_extras=True) == {
    'name': Annotated[str, 'some marker']
}

버전 3.9에서 변경: PEP 593의 일부로 include_extras 매개 변수를 추가했습니다.

typing.get_args(tp)
typing.get_origin(tp)

제네릭 형과 특수 typing 형식에 대한 기본적인 인트로스펙션을 제공합니다.

X[Y, Z, ...] 형식의 typing 객체의 경우, 이 함수는 X와 (Y, Z, ...)를 반환합니다. X가 내장이나 collections 클래스의 제네릭 에일리어스인 경우, 원래 클래스로 정규화됩니다. X가 다른 제네릭 형에 포함된 Union이나 Literal이면, (Y, Z, ...)의 순서는 형 캐싱으로 인해 원래 인자 [Y, Z, ...]의 순서와 다를 수 있습니다. 지원되지 않는 객체의 경우 각각 None과 ()를 반환합니다. 예:

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

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

버전 3.8에 추가.

class typing.ForwardRef

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

참고

PEP 585 generic types such as list["SomeClass"] will not be implicitly transformed into list[ForwardRef("SomeClass")] and thus will not automatically resolve to list[SomeClass].

버전 3.7.4에 추가.

상수

typing.TYPE_CHECKING

제삼자 정적 형 검사기에 의해 True로 설정될 것으로 가정되는 특수 상수. 실행 시간에는 False입니다. 용법:

if TYPE_CHECKING:
    import expensive_mod

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

첫 번째 어노테이션은 따옴표로 묶여야 합니다, “전방 참조”로 만들어서 인터프리터 실행 시간에 expensive_mod 참조를 숨깁니다. 지역 변수에 대한 형 어노테이션은 평가되지 않기 때문에, 두 번째 어노테이션을 따옴표로 묶을 필요는 없습니다.

참고

If from __future__ import annotations is used, annotations are not evaluated at function definition time. Instead, they are stored as strings in __annotations__. This makes it unnecessary to use quotes around the annotation (see PEP 563).

버전 3.5.2에 추가.