Python 函数注解，给函数贴上小标签

目录

什么是函数注解？

为什么使用函数注解？

如何编写函数注解？

实战演练

与类型提示（Type Hints）的关系

类型安全的运算器

---

什么是函数注解？

函数注解（Function Annotations）是Python 3中新增的一个特性，它允许为函数的参数和返回值指定类型。

这些注解不会改变程序的实际行为，但它们能增强代码的自我文档化能力，帮助其他开发者（或者未来的你）更容易理解函数的用途和预期输入输出类型。

简单来说，函数注解就像是给函数签名贴上的小标签，让信息一目了然。

为什么使用函数注解？

1. 增强可读性：通过注解，可以明确指出参数和返回值的预期类型，减少阅读代码时的猜测工作。

2. 工具支持：IDE（集成开发环境）和静态分析工具可以利用这些注解提供更智能的代码补全、类型检查等功能。

3. 自动生成文档：一些工具如Sphinx可以通过函数注解自动生成更详细的API文档。

4. 装饰器和框架的高级用法：某些库和框架能够利用这些注解实现更复杂的逻辑，比如自动验证输入类型、实现依赖注入等。

如何编写函数注解？

函数注解写在函数定义中的参数列表和冒号之间，以及函数体之前，使用->来分隔参数注解和返回值注解。基本格式如下：

def 函数名(参数名: 参数类型) -> 返回值类型:
    函数体

这里的类型可以是Python内置类型（如int, str），也可以是自定义类型或类，甚至是表达式。

def function_name(param1: type1, param2: type2) -> return_type:
    pass

: type1和: type2是参数注解，表示param1和param2应该是什么类型；-> return_type是返回值注解，表示函数返回值的预期类型。