[Python]生成器generator，可迭代Iterable和迭代器Iterator
- 2020 年 3 月 10 日
- 笔记
文章目录
- @[toc]
- 0. 环境
- 1. 生成器 `generator`
- 1.1. 什么是生成器？
- 1.2. 创建生成器
- 方法1：用生成器表达式，`[]`改为`()`
- 方法2：用生成器函数，使用关键字 `yield`
- 1.3. 例子
- 2. 迭代器 `Iterator`
- 2.1. 可迭代 `Iterable`
- 2.2. 迭代器 `Iterator`
- 问题
- 2.3. `可迭代`与`迭代器`
- 2.4. 小结
- 参考文献
[Python]生成器generator，可迭代Iterable和迭代器Iterator
Python文档整理目录： https://blog.csdn.net/humanking7/article/details/80757533
0. 环境
Python 3.6
1. 生成器 generator
1.1. 什么是生成器？
通过列表生成式，我们可以直接创建一个列表，但是受到内存限制，列表容量肯定是有限的，而且创建一个包含
100万个元素的列表，不仅占用很大的存储空间，如果我们仅仅需要访问前面几个元素，那后面绝大多数元素占用的空间都白白浪费了。 所以，如果列表元素可以按照某种算法推算出来，那我们是否可以在循环的过程中不断推算出后续的元素呢？这样就不必创建完整的list，从而节省大量的空间，在Python中，这种一边循环一边计算的机制，称为生成器：generator
生成器是一个特殊的程序，可以被用作控制循环的迭代行为，Python中生成器是迭代器的一种，使用yield返回值函数，每次调用yield会暂停，而可以使用next()函数和send()函数恢复生成器。
生成器类似于返回值为数组的一个函数，这个函数可以接受参数，可以被调用，但是，不同于一般的函数会一次性返回包括了所有数值的数组，生成器一次只能产生一个值，这样消耗的内存数量将大大减小，而且允许调用函数可以很快的处理前几个返回值，因此生成器看起来像是一个函数，但是表现得却像是迭代器。
1.2. 创建生成器
要创建一个generator，有很多种方法。
方法1：用生成器表达式，[]改为()
第1种方法很简单，只要把一个列表生成式的[]改成()，就创建了一个generator：
In [1]: L = [x*x for x in range(5)] In [2]: L Out[2]: [0, 1, 4, 9, 16] In [3]: g = (x*x for x in range(5)) In [4]: g Out[4]: <generator object <genexpr> at 0x000000000466EA98> In [5]: type(g) Out[5]: generator
创建L和g的区别仅在于最外层的[]和()，L是一个list，而g是一个generator。
我们可以直接打印出list的每一个元素，但我们怎么打印出generator的每一个元素呢？
如果要一个一个打印出来，可以通过next()函数获得generator的下一个返回值：
In [6]: next(g) Out[6]: 0 In [7]: next(g) Out[7]: 1 In [8]: next(g) Out[8]: 4 In [9]: next(g) Out[9]: 9 In [10]: next(g) Out[10]: 16 In [11]: next(g) --------------------------------------------------------------------------- StopIteration Traceback (most recent call last) <ipython-input-11-e734f8aca5ac> in <module>() ----> 1 next(g) StopIteration:
我们讲过，generator保存的是算法，每次调用next(g)，就计算出g的下一个元素的值，直到计算到最后一个元素，没有更多的元素时，抛出StopIteration的错误。
当然，上面这种不断调用next(g)不方便，正确的方法是使用for循环，因为generator也是可迭代对象：
In [13]: g = (x*x for x in range(5)) In [14]: for n in g: ...: print(n) ...: 0 1 4 9 16
所以，我们创建了一个generator后，基本上永远不会调用next()，而是通过for循环来迭代它，并且不需要关心StopIteration的错误。
方法2：用生成器函数，使用关键字 yield
generator非常强大。如果推算的算法比较复杂，用类似列表生成式的for循环无法实现的时候，还可以用函数来实现。
比如，著名的斐波拉契数列（Fibonacci），除第一个和第二个数外，任意一个数都可由前两个数相加得到：
1, 1, 2, 3, 5, 8, 13, 21, 34, …
斐波拉契数列用列表生成式写不出来，但是，用函数把它打印出来却很容易：
def fib_print(max): n, a, b = 0, 0, 1 while n < max: print(b, end=' ') a, b = b, a + b n = n + 1 print('n') return 'done'
In [18]: fib_print(8) 1 1 2 3 5 8 13 21 Out[18]: 'done'
仔细观察，可以看出，fib_print()函数实际上是定义了斐波拉契数列的推算规则，可以从第一个元素开始，推算出后续任意的元素，这种逻辑其实非常类似generator。
也就是说，上面的函数和generator仅一步之遥。要把fib_print()函数变成generator，只需要把print(b, end=' ')改为yield b就可以了：
def fib_g(max): n, a, b = 0, 0, 1 while n < max: yield b a, b = b, a + b n = n + 1 return 'done'
这就是定义generator的另一种方法。如果一个函数定义中包含yield关键字，那么这个函数就不再是一个普通函数，而是一个generator：
In [20]: fg = fib_g(8) In [21]: fg Out[21]: <generator object fib_g at 0x000000000466E830>
这里，最难理解的就是generator和函数的执行流程不一样。函数是顺序执行，遇到return语句或者最后一行函数语句就返回。而变成generator的函数，在每次调用next()的时候执行，遇到yield语句返回，再次执行时从上次返回的yield语句处继续执行。
举个简单的例子，定义一个generator，依次返回数字1，3，5：
def odd(): print('==== step 1 ====') yield 1 print('==== step 2 ====') yield(3) print('==== step 3 ====') yield(5)
调用该generator时，首先要生成一个generator对象，然后用next()函数不断获得下一个返回值：
In [23]: og = odd() In [24]: next(og) ==== step 1 ==== Out[24]: 1 In [25]: next(og) ==== step 2 ==== Out[25]: 3 In [26]: next(og) ==== step 3 ==== Out[26]: 5 In [27]: next(og) --------------------------------------------------------------------------- StopIteration Traceback (most recent call last) <ipython-input-27-7e59cec5e8f1> in <module>() ----> 1 next(og) StopIteration:
可以看到，odd不是普通函数，而是generator，在执行过程中，遇到yield就中断，下次又继续执行。执行3次yield后，已经没有yield可以执行了，所以，第4次调用next(o)就报错。
回到fib_g()的例子，我们在循环过程中不断调用yield，就会不断中断。当然要给循环设置一个条件来退出循环，不然就会产生一个无限数列出来。
同样的，把函数改成generator后，我们基本上从来不会用next()来获取下一个返回值，而是直接使用for循环来迭代：
In [28]: for n in fib_g(8): ...: ... print(n, end=' ') ...: 1 1 2 3 5 8 13 21
但是用for循环调用generator时，发现拿不到generator的return语句的返回值。如果想要拿到返回值，必须捕获StopIteration错误，返回值包含在StopIteration的value中：
In [30]: g = fib_g(6) In [31]: while True: ...: try: ...: x = next(g) ...: print('g:', x) ...: except StopIteration as e: ...: print('Generator return value:', e.value) ...: break ...: g: 1 g: 1 g: 2 g: 3 g: 5 g: 8 Generator return value: done
1.3. 例子
写一个杨辉三角
1 / 1 1 / / 1 2 1 / / / 1 3 3 1 / / / / 1 4 6 4 1 / / / / / 1 5 10 10 5 1
把每一行看做一个list，试写一个generator，不断输出下一行的list：
def triangles(): l = [1] while True: yield(l) l = [1] + [l[x] + l[x+1] for x in range(len(l)-1)] + [1]
测试：
In [33]: tg = triangles() In [34]: tg Out[34]: <generator object triangles at 0x000000000466EE60> In [35]: next(tg) Out[35]: [1] In [36]: next(tg) Out[36]: [1, 1] In [37]: next(tg) Out[37]: [1, 2, 1] In [38]: next(tg) Out[38]: [1, 3, 3, 1] In [39]: next(tg) Out[39]: [1, 4, 6, 4, 1] In [40]: next(tg) Out[40]: [1, 5, 10, 10, 5, 1]
2. 迭代器 Iterator
2.1. 可迭代 Iterable
可以直接作用于for循环的数据类型有以下几种：
- 一类是集合数据类型，如
list、tuple、dict、set、str等； - 一类是
generator，包括生成器和带yield的generator function。
这些可以直接作用于for循环的对象统称为可迭代对象：Iterable。
注意：
Iterable是可迭代，不一定是迭代器。
可以使用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('123abc', Iterable) Out[4]: True In [5]: isinstance( (x for x in range(4)), Iterable) Out[5]: True In [6]: isinstance( 123, Iterable) Out[6]: False
2.2. 迭代器 Iterator
而生成器不但可以作用于for循环，还可以被next()函数不断调用并返回下一个值，直到最后抛出StopIteration错误表示无法继续返回下一个值了。
可以被next()函数调用并不断返回下一个值的对象称为迭代器：Iterator。
可以使用isinstance()判断一个对象是否是Iterator对象：
In [9]: from collections import Iterator In [10]: g = (x for x in range(4)) # generator In [11]: isinstance(g, Iterator) Out[11]: True In [12]: isinstance([], Iterator) Out[12]: False In [13]: isinstance({}, Iterator) Out[13]: False In [14]: isinstance('123abc', Iterator) Out[14]: False In [15]: isinstance(123, Iterator) Out[15]: False
简言之：
生成器都是Iterator对象，但list、dict、str虽然是Iterable，却不是Iterator。
把list、dict、str等Iterable变成Iterator可以使用iter()函数：
In [19]: isinstance(iter([]), Iterator) Out[19]: True In [21]: isinstance(iter({}), Iterator) Out[21]: True In [22]: isinstance(iter('123abc'), Iterator) Out[22]: True
问题
为什么list、dict、str等数据类型不是Iterator？
这是因为
Python的Iterator对象表示的是一个数据流，Iterator对象可以被next()函数调用并不断返回下一个数据，直到没有数据时抛出StopIteration错误。可以把这个数据流看做是一个有序序列，但我们却不能提前知道序列的长度，只能不断通过next()函数实现按需计算下一个数据，所以Iterator的计算是惰性的，只有在需要返回下一个数据时它才会计算。
Iterator甚至可以表示一个无限大的数据流，例如全体自然数。 而使用list是永远不可能存储全体自然数的。
用途决定一切，个人觉得一般情况下非惰性数据类型还是灵活一些。
2.3. 可迭代与迭代器
可迭代： 在Python中如果一个对象有__iter__( )方法或__getitem__( )方法，则称这个对象是可迭代的（Iterable）；其中__iter__( )方法的作用是让对象可以用for ... in循环遍历，__getitem__( )方法是让对象可以通过“实例名[index]”的方式访问实例中的元素。换句话说，两个条件只要满足一条，就可以说对象是可迭代的。显然列表List、元组Tuple、字典Dictionary、字符串String等数据类型都是可迭代的。当然因为Python的**“鸭子类型”**，我们自定义的类中只要实现了__iter__( )方法或__getitem__( )方法，也是可迭代的。
迭代器： 在Python中如果一个对象有__iter__( )方法和__next__( )方法，则称这个对象是迭代器（Iterator）；其中__iter__( )方法是让对象可以用for ... in循环遍历，__next__( )方法是让对象可以通过next(实例名)访问下一个元素。
注意：这两个方法必须同时具备，才能称之为迭代器。列表List、元组Tuple、字典Dictionary、字符串String等数据类型虽然是可迭代的，但都不是迭代器，因为他们都没有next( )方法。
2.4. 小结
- 凡是可作用于
for循环的对象都是Iterable类型； - 凡是可作用于
next()函数的对象都是Iterator类型，它们表示一个惰性计算的序列； - 生成器
generator一定是迭代器Iterator； - 集合数据类型如
list、dict、str等是Iterable但不是Iterator，不过可以通过iter()函数获得一个Iterator对象。
Python的for循环本质上就是通过不断调用next()函数实现的，例如：
for x in [1, 2, 3, 4, 5]: pass
实际上完全等价于：
# 首先获得Iterator对象: it = iter([1, 2, 3, 4, 5]) # 循环: while True: try: # 获得下一个值: x = next(it) except StopIteration: # 遇到StopIteration就退出循环 break
参考文献
廖雪峰的Python教程：
- https://www.liaoxuefeng.com/wiki/1016959663602400/1017318207388128
- https://www.liaoxuefeng.com/wiki/1016959663602400/1017323698112640
其它教程：
OK！ 以上，Enjoy~
