如何让类支持迭代协议？

裘德小鎮的故事

发布： 2025-05-07 12:00:02

原创

793人浏览过

要让一个类支持迭代协议，我们需要实现__iter__和__next__方法。1) 在__iter__方法中初始化迭代状态并返回迭代器对象。2) 在__next__方法中定义每次迭代的逻辑，并在迭代结束时抛出stopiteration异常。这使得类可以被用于for循环和其他迭代场景，增强了代码的灵活性和可读性。

如何让类支持迭代协议？

要让一个类支持迭代协议，我们需要实现 __iter__ 和 __next__ 方法，使得这个类可以被用在 for 循环和其他需要迭代的地方。让我详细解释一下这个过程，并分享一些我自己的经验和思考。

当我第一次接触到迭代协议的时候，我觉得这是一个非常巧妙的设计，它使得 Python 的代码可以更加简洁和优雅。通过实现迭代协议，我们可以让自定义的类和内置的可迭代对象一样，轻松地被遍历。这不仅提高了代码的可读性，也增强了语言的灵活性。

让我们从一个简单的例子开始，来看如何实现一个自定义的迭代器。假设我们想要创建一个类 Countdown，它可以从一个给定的数字开始倒数：

class Countdown:
    def __init__(self, start):
        self.start = start
<pre class='brush:php;toolbar:false;'>def __iter__(self):
    self.n = self.start
    return self

def __next__(self):
    if self.n < 0:
        raise StopIteration
    result = self.n
    self.n -= 1
    return result

登录后复制

使用示例

for num in Countdown(5): print(num)

在这个例子中，Countdown 类实现了 __iter__ 和 __next__ 方法，使得它可以被用于 for 循环。当我们调用 iter(Countdown(5)) 时，__iter__ 方法会被调用，它返回一个迭代器对象（这里是 self）。然后，__next__ 方法会在每次迭代时被调用，直到抛出 StopIteration 异常，结束迭代。

实现迭代器时，我发现了一些关键点和常见的陷阱：

状态管理：在 __iter__ 方法中，我们需要重置迭代器的状态，因为一个迭代器对象可能被多次使用。例如，在 Countdown 类中，我们在 __iter__ 方法中设置 self.n = self.start，确保每次迭代从头开始。
异常处理：正确地使用 StopIteration 异常是非常重要的。如果没有这个异常，迭代会无休止地进行下去，导致程序崩溃。在 Countdown 类中，当 self.n 小于 0 时，我们抛出 StopIteration 异常，结束迭代。
可重入性：在设计迭代器时，要考虑到可重入性，即同一个迭代器对象是否可以被多次使用。如果不需要可重入性，可以在 __iter__ 方法中直接返回一个新的迭代器对象。

如知AI笔记
如知笔记——支持markdown的在线笔记，支持ai智能写作、AI搜索，支持DeepseekR1满血大模型

27

查看详情