怎么在Python中正确实现迭代器协议的__iter__方法

小强大大_7466

小强大大_7466

2026-11-07

739人浏览

原创

__iter__ 方法必须返回迭代器对象而非可迭代对象;正确做法是返回 iter(self.items)、自定义迭代器实例或生成器函数调用结果,确保每次调用返回独立状态的新迭代器。

怎么在python中正确实现迭代器协议的__iter__方法

__iter__ 方法必须返回一个迭代器对象,不能直接返回列表或生成器表达式

很多人写 __iter__ 时直接 return self.items(假设 self.items 是 list),这会导致实例无法被多次迭代——因为 list 本身是可迭代对象,但不是迭代器。Python 的 for 循环、next() 等操作要求调用 __iter__ 后得到的对象必须有 __next__ 方法。

正确做法是返回一个具备完整迭代器协议的对象:

  • 返回 iter(self.items)(最常用,复用内置逻辑)
  • 返回自定义类实例(该类实现 __next__ 和 __iter__)
  • 返回生成器函数调用结果(如 self._gen(),其中 _gen 是带 yield 的方法)

不要在 __iter__ 里重置内部状态,除非你明确需要每次迭代都从头开始

如果类自身维护游标(比如有个 self.index),在 __iter__ 中把它重置为 0 是常见错误——这会让同一个实例无法支持多个并发迭代器(例如嵌套 for 循环或 zip(a, a))。Python 迭代器协议要求:每个调用 __iter__ 返回的迭代器应独立工作。

正确策略:

  • 让 __iter__ 总是返回新对象(如 return MyIterator(self.items))
  • 或者返回生成器函数调用(天然隔离状态):return self._iterate(),其中 _iterate 是 def _iterate(self): yield from self.items
  • 避免在 __iter__ 中修改 self.index 或类似字段

生成器函数是最简洁安全的 __iter__ 实现方式

写一个单独的生成器方法,然后在 __iter__ 中调用它,既清晰又自动满足协议——生成器对象原生支持 __iter__ 和 __next__,且每次调用都产生新状态。

示例:

class Countdown:
    def __init__(self, start):
        self.start = start
<pre class="brush:php;toolbar:false;">def __iter__(self):
    return self._countdown()  # 每次返回新生成器

def _countdown(self):
    n = self.start
    while n > 0:
        yield n
        n -= 1

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载

注意:return self._countdown() 不是 return self._countdown(后者返回函数对象,没调用);也不能写成 yield from self._countdown()——那会让 __iter__ 自身变成生成器,违反协议(__iter__ 必须返回迭代器,不是生成器函数)。

区分“可迭代对象”和“迭代器”,别混淆 __iter__ 的返回值类型

常见误判:以为实现了 __iter__ 就是迭代器。其实不是——它是“可迭代对象”。真正的迭代器必须同时有 __iter__(通常返回 self)和 __next__。如果你的类既要当容器又要当迭代器(比如单次遍历的流式处理器),那它得自己实现 __next__,并在 __iter__ 中返回 self。

但要注意副作用:

  • 这种设计下,同一个实例只能被迭代一次(第二次会立即抛 StopIteration)
  • 无法与 itertools 中多数函数兼容(它们假定输入是可重复迭代的)
  • 调试时容易困惑:为什么 list(obj); list(obj) 第二次是空的?

除非业务场景明确要求单次消费(如读取一次的文件流、网络响应体),否则优先用“可迭代对象 + 独立迭代器”的分离模式。

最容易被忽略的是:__iter__ 的语义不是“开始迭代”,而是“提供一个能迭代的东西”。它的返回值生命周期、状态隔离、是否可重入,直接决定你的类在真实数据流场景中会不会出 bug。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1891

4

python能做什么
python能做什么

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

2023.07.25

5164

7

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

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

2023.07.31

1829

3

python教程
python教程

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

2023.08.03

31177

23

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

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

2023.08.04

3687

5

python eval
python eval

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

2023.08.04

3707

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2863

5

热门下载

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

精品课程

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