Python 函数注释

相较于以往采用文档字符串去注释函数,现在 Python 提供了更为轻便的,为小型功能函数准备的函数注释功能。

如何添加函数注释

在参数后添加英文半角冒号,注释类型
在函数定义括号后使用一个连字符和右尖括号,注释返回参数类型
 下面是例子:

def foo(name: str, age: int) -> int:
    pass

注意

显然,这个类型可以是你瞎编的。但引入某些类型的注释时,需要引入 typing 中相应的模块,如:

from typing import List
def foo(A: List[int]) -> int:
    pass

当然,你仍然可以给参数添加默认值:

from typing import List
def foo(A: List[int] = [1, 2, 3, 4, 5]) -> int:
    pass