*args和**kwargs的类型批注

Question

我正在用抽象基类尝试Python的类型注释来编写一些接口。有没有办法注释*args和**kwargs的可能类型？

例如，如何表示函数的合理参数是一个int或两个intstype（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的合理类型？

Answer 1

作为对前面答案的简短补充，如果您试图在Python 2文件上使用mypy，并且需要使用注释来添加类型而不是注释，则需要分别为args和kwargs的类型加上*和**前缀：

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

这被mypy视为与下面相同，Python 3.5版本的foo：

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

Answer 2

正确的方法是使用@重载

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

请注意，您没有向实际实现中添加@重载或类型注释，这些注释必须在最后。

您需要一个新版本的键入和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))

Answer 3

对于可变位置参数（*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或更多，并且不能被类型提示限制为更具体的范围。