Python *args와 **kwargs에 대한 타입 주석, Type annotations for *args and **kwargs

질문

I'm trying out Python's type annotations with abstract base classes to write some interfaces. Is there a way to annotate the possible types of *args and **kwargs?

For example, how would one express that the sensible arguments to a function are either an int or two ints? type(args) gives Tuple so my guess was to annotate the type as Union[Tuple[int, int], Tuple[int]], but this doesn't work.

from typing import Union, Tuple

def foo(*args: Union[Tuple[int, int], Tuple[int]]):
    try:
        i, j = args
        return i + j
    except ValueError:
        assert len(args) == 1
        i = args[0]
        return i

# ok
print(foo((1,)))
print(foo((1, 2)))
# mypy does not like this
print(foo(1))
print(foo(1, 2))

Error messages from mypy:

t.py: note: In function "foo":
t.py:6: error: Unsupported operand types for + ("tuple" and "Union[Tuple[int, int], Tuple[int]]")
t.py: note: At top level:
t.py:12: error: Argument 1 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"
t.py:14: error: Argument 1 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"
t.py:15: error: Argument 1 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"
t.py:15: error: Argument 2 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"

It makes sense that mypy doesn't like this for the function call because it expects there to be a tuple in the call itself. The addition after unpacking also gives a typing error that I don't understand.

How does one annotate the sensible types for *args and **kwargs?

답변

변수 위치 인수 (*args) 및 변수 키워드 인수 (**kw)의 경우, 하나의 해당 인수에 대한 예상 값만 지정하면 됩니다.

Type Hints PEP의 임의의 인수 목록 및 기본 인수 값 섹션에서:

임의의 인수 목록도 유형 주석을 달 수 있으므로 다음 정의는 허용됩니다:

def foo(*args: str, **kwds: int): ...

이는 예를 들어 다음과 같은 인수 유형이 있는 함수 호출을 나타냅니다:

foo('a', 'b', 'c')
foo(x=1, y=2)
foo('', z=0)

따라서 메소드를 다음과 같이 지정해야 합니다:

def foo(*args: int):

그러나 함수가 정수 값 하나 또는 두 개만 허용할 수 있는 경우, *args를 전혀 사용하지 말고, 하나의 명시적 위치 인수와 두 번째 키워드 인수를 사용해야 합니다:

def foo(first: int, second: Optional[int] = None):

이제 함수는 실제로 하나 또는 두 개의 인수로 제한되며, 지정된 경우 두 인수 모두 정수여야 합니다. *args는 항상 0개 이상을 의미하며, 유형 힌트로 더 구체적인 범위로 제한할 수 없습니다.