为什么要注解函数？

在Python中，注解（annotation）是对函数参数和返回值的补充说明，可以用来增强代码的可读性和可维护性。通过注解，我们可以清晰地定义输入输出的数据类型、参数的含义，以及函数实现的目的，让代码更加易于理解和使用。

函数注解的正确使用方法

在 Python 3 中，注解通常是放在函数定义的第一行，如下所示：

def greet(name: str) -> str:

    return f"Hello {name}"

其中，“:”后面的部分就是注解，它定义了该函数的一个参数 name 的类型为 str，返回值的类型为 str。

需要注意的是，注解并不会对代码的运行产生影响，它仅仅是对代码的说明。因此，我们建议在注解时要谨慎选择类型，避免让注解与实际代码出现矛盾。

除此之外，还有一些注解的使用技巧：

如果一个参数的类型可以是多个类型之一，可以使用 Union 类型

如果一个参数是可选的，可以使用 Optional 类型

如果注解过长，可以使用括号来换行

注解的更多用途

除了用来说明函数参数和返回值的类型之外，注解还有其他的用途。例如，我们可以用注解来标记函数的状态：

def fib(n: int, cache={0: 0, 1: 1}) -> int:

    if n not in cache:
        cache[n] = fib(n - 1, cache) + fib(n - 2, cache)

    return cache[n]

这里，我们为函数 fib 增加了一个缓存 cache，用来存储已经计算过的斐波那契数值。由于 Python 函数默认参数值在模块加载时就被创建，因此我们使用了一个可变对象（在此例中是字典）作为参数的默认值，以避免缓存在不同的函数调用之间共享。

再看一个例子，我们可以使用注解来指定函数的参数范围：

def foo(x: int) -> int:

    assert x > 0, "x must be positive"
    return x * 2

这里，我们使用 assert 语句来检查参数 x 是否满足条件，如果不满足则抛出 AssertError 异常。

总结

Python 函数注解可以用来增强代码的可读性、可维护性和可减少 bug 的数量。通过注解，我们可以清晰地定义输入输出的数据类型、参数的含义，以及函数实现的目的，让代码更加易于理解和使用。正确使用注解，可以帮助我们编写更好的 Python 代码。