0

0

Python 如何用 typing.Protocol 定义“鸭子类型”接口

舞夢輝影

舞夢輝影

发布时间:2026-01-23 20:48:10

|

914人浏览过

|

来源于php中文网

原创

typing.Protocol 是结构类型检查机制,仅在静态类型检查时生效,不生成运行时对象,也不参与 isinstance 或 issubclass 判断;需用 @runtime_checkable 才支持运行时结构校验。

python 如何用 typing.protocol 定义“鸭子类型”接口

typing.Protocol 本质是结构类型检查,不是运行时接口

Python 的 Protocol 不会生成运行时对象,也不参与 isinstanceissubclass 判断——它只在类型检查器(如 mypy、pyright)中生效。如果你期望用 isinstance(obj, MyProtocol) 来做运行时鸭子类型校验,会直接报错:TypeError: isinstance() argument 2 cannot be a parameterized generic

常见误用场景:把 Protocol 当成抽象基类(ABC)来用,结果运行时报错或类型检查不触发。关键区别在于:Protocol 关注“有没有这些方法”,ABC 关注“是不是这个类型”。

  • 要运行时检查鸭子类型,得自己写 hasattr + callable 组合,或用 collections.abc 中的现成 ABC(如 Iterable
  • 要让 mypy 报错,必须开启类型检查(例如命令行加 --strict),否则 Protocol 形同虚设
  • 定义带泛型的 Protocol 时,必须继承 Generic[T],且不能漏掉 __parameters__ 的隐式推导逻辑

定义最小可行 Protocol:只声明方法签名,不写实现

Protocol 类里只允许出现方法签名、属性注解、类变量(带默认值的常量),禁止任何方法体、self 参数的具体类型标注(除非是泛型绑定)、__init__ 实现等。否则 mypy 会警告 Protocol cannot have non-method members

例如想约束“能被 len() 调用且支持索引”的对象:

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

from typing import Protocol

class SizedIndexable(Protocol): def len(self) -> int: ... def getitem(self, i: int) -> str: ...

注意三点:

  • 方法末尾必须加 ...(省略号),这是语法强制要求,表示无实现
  • 返回类型必须明确,不能留空或写 pass
  • 如果方法接受泛型参数(如 T),需在类头声明 class MyProto(Protocol, Generic[T]):

Protocol 和 ABC 混用:用 @runtime_checkable 让 isinstance 生效

标准库typing.runtime_checkable 装饰器可以让某个 Protocol 支持运行时 isinstance 检查,但仅限于“结构匹配”——即对象动态拥有所有声明的方法/属性,且它们是可调用的。

ghiblitattoo
ghiblitattoo

用AI创造独特的吉卜力纹身

下载

示例:

from typing import Protocol, runtime_checkable

@runtime_checkable class Readable(Protocol): def read(self, size: int = -1) -> bytes: ...

class FakeFile: def read(self, size: int = -1) -> bytes: return b"hello"

assert isinstance(FakeFile(), Readable) # ✅ 成立

但要注意:

  • @runtime_checkable 不检查方法签名是否一致(比如参数名、默认值、返回类型),只检查存在性和可调用性
  • 若对象的 read 方法实际接收 **kwargsisinstance 仍返回 True,但类型检查器可能报错
  • 装饰后无法再继承其他 Protocol(mypy 限制),多继承需谨慎

Protocol 常见陷阱:__init__、属性赋值、可变默认参数

很多人试图在 Protocol 中定义 __init__ 来约束构造方式,这是无效的——Protocol 不控制实例化过程。同样,给属性赋值(如 name: str = "default")会被视为实例变量,而非类型契约的一部分,容易误导。

真正该关注的是“调用后行为”,比如:

  • 需要对象有 .name 属性并可读?写 name: str(只注解,不赋值)
  • 需要对象有 .name 并可写?得额外声明 name: str@name.setter 方法签名
  • 需要兼容 dataclassNamedTuple?确保字段名和类型完全一致,否则 mypy 可能不认为其满足协议
  • 用了可变默认参数(如 def append(self, items: list = []))?类型检查器会按字面理解,但运行时风险得靠代码规范规避

最易被忽略的一点:Protocol 的成员访问是“宽泛匹配”。哪怕一个类只实现了协议中 1 个方法,mypy 默认也不会报错——除非你显式标注变量类型为该 Protocol,并尝试调用未实现的方法。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

772

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

661

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

765

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

679

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1385

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

570

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

730

2023.08.11

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 15.4万人学习

Django 教程
Django 教程

共28课时 | 3.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号