深入理解python中的yield

英文单词 yield 的意思是生产。刚接触Python的时候，我很迷茫，一直搞不懂yield的用法。

只是一个粗略的想法，yield 可以用来填充函数返回值的数据，例如下面的例子：

def addlist(alist):
    for i in alist:
        yield i + 1

取出alist的每一项，然后插入i+1。然后通过调用获取每个项目：

alist = [1, 2, 3, 4]
for x in addlist(alist):
    print x

这的确是yield应用的一个例子

1. 包含yield的函数

如果你看到一个包含yield的函数，说明这个函数已经是一个Generator，它的执行会和其他普通函数有很大的不同。例如下面这个简单的函数：

def h():
    print 'To be brave'
    yield 5
h()

可以看到，调用h()后，打印语句并没有执行！这就是yield，那么如何让print语句执行呢？这是后面要讨论的问题。通过后面的讨论和学习，你会明白yield的工作原理。

2. yield是一个表达式

Python2.5以前，yield是一个语句，但现在2.5中，yield是一个表达式(Expression)，比如：

m = yield 5

表达式(yield 5)的返回值会赋值给m，所以认为m = 5是错误的。那么如何获取(yield 5)的返回值呢？需要用到后面介绍的send(msg)方法。

3. 透过next()语句看原理

现在，让我们揭示 yield 是如何工作的。我们知道我们上面的h()被调用后并没有执行，因为它有yield表达式，所以我们通过next()语句让它执行。 next() 语句将恢复 Generator 执行，直到下一个 yield 表达式。例如：

def h():
    print 'Wen Chuan'
    yield 5
    print 'Fighting!'
c = h()
c.next()

c.next()调用后，h()开始执行，直到遇到yield 5，因此输出结果：

Wen Chuan

当我们再次调用 c.next() 时，执行将继续，直到找到下一个 yield 表达式。由于后面没有yield，所以会抛出异常：

Wen Chuan
Fighting!
Traceback (most recent call last):
  File "/home/evergreen/Codes/yidld.py", line 11, in <module>
    c.next()
StopIteration

4. send(msg) 与 next()

了解了next()是如何执行包含yield的函数之后，我们来看另一个非常重要的函数send(msg)。事实上，next() 和 send() 在某种意义上是相似的。区别在于send()可以将yield表达式的值传入其中，而next()不能传入具体的值，只能传None。因此，我们可以将其视为

c.next() 和 c.send(None) 作用是一样的。

来看这个例子：

def h():
    print 'Wen Chuan',
    m = yield 5  # Fighting!
    print m
    d = yield 12
    print 'We are together!'
c = h()
c.next()  #相当于c.send(None)
c.send('Fighting!')  #(yield 5)表达式被赋予了'Fighting!'

输出的结果为：

Wen Chuan Fighting!

需要提醒的是，第一次调用时，请使用next()语句或send(None)。不能使用 send 发送 None 以外的值，否则会因为没有 yield 语句接收这个值而出错。

5. send(msg) 与 next()的返回值

send(msg)和next()都有返回值，而且它们的返回值很特别，返回下一个yield表达式的参数。比如 yield 5 返回 5，来来来，是不是明白了什么？在本文第一个例子中，通过for i in alist遍历Generator，其实每次都会调用alist.Next()，每次alist.Next()的返回值都是yield的参数，也就是我们开始认为它是 Pressed into the stuff。我们继续上面的例子：

def h():
    print 'Wen Chuan',
    m = yield 5  # Fighting!
    print m
    d = yield 12
    print 'We are together!'
c = h()
m = c.next()  #m 获取了yield 5 的参数值 5
d = c.send('Fighting!')  #d 获取了yield 12 的参数值12
print 'We will never forget the date', m, '.', d

输出结果：

Wen Chuan Fighting!
We will never forget the date 5 . 12

6. throw() 与 close()中断 Generator

中断 Generator 是一种非常灵活的技术，可以通过抛出 GeneratorExit 异常来终止 Generator。 Close() 方法具有相同的效果，实际上，它在内部调用了 throw(GeneratorExit)。让我们来看看：

def close(self):
    try:
        self.throw(GeneratorExit)
    except (GeneratorExit, StopIteration):
        pass
    else:
        raise RuntimeError("generator ignored GeneratorExit")
# Other exceptions are not caught

因此，当我们调用close()方法，再调用next()或send(msg)时，会抛出异常：

Traceback (most recent call last):
  File "/home/evergreen/Codes/yidld.py", line 14, in <module>
    d = c.send('Fighting!')  #d 获取了yield 12 的参数值12
StopIteration