迭代器

1、迭代器

1.1 可迭代对象

• 对list、tuple、str等类型的数据可以使用for…in…的循环语法从其中依次拿到数据进行使用，把这样的过程称为遍历，也叫迭代
• 把可以通过for…in…这类语句迭代读取一条数据供我们使用的对象称之为可迭代对象（Iterable）

1.2 如何判断一个对象是否可以迭代

• 可以使用 isinstance() 判断一个对象是否是 Iterable 对象：

In [1]: from collections import Iterable

In [2]: isinstance([], Iterable)
Out[2]: True

In [3]: isinstance({}, Iterable)
Out[3]: True

In [4]: isinstance('abc', Iterable)
Out[4]: True

In [5]: isinstance(mylist, Iterable)
Out[5]: False

In [6]: isinstance(100, Iterable)
Out[6]: False

1.3 可迭代对象的本质

• 每迭代一次（即在for…in…中每循环一次）都会返回对象中的下一条数据，一直向后读取数据直到迭代了所有数据后结束
• 那么，在这个过程中就应该有一个“人”去记录每次访问到了第几条数据，以便每次迭代都可以返回下一条数据，我们把这个能帮助我们进行数据迭代的“人”称为迭代器(Iterator)
• 可迭代对象的本质就是可以向我们提供一个这样的中间“人”即迭代器帮助我们对其进行迭代遍历使用
• 可迭代对象通过__iter__方法向我们提供一个迭代器，我们在迭代一个可迭代对象的时候，实际上就是先获取该对象提供的一个迭代器，然后通过这个迭代器来依次获取对象中的每一个数据
• 也就是说，一个具备了__iter__方法的对象，就是一个可迭代对象

>>> from collections import Iterable
>>> class MyList(object):
...     def __init__(self):
...             self.container = []
...     def add(self, item):
...             self.container.append(item)
...     def __iter__(self):
...             """返回一个迭代器"""
...             pass
...
>>> mylist = MyList()
>>> isinstance(mylist, Iterable)
True

# 发现mylist对象已经是一个可迭代对象了

1.3 iter()函数与next()函数

• list、tuple等都是可迭代对象，可以通过iter()函数获取这些可迭代对象的迭代器
• 对获取到的迭代器不断使用next()函数来获取下一条数据
• iter()函数实际上就是调用了可迭代对象的__iter__方法

>>> li = [11, 22, 33, 44, 55]
>>> li_iter = iter(li)
>>> next(li_iter)
11
>>> next(li_iter)
22
>>> next(li_iter)
33
>>> next(li_iter)
44
>>> next(li_iter)
55
>>> next(li_iter)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration
>>>

• 注意：当我们已经迭代完最后一个数据之后，再次调用next()函数会抛出StopIteration的异常，来告诉我们所有数据都已迭代完成，不用再执行next()函数了

1.4 如何判断一个对象是否是迭代器

• 可以使用 isinstance() 判断一个对象是否是 Iterator 对象：

In [1]: from collections import Iterator

In [2]: isinstance([], Iterator)
Out[2]: False

In [3]: isinstance(iter([]), Iterator)
Out[3]: True

In [4]: isinstance(iter("abc"), Iterator)
Out[4]: True

1.5 迭代器

• 通过上面的分析，迭代器是用来帮助我们记录每次迭代访问到的位置，当我们对迭代器使用next()函数的时候，迭代器会向我们返回它所记录位置的下一个位置的数据
• 实际上，在使用next()函数的时候，调用的就是迭代器对象的__next__方法，所以，我们要想构造一个迭代器，就要实现它的__next__方法
• 但这还不够，python要求迭代器本身也是可迭代的，所以我们还要为迭代器实现__iter__方法，而__iter__方法要返回一个迭代器，迭代器自身正是一个迭代器，所以迭代器的__iter__方法返回自身即可

import time


class Classmate(object):

    def __init__(self):
        self.names = list()
        self.current_num = 0

    def add(self, name):
        self.names.append(name)

    def __iter__(self):
        """
        如果想要一个对象称为一个可以迭代的对象
        即可以使用for，那么必须实现__iter__方法
        """
        return self
        # 调用iter(xxobj)的时候 只要__iter__方法返回一个迭代器即可
        # 至于是自己还是别的对象都可以的
        # 但是要保证是一个迭代器(即实现了 __iter__  __next__方法)

    def __next__(self):
        if self.current_num < len(self.names):
            ret = self.names[self.current_num]
            self.current_num += 1
            return ret
        else:
            raise StopIteration


classmate = Classmate()
classmate.add("老王")
classmate.add("王二")
classmate.add("张三")


for name in classmate:
    print(name)
    time.sleep(1)

• 也就是说，一个实现了__iter__方法和__next__方法的对象，就是迭代器。

1.6 for…in…循环的本质

• for 循环的本质就是先通过iter()函数获取可迭代对象Iterable的迭代器，然后对获取到的迭代器不断使用next()函数从而调用__next__方法来获取下一个值并将其赋值给item，当遇到StopIteration的异常后循环结束。

1.7 总结

• 想要使用for循环，先看看对象是否可以迭代
  • 创建这个对象的类中是否有__iter__方法，有则该对象为可迭代对象
  • iter函数会主动调用可迭代对象的__iter__方法，返回可迭代对象的迭代器（__iter__方法的返回值为迭代器）
  • iter函数返回的对象所对应的类中有__iter__方法、__next__方法
  • next函数调用迭代器中的__next__方法，返回数据

1.8 并不是只有for循环能接收可迭代对象

除了for循环能接收可迭代对象，list、tuple等也能接收

li = list(FibIterator(15))
print(li)
tp = tuple(FibIterator(6))
print(tp)