*args 和 **kwargs 的类型注释

2025-02-08 08:51:00
admin
原创
68
摘要:问题描述:我正在尝试使用 Python 的类型注释和抽象基类来编写一些接口。有没有办法注释*args和的可能类型**kwargs?例如,如何表达一个函数的合理参数是int或 两个ints?type(args)所以Tuple我的猜测是将类型注释为Union[Tuple[int, int], Tuple[int]...

问题描述:

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

例如,如何表达一个函数的合理参数是int或 两个ints?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


解决方案 1:

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

解决方案 2:

2022 年更新

mypy 团队增加了对 的支持,自Mypy 0.981Unpack或更高版本起可用。

注意!尽管此功能已完成,Unpack[...]但仍被视为实验性的,因此您需要使用--enable-incomplete-features来启用它。

您可以按如下方式使用此功能:

from typing import TypedDict
from typing_extensions import Unpack


class RequestParams(TypedDict):
    url: str
    allow_redirects: bool


def request(**kwargs: Unpack[RequestParams]) -> None:
    ...

如果使用requestTypedDict 中定义的参数调用该函数,则不会出现任何错误:

# OK
request(url="https://example.com", allow_redirects=True)

如果你忘记传递参数,mypy 会立即通知你

相关推荐
  政府信创国产化的10大政策解读一、信创国产化的背景与意义信创国产化,即信息技术应用创新国产化,是当前中国信息技术领域的一个重要发展方向。其核心在于通过自主研发和创新,实现信息技术应用的自主可控,减少对外部技术的依赖,并规避潜在的技术制裁和风险。随着全球信息技术竞争的加剧,以及某些国家对中国在科技领域的打压,信创国产化显...
工程项目管理   1590  
  为什么项目管理通常仍然耗时且低效?您是否还在反复更新电子表格、淹没在便利贴中并参加每周更新会议?这确实是耗费时间和精力。借助软件工具的帮助,您可以一目了然地全面了解您的项目。如今,国内外有足够多优秀的项目管理软件可以帮助您掌控每个项目。什么是项目管理软件?项目管理软件是广泛行业用于项目规划、资源分配和调度的软件。它使项...
项目管理软件   1361  
  信创产品在政府采购中的占比分析随着信息技术的飞速发展以及国家对信息安全重视程度的不断提高,信创产业应运而生并迅速崛起。信创,即信息技术应用创新,旨在实现信息技术领域的自主可控,减少对国外技术的依赖,保障国家信息安全。政府采购作为推动信创产业发展的重要力量,其对信创产品的采购占比情况备受关注。这不仅关系到信创产业的发展前...
信创和国产化的区别   18  
  信创,即信息技术应用创新产业,旨在实现信息技术领域的自主可控,摆脱对国外技术的依赖。近年来,国货国用信创发展势头迅猛,在诸多领域取得了显著成果。这一发展趋势对科技创新产生了深远的推动作用,不仅提升了我国在信息技术领域的自主创新能力,还为经济社会的数字化转型提供了坚实支撑。信创推动核心技术突破信创产业的发展促使企业和科研...
信创工作   18  
  信创技术,即信息技术应用创新产业,旨在实现信息技术领域的自主可控与安全可靠。近年来,信创技术发展迅猛,对中小企业产生了深远的影响,带来了诸多不可忽视的价值。在数字化转型的浪潮中,中小企业面临着激烈的市场竞争和复杂多变的环境,信创技术的出现为它们提供了新的发展机遇和支撑。信创技术对中小企业的影响技术架构变革信创技术促使中...
信创国产化   19  
热门文章
项目管理软件有哪些?
云禅道AD
禅道项目管理软件

云端的项目管理软件

尊享禅道项目软件收费版功能

无需维护,随时随地协同办公

内置subversion和git源码管理

每天备份,随时转为私有部署

免费试用