函数注释

soccerchen / 2023-07-23 / 原文

这里讲两个函数的用法:__doc__和__annotations__

假设我写了如下的函数:

def f(ham: str, eggs: str = 'eggs') -> str:
    '1254'
    '5234'
    print("Annotations:", f.__annotations__)
    print("Arguments:", ham, eggs)
    return ham + ' and ' + eggs

 f.__doc__的返回值是这个函数第一行的字符串,必须是第一行,而不是第一个字符串,大家可以试一试。这里的用处就很明显了,可以作为对这个函数简单的描述

   f.__annotations__想要有返回值,必须要给每个参数定义一个数据类型,就如上面的代码一样,返回值是Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}

__doc__和__annotations__放在一起作为对函数基本描述的一种应用