登录
首页 >  文章 >  python教程

Python类实现迭代器协议,\_\_iter\_\_与\_\_next\_\_详解

时间:2026-05-21 23:58:19 456浏览 收藏

Python类实现迭代器协议的核心在于正确理解`__iter__`必须返回一个真正的迭代器对象(而非原始数据),以及`__next__`必须显式抛出`StopIteration`来终止遍历——任何疏漏都会导致无限循环或类型错误;文章深入剖析了两种主流实现策略:让类自身兼任迭代器(需谨慎管理状态并确保可重用性)或分离出独立的迭代器类(提升可维护性与复用性),并强调生成器函数是最简洁安全的多次遍历方案,同时提醒开发者警惕状态生命周期、线程安全及协议语义的细节陷阱。

Python类如何支持迭代协议_实现__iter__与__next__构建可迭代对象

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

因为 Python 的 for 循环、list()sum() 等内置操作只认「迭代器对象」——即实现了 __next__ 方法且能抛出 StopIteration 的对象。如果 __iter__ 直接返回列表或生成器表达式(如 [1,2,3]),虽然也能遍历,但每次调用 __iter__ 都会新建一个独立迭代器;而若错误地返回 self 且没实现 __next__,就会报 TypeError: iter() returned non-iterator of type 'XXX'

正确做法是让 __iter__ 返回一个具备状态的迭代器实例,常见有两种方式:

  • 返回 self(要求该类同时实现 __next__,且内部维护游标状态)
  • 返回一个新的迭代器对象(比如自定义类实例,或用生成器函数 yield 构建)

__next__ 里忘记抛 StopIteration 会怎样?

不抛异常会导致无限循环:Python 迭代协议靠捕获 StopIteration 来判断结束,一旦没抛,for 循环永远不会停,next(obj) 会持续调用直到进程被强制中断。

典型错误写法:

def __next__(self):
    if self.index >= len(self.data):
        # 忘了 return 或 raise
    value = self.data[self.index]
    self.index += 1
    return value

必须显式处理边界:

  • raise StopIteration 终止(推荐,语义清晰)
  • 不能用 return(返回 None 后下一次调用仍继续)
  • 不要依赖 IndexError 自动传播(虽然列表切片会抛,但这是巧合,不是协议要求)

想支持多次遍历,该用 self 还是生成器函数?

取决于是否需要「可重用」。如果类本身设计为单次消费(类似文件对象),返回 self + 状态变量即可;但多数场景(如封装一组数据供多次 for 遍历)必须每次返回新迭代器,否则第二次 for 会从上次中断处继续,甚至直接空跑。

安全又简洁的做法是用生成器函数:

def __iter__(self):
    for item in self.data:
        yield item

这样每次 __iter__ 都返回新的生成器对象,天然支持多次遍历,也不用手动管理索引和异常。但注意:生成器不可逆,也不能随机访问,如果需求含 obj[5]len(obj),还得额外实现 __getitem____len__

自定义迭代器类比直接在主类里写 __next__ 好在哪?

分离关注点。当迭代逻辑复杂(比如树的中序遍历、带过滤/转换的流水线、需暂存上下文的状态机),把迭代器抽成独立类更易测试、复用和调试。主类只需在 __iter__ 中初始化并返回它。

例如:

class DataIterator:
    def __init__(self, data):
        self.data = data
        self.index = 0
    def __iter__(self):
        return self
    def __next__(self):
        if self.index >= len(self.data):
            raise StopIteration
        self.index += 1
        return self.data[self.index - 1]
<p>class MyContainer:
def <strong>init</strong>(self, data):
self.data = data
def <strong>iter</strong>(self):
return DataIterator(self.data)  # 每次都新建
</p>

关键点:

  • 迭代器类自己实现 __iter__ 并返回 self,符合协议
  • MyContainer.__iter__ 不返回 self,所以不影响主类其他用途(比如它还能有 append() 方法)
  • 避免主类因混入迭代状态而变得臃肿或线程不安全

真正容易被忽略的是:迭代器对象的状态生命周期——它只活在一次遍历过程中,用完即弃。别试图缓存它或跨循环复用。

今天带大家了解了的相关知识,希望对你有所帮助;关于文章的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

资料下载
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>