前言
类型注解让 Python 代码开起来丑不可言,但随着用它的人越来越多,有时候会不可避免看到或是写出来这样的代码:
def get_age(name: str) -> int:
...
虽然直观上理解起来很方便,但是也有很多比较复杂的,不熟悉的人看起来可能不是很理解。比如:
class Thread:
name: str
ident: Optional[int]
daemon: bool
def __init__(self, group: None = ...,
target: Optional[Callable[..., Any]] = ...,
name: Optional[str] = ...,
args: Iterable = ...,
kwargs: Mapping[str, Any] = ...,
*, daemon: Optional[bool] = ...) -> None: ...
对类型注解有简单的了解,可以方便我们看别人的代码或是在自己的代码中使用它。
简单使用
Python 运行时不强制执行函数和变量类型注解,但这些注解可用于类型检查器、IDE、静态检查器等第三方工具。有了类型注解,IDE 解析代码也会更方便,提示也会更智能。简单使用非常易于理解,比如下面的例子:
def greeting(name: str) -> str:
return 'Hello ' + name
这表示:greeting
函数中,参数 name
的类型是 str
,返回类型也是 str
。子类型也可以当作参数。
注解列表、集合等可迭代对象
GenericAlias 对象是通过对类(通常是容器类)作下标来创建的,如 list[int]
用来表示元素类型为 int
的列表。
通常,容器对象的抽取操作会调用该对象的
__getitem__()
方法。 但是,对某些容器类执行抽取操作可能会改去调用该类的__class_getitem__()
类方法。__class_getitem__()
类方法应当会返回一个GenericAlias
对象。
如果元素的类型不是固定的,那么可以使用 Union
或 |
来表示,比如要注解一个元素类型可能为 str
或 int
的列表,可以这样写:
from typing import Union, List
my_li: List[Union[str, int]]
# 或
my_li: List[str|int]
集合、元组或是自定义的可迭代对应同理。
如果要注解字典呢?
可以用如下方法:
from typing import Dict
my_dict: Dict[int, str]
这表示 my_dict
是一个键类型为 int
,值类型为 str
的字典。
注解可调用对象
预期特定签名回调函数的框架可以用 Callable[[Arg1Type, Arg2Type], ReturnType]
实现类型提示。
比如,要注解一个可调用对象,它接收两个参数,类型分别是 int
, str
,返回的类型是 list
,那么可以这样写:
from typing import Callable
func: Callable[[int, str], list]
另外,无需指定调用签名,用省略号字面量替换类型提示里的参数列表: Callable[..., ReturnType]
,就可以声明可调对象的返回类型。比如上面的例子也可以写为:
from typing import Callable
func: Callable[..., list]
如果要注解没有返回值的对象,可以使用 typing.NoReturn
:
from typing import Callable, NoReturn
func: Callable[..., NoReturn]
typing.NoReturn
同样可以对函数返回注解,如:
def stop() -> NoReturn:
pass
注解常量
常量可以使用 Final
注解,比如:
from typing import Final
NAME: Final = 'Spartan'
对于不可被覆盖的方法,可以用 final
装饰器,例如:
from typing import final
class Foo:
@final
def finish(self):
pass
注解可选参数
使用 Optinal
可以注解可选参数,比如,注解名为 name
的可选参数:
from typing import Optional
def check(name: Optional[str]=None):
pass
泛型
有的类型实在难以描述?没关系,可以使用 TypeVar
定义一个泛型,比如,要注解一个难以描述的类型(暂且称之为 Puzzle
),那么可以这样定义它:
from typing import TypeVar
Puzzle = TypeVar('Puzzle')
然后就可以用它来注解了:
name: Puzzle = ...
Any
Typing.Any
可以表示任意类型,此外,未指定返回值与参数类型的函数,都隐式地默认使用 Any
。
类型别名
把类型赋给别名,就可以定义类型别名。比如:
Vector = list[float]
def scale(scalar: float, vector: Vector) -> Vector:
return [scalar * num for num in vector]
参考
1. [typing --- 类型提示支持 — Python 3.10.1 文档] (https://docs.python.org/zh-cn/3/library/typing.html)