Python基础之给函数增加元信息

1. 参数注解

当写好一个函数以后，想为这个函数的参数添加一些额外的信息，这样的话，其他的使用者就可以清楚的知道这个函数应该怎么使用，这个时候可以使用函数参数注解。

函数参数注解能提示程序员应该怎样正确使用这个函数。

比如，下面这个函数就是一个被注解了的函数：

def add(x:int, y:int) -> int:

    return x + y

Python解释器不会对这些注解添加任何的语义。

它们不会被类型检查，运行时跟没有加注解之前的效果也没有任何的差距。

但是，对于那些阅读代码的人来说，就有很大的帮助。

第三方工具和框架可能会对这些注解添加语义，同时它们也会出现在文档中。

def add(x:int, y:int) -> int:

    return x + y

help(add)

执行结果为：

Help on function add in module __main__:

add(x:int, y:int) -> int

你可以使用任意类型的对象给函数添加注解（例如数字，字符串，对象实例等等），但是使用类或者字符串会比较好。

函数的注解只存储在函数的__annotations属性中。例如：

def add(x:int, y:int) -> int:

    return x + y

print(add.__annotations__)

执行结果为：

{'x': <class 'int'>, 'y': <class 'int'>, 'return': <class 'int'>}

尽管注解的使用方法可能会有很多中，但是它们的主要用途还是文档。

因为Python并没有类型声明，通常来讲仅仅通过阅读源码很难知道应该传递什么样的参数给这个函数。

而使用函数注解就能给代码阅读人员更多的提示，让他们可以更好的使用函数。