Python:将类型提示与注释一起使用

由于注释可以是任何表达式(就Python解释器而言),因此从技术上讲,您可以使用元组作为注释:

def greet(name: (str, "The name of the person to greet")) -> str:
    return "Hello, " + name

正如您所期望的那样,它显示在函数的注释dict中:

>>> greet.__annotations__
{'name': (<class 'str'>, 'The name of the person to greet'), 'return': <class 'str'>}

然而,这只是 有用的 如果你有工具知道它的含义。据我所知,现有的静态类型检查器、linter、文档生成器等都无法识别类型和描述的元组注释。

实际上,我建议使用类型的注释 只有 ,因为这绝大多数是标准用法,并且使用注释或文档字符串来获取更多信息。

正如Samwise所说,类型检查器不会理解注释是否是类型和描述的元组(或者您希望附加的任何其他元数据)。 PEP 593 – Flexible function and variable annotations 通过以下方式准确地解决了这一问题:

from typing import Annotated

@dataclass
class Description:
    x: str

def greet(name: Annotated[str, Description("The name of the person to greet")]) -> str:
    return "Hello, " + name

我们引入包装器类的原因 Description 很明显,编写的字符串是我们使用的描述,所以其他分析注释的库在使用时不会混淆 str 以获取自己的元数据。

然后,根据 typing.Annotated ,您可以使用 typing.get_type_hints(name, include_extras=True) 以在运行时获取描述。