Python迭代器实现

引言

在Python编程中，我们经常使用for-in语句对容器进行迭代。容器类(比如列表、元组等)之所以可以被for-in语句迭代，是因为这些容器类实现了__iter__魔术方法。这个方法返回一个迭代器对象。迭代器对象实现了__next__魔术方法，这个方法可以移动迭代器和获取迭代器指向的值。如果我们想要实现支持迭代的对象，只需要实现__iter__方法以及__iter__返回的迭代器对象的__next__方法即可。

__iter__和__next__

__iter__方法的作用是返回一个迭代器对象。这个迭代器对象需要实现__next__方法(一般也需要实现__iter__方法)。迭代器对象在内部保存了它的状态(迭代器在容器中的位置)。__next__方法将迭代器向后移动一个位置并返回迭代器指向的值。__iter__刚返回的迭代器对象指向“第0个元素”，调用__next__会将迭代器移动到第一个元素的位置，然后返回容器中的第一个元素。再次调用__next__会将迭代器移到第二个元素的位置并返回第二个元素，以此类推。如果迭代器已经移动到了容器的最后一个元素，继续调用__next__会抛出StopIterator异常。后续调用__next__仍然会抛出这个异常，如果我们实现自己的迭代器，也需要遵守这个规定。

以下这段代码：

for i in obj:
    pass # do something

相当于：

iterator = obj.__iter__()
while True:
    try:
        i = obj.__next__()
        pass # do something
    except StopIteration:
        break;

实现可迭代的斐波那契数列类

在本节中我们将使用之前提到的迭代器的实现方法实现可迭代的斐波那契数列类——Fibonacci。Fibonacci类的构造函数接受一个参数x。我们对一个Fibonacci对象迭代可以获取从1到x这一区间内所有的斐波那契数的序列。实现如下：

class Iterator:
    def __init__(self, x):
        self.x = x
        self.n1 = 0
        self.n2 = 1

    def __next__(self):
        self.n1, self.n2 = self.n2, self.n1 + self.n2
        if self.n1 > self.x:
            raise StopIteration
        return self.n1


class Fibonacci:
    def __init__(self, x):
        self.x = x

    def __iter__(self):
        return Iterator(self.x)


# 例子
for i in Fibonacci(100):
    print(i)

参考

1. 迭代器类型