39、Python迭代器

迭代器是可以迭代的对象。在本教程中，您将学习迭代器的工作原理以及如何使用__iter__和__next__方法构建自己的迭代器。

Python中的迭代器

迭代器在Python中无处不在。它们在for循环，理解，生成器等中优雅地实现，但隐藏在清晰的视野中。

Python中的Iterator只是可以迭代的对象。一个将返回数据的对象，一次返回一个元素。

从技术上讲，Python迭代器对象必须实现两个特殊方法，__iter__()并且__next__()统称为迭代器协议。

如果我们可以从对象中获得一个迭代器，则该对象称为可迭代。Python中的大多数内置容器（例如：list，tuple，string等）都是可迭代的。

该iter()函数（依次调用该__iter__()方法）从它们返回一个迭代器。

通过迭代器进行迭代

我们使用该next()函数手动迭代迭代器的所有项目。当我们到达末尾并且没有更多数据要返回时，它将引发StopIterationException。以下是一个示例。

# define a list
my_list = [4, 7, 0, 3]

# get an iterator using iter()
my_iter = iter(my_list)

# iterate through it using next()

# Output: 4
print(next(my_iter))

# Output: 7
print(next(my_iter))

# next(obj) is same as obj.__next__()

# Output: 0
print(my_iter.__next__())

# Output: 3
print(my_iter.__next__())

# This will raise error, no items left
next(my_iter)

输出

4
7
0
3
Traceback (most recent call last):
  File "<string>", line 24, in <module>
    next(my_iter)
StopIteration

一种自动迭代的更优雅的方法是使用for循环。使用此方法，我们可以迭代可以返回迭代器的任何对象，例如列表，字符串，文件等。

>>> for element in my_list:
...     print(element)
...     
4
7
0
3

迭代器的for循环工作

正如我们在上面的示例中看到的那样，for循环能够自动迭代列表。

实际上，for循环可以迭代任何可迭代的对象。让我们仔细看看如何for在Python中实际实现循环。

for element in iterable:
    # do something with element

实际上是实现为。

# create an iterator object from that iterable
iter_obj = iter(iterable)

# infinite loop
while True:
    try:
        # get the next item
        element = next(iter_obj)
        # do something with element
    except StopIteration:
        # if StopIteration is raised, break from loop
        break

因此，在内部，for循环iter_obj通过调用iter()iterable来创建iterator对象。

具有讽刺意味的是，这个for循环实际上是一个无限的while循环。

在循环内部，它调用next()以获取下一个元素，并for使用该值执行循环的主体。在所有物品耗尽之后，StopIteration将其抬起，并在内部将其卡住，然后循环结束。请注意，任何其他类型的异常都将通过。

构建自定义迭代器

从头开始构建迭代器在Python中很容易。我们只需要实现__iter__()和__next__()方法。

该__iter__()方法返回迭代器对象本身。如果需要，可以执行一些初始化。

该__next__()方法必须返回序列中的下一项。在到达终点时以及在随后的通话中，它必须上升StopIteration。

在这里，我们显示一个示例，该示例将在每次迭代中为我们提供下一个2的幂。幂指数从零开始一直到用户设置的数字。

如果您对面向对象编程不了解，请访问 Python面向对象编程。

class PowTwo:
    """Class to implement an iterator
    of powers of two"""

    def __init__(self, max=0):
        self.max = max

    def __iter__(self):
        self.n = 0
        return self

    def __next__(self):
        if self.n <= self.max:
            result = 2 ** self.n
            self.n += 1
            return result
        else:
            raise StopIteration


# create an object
numbers = PowTwo(3)

# create an iterable from the object
i = iter(numbers)

# Using next to get to the next iterator element
print(next(i))
print(next(i))
print(next(i))
print(next(i))
print(next(i))

输出

1
2
4
8
Traceback (most recent call last):
  File "/home/bsoyuj/Desktop/Untitled-1.py", line 32, in <module>
    print(next(i))
  File "<string>", line 18, in __next__
    raise StopIteration
StopIteration

我们还可以使用for循环来迭代我们的迭代器类。

>>> for i in PowTwo(5):
...     print(i)
...     
1
2
4
8
16
32

Python无限迭代器

不必耗尽迭代器对象中的项目。可以有无限迭代器（永无止境）。在处理此类迭代器时，我们必须小心。

这是一个演示无限迭代器的简单示例。

的内置函数 iter()可以用两个参数称为其中第一个参数必须是一个可调用对象（功能）和第二个是定点。迭代器将调用此函数，直到返回的值等于哨兵。

>>> int()
0

>>> inf = iter(int,1)
>>> next(inf)
0
>>> next(inf)
0

我们可以看到该int()函数始终返回0。因此，将其传递给iter(int,1)它将返回一个迭代器，该迭代器将int()一直调用直到返回的值等于1。这永远不会发生，并且会得到一个无限的迭代器。

我们还可以构建自己的无限迭代器。理论上，以下迭代器将返回所有奇数。

class InfIter:
    """Infinite iterator to return all
        odd numbers"""

    def __iter__(self):
        self.num = 1
        return self

    def __next__(self):
        num = self.num
        self.num += 2
        return num

样本运行如下。

>>> a = iter(InfIter())
>>> next(a)
1
>>> next(a)
3
>>> next(a)
5
>>> next(a)
7

等等…

在这些类型的无限迭代器上进行迭代时，请小心包含终止条件。

使用迭代器的优点是节省了资源。如上图所示，我们无需将整个数字系统存储在内存中就可以获得所有奇数。从理论上讲，我们可以在有限的内存中包含无限的项目。

有一种在Python中创建迭代器的简便方法。要了解更多信息， 请访问：使用yield的Python生成器。