首页 > 解决方案 > 如何定义重载类型签名?

问题描述

我有一个带有重载签名的 Python 函数,例如 float → float、str → int。我希望它正确输入,使用注释等,以便 mypy 可以正确检查它,并且像自动完成这样的工具可以工作。这可能吗?我很欣赏不同的工具会有不同的支持,所以 mypy 可以成为这个问题的标准。我可以使用任何已发布的 Python 3 版本。

标签: pythonoverloadingtype-hintingtypecheckingpython-typing

解决方案


是的,您可以使用@typing.overload装饰器。

来自https://docs.python.org/3/library/typing.html#typing.overload

@overload
def process(response: None) -> None:
    ...
@overload
def process(response: int) -> tuple[int, str]:
    ...
@overload
def process(response: bytes) -> str:
    ...
def process(response):
    <actual implementation>

那些省略号 ( ...) 是字面的。实际上,您将为每个重载函数签名键入三个点。实际代码将进入最终定义。


推荐阅读