函数注解

Python 3 提供了一种句法，用于为函数声明中的参数和返回值附加元数据。二者唯一的区别在第一行。

　　示例 5-19 有注解的 clip 函数

def clip(text:str, max_len:'int > 0'=80) -> str: ➊
    """在max_len前面或后面的第一个空格处截断文本
    """
    end = None
    if len(text) > max_len:
    　　space_before = text.rfind(' ', 0, max_len)
　　　　if space_before >= 0:
　　　　　　end = space_before
　　else:
　　　　space_after = text.rfind(' ', max_len)
　　　　if space_after >= 0:
　　　　　　end = space_after
　　if end is None: # 没找到空格
　　　　end = len(text)
　　return text[:end].rstrip()

➊ 有注解的函数声明。

函数声明中的各个参数可以在 : 之后增加注解表达式。如果参数有默认 值，注解放在参数名和 = 号之间。如果想注解返回值，在 ) 和函数声明 末尾的 : 之间添加 -> 和一个表达式。那个表达式可以是任何类型。注 解中最常用的类型是类（如 str 或 int）和字符串（如 'int > 0'）。在示例 5-19 中，max_len 参数的注解用的是字符串。

注解不会做任何处理，只是存储在函数的 __annotations__ 属性（一 个字典）中：

>>> from clip_annot import clip
>>> clip.__annotations__
{'text': <class 'str'>, 'max_len': 'int > 0', 'return': <class 'str'>}

'return' 键保存的是返回值注解，即示例 5-19 中函数声明里以 -> 标 记的部分。

Python 对注解所做的唯一的事情是，把它们存储在函数的 __annotations__ 属性里。仅此而已，Python 不做检查、不做强制、 不做验证，什么操作都不做。换句话说，注解对 Python 解释器没有任何 意义。注解只是元数据，可以供 IDE、框架和装饰器等工具使用。写作 本书时，标准库中还没有什么会用到这些元数据，唯有 inspect.signature() 函数知道怎么提取注解，如示例 5-20 所示。

　　示例 5-20 从函数签名中提取注解

>>> from clip_annot import clip
>>> from inspect import signature
>>> sig = signature(clip)
>>> sig.return_annotation
<class 'str'>
>>> for param in sig.parameters.values():
... note = repr(param.annotation).ljust(13)
... print(note, ':', param.name, '=', param.default)
<class 'str'> : text = <class 'inspect._empty'>
'int > 0' : max_len = 80

signature 函数返回一个 Signature 对象，它有一个 return_annotation 属性和一个 parameters 属性，后者是一个字 典，把参数名映射到 Parameter 对象上。每个 Parameter 对象自己也 有 annotation 属性。示例 5-20 用到了这几个属性。