尚未真正支持

Question

我尝试使用抽象基类的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注明合理的类型？

Answer 1

对于变量位置参数（*args）和变量关键字参数（**kw），您只需要为一个这样的参数指定期望值。

来自类型提示 PEP的Arbitrary argument lists and default argument values section：

任意参数列表也可以是类型注释，因此定义：
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或更多，并且不能通过类型提示限制到更具体的范围。

Answer 2

作为上一个答案的一个简短补充，如果您尝试在Python 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

Answer 3

执行此操作的正确方法是使用@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和mypy的新版本才能获得对@overload outside of stub files的支持。

您还可以使用它来改变返回的结果，使显式哪些参数类型与哪种返回类型相对应。 e.g：

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 4

尚未真正支持

虽然您可以用一种类型注释可变参数，但我认为它不是很有用，因为它假定所有参数都属于同一类型。

mypy还不支持允许分别指定每个可变参数的*args和**kwargs的正确类型注释。有人建议在Expand模块上添加一个mypy_extensions帮助器，它会像这样工作：

class Options(TypedDict):
    timeout: int
    alternative: str
    on_error: Callable[[int], None]
    on_timeout: Callable[[], None]
    ...

def fun(x: int, *, **options: Expand[Options]) -> None:
    ...

GitHub issue已于2018年1月开放，但仍未关闭。请注意，虽然问题是关于**kwargs的，但Expand的语法也可能会用于*args。

Answer 5

在某些情况下，**kwargs 的内容可以是多种类型。

这似乎对我有用：

from typing import Any

def testfunc(**kwargs: Any) -> None:
    print(kwargs)

或

from typing import Any, Optional

def testfunc(**kwargs: Optional[Any]) -> None:
    print(kwargs)

如果您觉得需要限制 **kwargs 中的类型，我建议创建一个类似结构的对象并在那里添加类型。这可以通过数据类或 pydantic 来完成。

from dataclasses import dataclass

@dataclass
class MyTypedKwargs:
   expected_variable: str
   other_expected_variable: int


def testfunc(expectedargs: MyTypedKwargs) -> None:
    pass

Answer 6

如果想要描述 kwargs 中期望的特定命名参数，则可以传入一个 TypedDict 来定义必需和可选参数。可选参数是 kwargs：

import typing

class RequiredProps(typing.TypedDict):
    # all of these must be present
    a: int
    b: str

class OptionalProps(typing.TypedDict, total=False):
    # these can be included or they can be omitted
    c: int
    d: int

class ReqAndOptional(RequiredProps, OptionalProps):
    pass

def hi(req_and_optional: ReqAndOptional):
    print(req_and_optional)

输入* args和** kwargs的注释

6 个答案:

尚未真正支持