Python的参数注解是函数定义时用于标注参数和返回值预期类型或含义的语法,从语法层面来说,它是完全支持使用字符串作为注解内容的。这种特性在很多复杂场景下能解决不少实际问题,下面我们来详细了解相关细节。

参数注解的基本语法
Python的参数注解写在参数名后面,用冒号分隔,返回值注解写在函数定义末尾,用->分隔,注解的值可以是任意合法的Python表达式,字符串自然也包含在内。下面是一个简单的示例:
def add(a: "int类型的数字", b: "int类型的数字") -> "返回两个数字的和":
return a + b
print(add(1, 2))
print(add.__annotations__)运行上面的代码,会发现函数可以正常执行,而且__annotations__属性里存储的注解就是对应的字符串内容,这说明字符串作为注解是完全合法的。
为什么需要使用字符串作为注解
字符串注解最常用的场景是解决循环引用问题。比如有两个类互相引用,直接用类名作为注解会出现未定义错误,用字符串就可以避免这个问题:
class A:
def link(self, b: "B"):
self.b = b
class B:
def link(self, a: "A"):
self.a = a
a = A()
b = B()
a.link(b)
b.link(a)如果这里直接写b: B,在定义类A的时候类B还没有定义,就会抛出NameError,用字符串"B"就不会有这个问题。
字符串注解和常规类型注解的区别
常规的类型注解比如a: int,在运行时__annotations__里存储的是int类型本身,而字符串注解存储的是字符串对象。如果需要把字符串注解解析成对应的类型,需要手动处理,比如使用eval或者typing.get_type_hints函数:
from typing import get_type_hints
def func(a: "int", b: "str") -> "float":
return float(a) + len(b)
# 直接获取注解,得到的是字符串
print(func.__annotations__) # {'a': 'int', 'b': 'str', 'return': 'float'}
# 使用get_type_hints解析,会把字符串转换成对应的类型
hints = get_type_hints(func)
print(hints) # {'a':, 'b':, 'return':} 需要注意的是,get_type_hints解析字符串注解的时候,要求字符串对应的名称在当前全局命名空间里是可访问的,否则会抛出错误。
使用字符串注解的注意事项
- 字符串注解不会被Python解释器自动校验,即使传入的参数类型和字符串标注的不一致,也不会报错,它只是元数据,没有强制类型检查的作用。
- 如果字符串内容不是合法的类型名称,使用
get_type_hints解析的时候会失败,所以使用字符串注解的时候要保证字符串内容是可解析的。 - 在Python 3.7之后,
from __future__ import annotations可以让所有注解默认变成字符串形式,不需要手动加引号,这是PEP 563引入的特性,更适合处理复杂的注解场景。
总结
Python的参数注解完全支持使用字符串,这种用法在解决循环引用、延迟注解解析等场景下非常实用。开发者可以根据实际需求选择使用常规类型注解还是字符串注解,只要注意字符串注解的解析规则和使用限制,就能更好地发挥参数注解的作用。