python yield理解

迭代器简介

通过列表生成式，我们可以直接创建一个列表。但是，受到内存限制，列表容量肯定是有限的。而且，创建一个包含 100 万个元素的列表，不仅占用很大的存储空间，如果我们仅仅需要访问前面几个元素，那后面绝大多数元素占用的空间都白白浪费了。

所以，如果列表元素可以按照某种算法推算出来，那我们是否可以在循环的过程中不断推算出后续的元素呢？这样就不必创建完整的 list，从而节省大量的空间。在 Python 中，这种一边循环一边计算的机制，称为生成器：generator。

迭代器初级应用

要创建一个 generator，有很多种方法。第一种方法很简单，只要把一个列表生成式的[]改成()，就创建了一个 generator：

>>> L = [x * x for x in range(10)]
>>> L
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> g = (x * x for x in range(10))
>>> g
<generator object <genexpr> at 0x1022ef630>

创建L和g的区别仅在于最外层的[]和()，L是一个 list，而g是一个 generator。

我们可以直接打印出 list 的每一个元素，但我们怎么打印出 generator 的每一个元素呢？

如果要一个一个打印出来，可以通过next()函数获得 generator 的下一个返回值：

>>> next(g)
0
>>> next(g)
1
>>> next(g)
4
>>> next(g)
9
>>> next(g)
16
>>> next(g)
25
>>> next(g)
36
>>> next(g)
49
>>> next(g)
64
>>> next(g)
81
>>> next(g)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
StopIteration

我们讲过，generator 保存的是算法，每次调用next(g)，就计算出g的下一个元素的值，直到计算到最后一个元素，没有更多的元素时，抛出StopIteration的错误。

当然，上面这种不断调用next(g)实在是太变态了，正确的方法是使用for循环，因为 generator 也是可迭代对象：

>>> g = (x * x for x in range(10))
>>> for n in g:
... print(n)
...
0
1
4
9
16
25
36
49
64
81

所以，我们创建了一个 generator 后，基本上永远不会调用next()，而是通过for循环来迭代它，并且不需要关心StopIteration的错误。

generator 非常强大。如果推算的算法比较复杂，用类似列表生成式的for循环无法实现的时候，还可以用函数来实现。

比如，著名的斐波拉契数列（Fibonacci），除第一个和第二个数外，任意一个数都可由前两个数相加得到：

1, 1, 2, 3, 5, 8, 13, 21, 34, …

斐波拉契数列用列表生成式写不出来，但是，用函数把它打印出来却很容易：

def fib(max):
　　n, a, b = 0, 0, 1
　　while n < max:
　　　　print(b)
　　　　a, b = b, a + b
　　　　n = n + 1
　　return 'done'

上面的函数可以输出斐波那契数列的前 N 个数：

>>> fib(6)
1
1
2
3
5
8
'done'

仔细观察，可以看出，fib函数实际上是定义了斐波拉契数列的推算规则，可以从第一个元素开始，推算出后续任意的元素，这种逻辑其实非常类似 generator。

也就是说，上面的函数和 generator 仅一步之遥。要把fib函数变成 generator，只需要把print(b)改为yield b就可以了：

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        yield b
        a, b = b, a + b
        n = n + 1
    return 'done'                

yield 可以理解为 return，对于 yield 之后的表达式返回，次也会保留现场的变量信息，如果存在

m=yield b

实际上就是将 b 的值赋给 m，如果在程序代码中不存在相应的 send 操作。

这就是定义 generator 的另一种方法。如果一个函数定义中包含yield关键字，那么这个函数就不再是一个普通函数，而是一个 generator：

>>> f = fib(6)
>>> f
<generator object fib at 0x104feaaa0>

这里，最难理解的就是 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()函数不断获得下一个返回值：

>>> o = odd()
>>> next(o)
step 1
1
>>> next(o)
step 2
3
>>> next(o)
step 3
5
>>> next(o)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
StopIteration

可以看到，odd不是普通函数，而是 generator，在执行过程中，遇到yield就中断，下次又继续执行。执行 3 次yield后，已经没有yield可以执行了，所以，第 4 次调用next(o)就报错。

回到fib的例子，我们在循环过程中不断调用yield，就会不断中断。当然要给循环设置一个条件来退出循环，不然就会产生一个无限数列出来。

同样的，把函数改成 generator 后，我们基本上从来不会用next()来获取下一个返回值，而是直接使用for循环来迭代：

>>> for n in fib(6):
... print(n)
...
1
1
2
3
5
8

但是用for循环调用 generator 时，发现拿不到 generator 的return语句的返回值。如果想要拿到返回值，必须捕获StopIteration错误，返回值包含在StopIteration的value中：

>>> g = fib(6)
>>> 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

小结：从上面可以初步看到 yield 的用法，在一个函数中加入此函数变为迭代器函数，可以像一般的迭代器一样可以用来循环迭代。迭代器可以在一定程度上避免一些大数据处理带来的内存占用过大等问题，使用 yield 之后保证每次处理的都是一项内容，所以不会占用太多的资源。

迭代器协程应用

协程，又称微线程，纤程。英文名 Coroutine。协程的概念很早就提出来了，但直到最近几年才在某些语言（如 Lua）中得到广泛应用。子程序，或者称为函数，在所有语言中都是层级调用，比如 A 调用 B，B 在执行过程中又调用了 C，C 执行完毕返回，B 执行完毕返回，最后是 A 执行完毕。所以子程序调用是通过栈实现的，一个线程就是执行一个子程序。子程序调用总是一个入口，一次返回，调用顺序是明确的。而协程的调用和子程序不同。协程看上去也是子程序，但执行过程中，在子程序内部可中断，然后转而执行别的子程序，在适当的时候再返回来接着执行。注意，在一个子程序中中断，去执行其他子程序，不是函数调用，有点类似 CPU 的中断。

下面看一个常见的生产者-消费者模型：

def consumer():
r = ''
while True:
n = yield r
if not n:
return
print('[CONSUMER] Consuming %s...' % n)
r = '200 OK'
def produce(c):
c.send(None)
n = 0
while n < 5:
n = n + 1
print('[PRODUCER] Producing %s...' % n)
r = c.send(n)
print('[PRODUCER] Consumer return: %s' % r)
c.close()
c = consumer()
produce(c)

上面是一个常见的生产者-消费者模型，以前在使用 linux 下 c 实现的过程中需要考虑到多线程锁机制来保证正常运行，但是这种锁机制如果应用出现一点差错会导致死锁的现象，然后使用协程就可以完全避免这样的问题出现。

注意（1）： c.send(None)解析

#在 c=consumer()运行之后得到的只是一个迭代器初始化过程，此时 consumer 函数本身并没有运行
#也就是说下面这个函数#1 这句代码都没有运行
#def consumer():
# r = '' #1
# while True: #2
# n = yield r #3
# if not n: #4
# return #5
# print('[CONSUMER] Consuming %s...' % n) #6
# r = '200 OK' #7
#上面的代码中存在 c.send(None)，这个代码的作用就是
c.send(None)
#上述代码的等效于
c.next()
#此时开始获取迭代器中的值，此时会有疑问，为什么不可以发送其他值？首先迭代器没有运行，你就尝试给它发送消息，它
#也不知道怎么处理，因此就会报错，因此必须先发送 None

注意（2）：

for i in consumer():
print(i);
#注意到这个跟上面描述的情况就是不太一样了，此时并没有 send(None)还有 next()的代码
#但是你要知道 for 循环中会自动调用 next 函数的，所以就不用我们担心这个问题了

参考资料：https://www.deeplearn.me/231.html