Python 迭代器 - Iterable对象

仅供学习参考，转载请注明出处

迭代器

迭代是访问集合元素的一种方式。迭代器是一个可以记住遍历的位置的对象。迭代器对象从集合的第一个元素开始访问，直到所有的元素被访问完结束。迭代器只能往前不会后退。

1. 可迭代对象

我们已经知道可以对list、tuple、str等类型的数据使用for...in...的循环语法从其中依次拿到数据进行使用，我们把这样的过程称为遍历，也叫迭代。

但是，是否所有的数据类型都可以放到for...in...的语句中，然后让for...in...每次从中取出一条数据供我们使用，即供我们迭代吗？

例如：整型int的数据就无法迭代。

In [1]: for i in 100:
   ...:     print(i)
   ...:     
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-1-86150fa0c47d> in <module>()
----> 1 for i in 100:
      2     print(i)
      3 

TypeError: 'int' object is not iterable

In [2]: 

从上面可以看到错误提示​​TypeError: 'int' object is not iterable​​，提示int并不是迭代类型。

那么类是否是一种迭代类型呢？

In [2]: class MyList(object):
   ...:     def __init__(self):
   ...:         self.list = []
   ...:     def add(self,item):
   ...:         self.list.append(item)
   ...:         

In [3]: mylist = MyList()

In [4]: mylist.add(1)

In [5]: mylist.add(2)

In [6]: mylist.add(3)

In [8]: for num in mylist:
   ...:     print(num)
   ...:     
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-8-1e13316c02cd> in <module>()
----> 1 for num in mylist:
      2     print(num)
      3 

TypeError: 'MyList' object is not iterable

In [9]: for num in mylist.list:
   ...:     print(num)
   ...:     
1
2
3

In [10]: 

从上面可以看出，就算定义一个类的一个值为list这种迭代类型，自身类也并不是迭代类型。其实在写的过程就肯定觉得有问题的。

那么如果改写一下，让类变成可迭代的类型呢？

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

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

In [10]: from collections import Iterable

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

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

In [13]: isinstance('hello',Iterable)
Out[13]: True

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

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

In [16]: 

从上面的执行来看，list、dict、string等都是Iterable对象类型，而mylist实例、100都不是。

3. 可迭代对象的本质

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

给前面的​​Mylist​​​类新增一个​​__iter__​​方法，再查看对象是否为可迭代对象

In [16]: class MyList(object):
    ...:     def __init__(self):
    ...:         self.list = []
    ...:     def add(self,item):
    ...:         self.list.append(item)
    ...:     def __iter__(self):
    ...:         pass
    ...:         

In [18]: mylist = MyList()

In [19]: isinstance(mylist,Iterable)
Out[19]: True

In [20]: 

这回测试发现添加了​​__iter__​​​方法的​​mylist​​对象已经是一个可迭代对象了。

4. ​​iter()​​​函数与​​next()​​函数

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

# 创建list
In [20]: li = [1,2,3,4,5]   

# 将list放入迭代器中
In [21]: li_iter = iter(li)

# 调用next方法，打印迭代器的内容
In [22]: next(li_iter)
Out[22]: 1

In [23]: next(li_iter)
Out[23]: 2

In [24]: next(li_iter)
Out[24]: 3

In [25]: next(li_iter)
Out[25]: 4

In [26]: next(li_iter)
Out[26]: 5

# 迭代器next已经没有数据了，这个异常可以类似作为while方法的break条件
In [27]: next(li_iter)
---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-27-ab6a83f394a1> in <module>()
----> 1 next(li_iter)

StopIteration: 

In [28]: 

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

5. 迭代器​​Iterator​​

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

In [21]: class MyList(object):
    ...:     def __init__(self):
    ...:         self.list = []
    ...:         self.current = 0
    ...:         
    ...:     def add(self,var):
    ...:         self.list.append(var)
    ...:         
    ...:     def next(self):
    ...:         if self.current < len(self.list):
    ...:             item = self.list[self.current]
    ...:             self.current += 1
    ...:             return item
    ...:         else:
    ...:             raise StopIteration
    ...:         
    ...:     def __iter__(self):
    ...:         return self
    ...:          

In [22]: 

In [22]: mylist = MyList()

In [23]: isinstance(mylist,Iterable)
Out[23]: True

In [24]: mylist.add(1)

In [25]: mylist.add(2)

In [26]: mylist.add(3)

In [27]: mylist.next()
Out[27]: 1

In [28]: mylist.next()
Out[28]: 2

In [29]: mylist.next()
Out[29]: 3

In [30]: mylist.next()
---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-30-1897446021c8> in <module>()
----> 1 mylist.next()

<ipython-input-21-110aa633e856> in next(self)
     13             return item
     14         else:
---> 15             raise StopIteration
     16 
     17     def __iter__(self):

StopIteration: 

In [31]: 

In [31]: 

In [31]: mylist = MyList()

In [32]: mylist.add(1)

In [33]: mylist.add(2)

In [34]: mylist.add(3)

In [35]: for num in mylist:
    ...:     print(num)
    ...:     
1
2
3

In [36]: 

从上面的代码可以看出，在python2使用了next方法之后，就可以正常迭代调用next以及使用for循环进行打印。

6. ​​for...in...​​循环的本质

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

7. 迭代器的应用场景

我们发现迭代器最核心的功能就是可以通过​​next()​​函数的调用来返回下一个数据值。如果每次返回的数据值不是在一个已有的数据集合中读取的，而是通过程序按照一定的规律计算生成的，那么也就意味着可以不用再依赖一个已有的数据集合，也就是说不用再将所有要迭代的数据都一次性缓存下来供后续依次读取，这样可以节省大量的存储（内存）空间。

举个例子，比如，数学中有个著名的斐波拉契数列（​​Fibonacci​​），数列中第一个数为0，第二个数为1，其后的每一个数都可由前两个数相加得到：

0, 1, 1, 2, 3, 5, 8, 13, 21, 34, ...

现在我们想要通过for...in...循环来遍历迭代斐波那契数列中的前n个数。那么这个斐波那契数列我们就可以用迭代器来实现，每次迭代都通过数学计算来生成下一个数。

#coding=utf-8

class FibIterator(object):
    """斐波那契数列迭代器"""
    def __init__(self, n):
        """
        :param n: int, 指明生成数列的前n个数
        """
        self.n = n
        # current用来保存当前生成到数列中的第几个数了
        self.current = 0
        # num1用来保存前前一个数，初始值为数列中的第一个数0
        self.num1 = 0
        # num2用来保存前一个数，初始值为数列中的第二个数1
        self.num2 = 1

    def next(self):
        """被next()函数调用来获取下一个数"""
        if self.current < self.n:
            num = self.num1
            self.num1, self.num2 = self.num2, self.num1+self.num2
            self.current += 1
            return num
        else:
            raise StopIteration

    def __iter__(self):
        """迭代器的__iter__返回自身即可"""
        return self


if __name__ == '__main__':
    fib = FibIterator(10)
    for num in fib:
        print(num)

执行如下：

G:\Python27\python.exe F:/pythonProject/Iter/iter.py
0
1
1
2
3
5
8
13
21
34

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

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

if __name__ == '__main__':
    fib = FibIterator(10)
    for num in fib:
        print(num)
    
    # 使用list接收
    li = list(FibIterator(15))
    print(li)
    
    # 使用tunple接收
    tp = tuple(FibIterator(6))
    print(tp)

执行如下：

[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377]
(0, 1, 1, 2, 3, 5)

关注微信公众号，回复【资料】、Python、PHP、JAVA、web，则可获得Python、PHP、JAVA、前端等视频资料。