* args 및 ** kwargs에 대한 유형 주석

일부 기본 인터페이스를 작성하기 위해 추상 기본 클래스를 사용하여 Python의 유형 주석을 시도하고 있습니다. 의 가능한 유형의 주석을 할 수있는 방법이 있나요 *args과 **kwargs?

예를 들어, 함수에 대한 합리적인 인수가 하나 int또는 두 개 라는 것을 어떻게 표현할 수 int있습니까? type(args)제공 Tuple내 생각 엔이 같은 유형에 주석을했다, 그래서 Union[Tuple[int, int], Tuple[int]],하지만이 작동하지 않습니다.

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

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]]"

mypy는 tuple호출 자체에 있을 것으로 기대하기 때문에 함수 호출에 대해 이것을 좋아하지 않는 것이 좋습니다 . 포장 풀기 후 추가하면 이해할 수없는 입력 오류가 발생합니다.

어떻게 하나의 분별 유형을 주석 않습니다 *args와 **kwargs?

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

유형 힌트 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 이상을 의미하며 유형 힌트로보다 구체적인 범위로 제한 할 수 없습니다.

이를 수행하는 올바른 방법은 @overload

from typing import overload

@overload
def foo(arg1: int, arg2: int) -> int:
    ...

@overload
def foo(arg: int) -> int:
    ...

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

print(foo(1))
print(foo(1, 2))

@overload실제 구현에 주석을 추가 하거나 입력 하지 마십시오 .

스텁 파일 외부에서typing @overload를 지원하려면 새로운 버전 과 mypy가 모두 필요 합니다 .

또한이를 사용하여 어떤 인수 유형이 어떤 리턴 유형에 해당하는지 명시 적으로 표시하는 방식으로 리턴 된 결과를 변경할 수 있습니다. 예 :

from typing import Tuple, overload

@overload
def foo(arg1: int, arg2: int) -> Tuple[int, int]:
    ...

@overload
def foo(arg: int) -> int:
    ...

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

print(foo(1))
print(foo(1, 2))

당신이 주석 대신 유형을 추가하는 데 사용 댓글 파이썬에서이 개 파일과 필요성을 mypy를 사용하려는 경우 이전의 대답에 짧은 추가로, 당신은에 대한 유형을 접두사 필요가 args와 kwargs와 *와 **각각 :

def foo(param, *args, **kwargs):
    # type: (bool, *str, **int) -> None
    pass

이것은 mypy에 의해 아래의 파이썬 3.5 버전과 동일하게 취급됩니다 foo:

def foo(param: bool, *args: str, **kwargs: int) -> None:
    pass