typing.Protocol 如何定义“鸭子类型”接口约束

typing.Protocol 是 Python 3.8+ 中用于定义鸭子类型接口的结构化类型检查机制,不需继承或注册,仅要求实现指定方法和属性签名,运行时无开销,仅被静态检查工具(如 mypy)识别,isinstance 检查始终返回 False。

typing.Protocol 是 Python 3.8+ 中用于定义“鸭子类型”接口约束的核心机制——它不关心对象属于哪个类,只关心对象是否具备指定的方法和属性签名。

Protocol 的本质是结构化类型检查

与抽象基类(ABC)不同,Protocol 不需要显式继承或注册,只要一个类实现了 Protocol 中定义的所有方法和属性(包括类型签名),类型检查器(如 mypy)就认为它“符合该协议”。运行时完全无开销,纯静态检查工具支持。

  • Protocol 类本身不能被实例化,仅用于类型提示
  • 子类无需 __subclasshook__register(),实现即满足
  • 支持继承、泛型、类变量、实例变量、可选成员(用 typing.Optional... 注解)

定义一个基础 Protocol 示例

比如定义一个可序列化的鸭子类型:

```python
from typing import Protocol

class Serializable(Protocol):
def to_dict(self) -> dict: ...
@classmethod
def from_dic

t(cls, data: dict) -> 'Serializable': ...

# 任意类只要实现这两个方法,就可通过类型检查
class User:
def to_dict(self) -> dict:
return {"name": "Alice"}
@classmethod
def from_dict(cls, data: dict) -> 'User':
return cls()

def save(obj: Serializable) -> str:
return str(obj.to_dict()) # mypy 认为合法

save(User()) # ✅ 通过类型检查
```

处理可选成员与运行时检查

Protocol 默认要求所有成员必须存在。若需表达“有或没有某方法”,可用 typing.Optional 注解属性,或用 typing.cast + hasattr 做运行时判断:

  • 方法不可标为 Optional,但可定义两个 Protocol:一个带方法,一个不带,再用 Union
  • 实际运行中,仍需用 hasattr(obj, "method")getattr(obj, "method", None) 安全调用
  • mypy 不会检查运行时是否存在,只校验标注的结构一致性

与 ABC 和 isinstance 的关键区别

Protocol 是纯静态契约;ABC 是运行时可识别的类型系统:

  • isinstance(obj, MyProtocol) 永远返回 False(除非手动实现 __subclasshook__
  • Protocol 不影响 MRO、不参与 issubclass 判断
  • 想同时支持静态检查和运行时识别?可让类继承 ABC 实现同名 Protocol(正交设计)