Python typing 模块的核心用法

5次阅读

python 3.9+ 推荐直接用 list[str]、dict[str, int] 等内置泛型类型注解,typing.List 等已弃用;Optional[T] 可写作 T | None;union 与 | 行为有差异;Literal 限字面值,Final 防意外重赋值;Protocol 实现结构化鸭子类型。

Python typing 模块的核心用法

typing.List、typing.Dict 这些写法已经过时了

Python 3.9+ 可以直接用内置类型 listdictsettuple 做类型注解,不需要再从 typing 导入。比如:def f(x: list[str]) -> dict[str, int]: ... 是合法且推荐的写法。

旧写法如 typing.List[str] 在 3.9+ 仍能运行,但被标记为 deprecated;3.12 开始部分 ide 和类型检查器(如 mypy)会发出警告。

  • 3.9 之前必须用 typing.List 等,因为内置类型不支持泛型参数
  • 若项目需兼容 3.8 或更早,保留 typing 导入,但建议加 from __future__ import annotations 延迟求值
  • typing.Optional[T] 已可统一写作 T | None(PEP 604),但注意 mypy 默认未启用该语法,需加 --enable-Error-code operator配置文件开启

Union 和 | 的行为差异容易踩坑

| 是类型联合运算符,本质是 types.UnionType 实例,在运行时不是 typing.Union;而 typing.Union[A, B] 在 3.10+ 会被自动转换为 A | B 形式,但二者在反射和类型检查逻辑中可能表现不同。

  • isinstance(x, Union[A, B]) 会报错:Union 不是运行时可检查的类型,应改用 isinstance(x, (A, B))
  • get_origin(T)A | B 返回 types.UnionType,对 Union[A, B] 返回 typing.Union,做类型元编程时需分别处理
  • 嵌套联合如 A | (B | C) 会被自动展平为 A | B | C,但 Union[A, Union[B, C]] 不会自动展平,语义上等价但结构不同

Literal 和 Final 的实际用途很具体

Literal 用于限定变量或参数只能取几个固定字面值,常用于函数重载、状态机、API 字段校验;Final 表示变量不应被重新赋值(仅对模块级/类属性有效),不阻止运行时修改,纯属类型提示。

立即学习Python免费学习笔记(深入)”;

  • def connect(protocol: Literal["http", "https", "ws"]) -> None: 能让 IDE 在调用时高亮非法字符串,mypy 也会报错
  • MAX_RETRY: Final = 3 配合 mypy 的 --warn-unused-ignores 可捕获意外赋值,但 MAX_RETRY = 5 在运行时不会出错
  • Literal 不支持变量,只能是字面量(如 "a"1True),不能是 const = "a"; x: Literal[const]

Protocol 是鸭子类型的形式化,但别滥用

Protocol 允许你定义“只要具备某些方法就算符合类型”,不用继承或注册,适合对接第三方库或松耦合接口。但它不是运行时检查机制,只在静态检查阶段起作用。

  • 定义 class Drawable(Protocol): def draw(self) -> None: ... 后,任何有 draw() 方法的对象都可通过类型检查
  • 协议类里不能有实例变量(除非标注 __slots__ = ()),也不能有 __init__,否则 mypy 会报 Protocol cannot have non-method members
  • 协议默认是协变的,若需逆变或不变,得显式加 class Proto(Protocol, Contravariant=True),但极少需要

真正难的不是记住 typing 有哪些类型,而是判断什么时候该用 Protocol 而不是抽象基类,什么时候该用 TypeVar 绑定泛型而不是硬编码类型,以及如何让类型提示既准确又不增加维护负担——这些往往取决于你正在写的那行代码到底想约束什么、谁会用它、以及类型检查器是否真能帮上忙。

text=ZqhQzanResources