如何在Python中设计支持迭代协议的自定义数据结构

老伟君_5209

老伟君_5209

2026-11-17

719人浏览

原创

__iter__ 必须返回迭代器对象(实现__next__),而非self或可迭代对象;否则无法支持多次独立遍历、与内置函数兼容,且易破坏迭代协议。

如何在python中设计支持迭代协议的自定义数据结构

为什么 __iter__ 必须返回迭代器,而不是直接返回 self

很多初学者写自定义类时,会直接在 __iter__ 里用 yield 或返回一个列表,结果发现多次遍历失败、或与内置函数(如 list()、sum())行为不一致。根本原因是:迭代协议要求 __iter__ 返回一个**迭代器对象**(即实现了 __next__ 的对象),而不是可迭代对象本身。

如果返回 self,那这个类就必须同时实现 __next__,且要能维护内部状态(比如当前索引)。否则第二次 for 循环就会从头开始,或抛出 StopIteration 后永远卡住。

实操建议:

  • 若数据结构天然支持“重放”(如列表、元组),优先返回新生成的迭代器(例如 iter(self._data) 或用生成器函数)
  • 若需保持状态(如流式读取、单次消费场景),才让 self 同时充当可迭代对象和迭代器——但必须在 __iter__ 中重置状态(如 self._index = 0)
  • 避免在 __iter__ 中返回 [x for x in ...] 这类一次性列表——它虽可迭代,但不是迭代器;且会提前耗尽内存

用生成器函数实现 __iter__ 最安全

生成器函数(含 yield)天然返回迭代器,状态由 Python 运行时管理,不易出错,也符合“一次一值”的迭代语义。

比如实现一个只读的二维坐标容器:

class PointCollection:
    def __init__(self, points):
        self._points = points  # list of (x, y)
<pre class="brush:php;toolbar:false;">def __iter__(self):
    for x, y in self._points:
        yield (x, y)  # 自动包装成 generator object

这样就能直接用于 for p in points:、list(points)、max(points, key=lambda p: p[0]) 等所有标准迭代场景。

注意点:

  • 不要在生成器里修改 self._points —— 迭代期间修改底层数据容易引发 RuntimeError: dictionary changed size during iteration 类似问题
  • 如果想支持反向迭代,额外实现 __reversed__,别依赖 reversed() 对生成器的默认行为(它会先转成列表)
  • 生成器无法被 len() 调用,若需长度支持,得单独实现 __len__

当需要支持 next() 和手动控制时,必须分离迭代器类

如果自定义结构要支持多路并发迭代(比如两个 for 循环同时遍历同一个对象),就不能让 self 兼任迭代器——因为状态会互相干扰。

Python 环境工具基础版
Python 环境工具基础版

管理 Python 项目环境,支持虚拟环境创建、依赖安装与环境诊断

下载

正确做法是把迭代逻辑抽到独立类中:

class PointIterator:
    def __init__(self, collection):
        self._collection = collection
        self._index = 0
<pre class="brush:php;toolbar:false;">def __iter__(self):
    return self

def __next__(self):
    if self._index >= len(self._collection._points):
        raise StopIteration
    point = self._collection._points[self._index]
    self._index += 1
    return point

class PointCollection: def init(self, points): self._points = points

def __iter__(self):
    return PointIterator(self)

这样每次调用 __iter__ 都创建新迭代器实例,彼此状态隔离。

常见坑:

  • 忘记在 __next__ 中抛 StopIteration —— 导致无限循环
  • 在 PointIterator.__next__ 中直接访问 self._collection._points[self._index] 却没做越界检查 —— 抛 IndexError 而非 StopIteration,破坏协议
  • 把迭代器类写成闭包或嵌套函数——无法被 pickle,也不利于调试

测试是否真正符合迭代协议:三步验证法

光看能不能 for 循环不够。真正合规要过三关:

  • 能被 iter(obj) 正常调用,且返回对象有 __next__ 方法
  • 该返回对象能被多次 next() 调用,直到抛 StopIteration
  • 同一个对象能被多个独立 iter() 调用,各自走自己的进度

快速验证示例:

obj = PointCollection([(1,2), (3,4)])
it1 = iter(obj)
it2 = iter(obj)
print(next(it1))  # (1, 2)
print(next(it2))  # (1, 2) —— 不受 it1 影响
print(next(it1))  # (3, 4)

如果第二行输出不是 (1, 2),说明迭代器没隔离;如果第三行报错或重复输出,说明状态没重置或越界处理不对。

最易被忽略的是「多迭代器并存」这一条——很多看似工作的实现,在真实业务中遇到 zip(a, b) 或 itertools.chain() 就崩,根源就在这儿。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1931

4

python能做什么
python能做什么

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

2023.07.25

5504

7

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

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

2023.07.31

1889

3

python教程
python教程

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

2023.08.03

33537

23

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

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

2023.08.04

3927

5

python eval
python eval

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

2023.08.04

3947

5

scratch和python区别
scratch和python区别

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

2023.08.11

1283

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3063

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程