深入理解yield

心已赠人 2022-05-18 05:00 150阅读 0赞

yield的英文单词意思是生产，刚接触Python的时候感到非常困惑，一直没弄明白yield的用法。

只是粗略的知道yield可以用来为一个函数返回值塞数据，比如下面的例子：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>def</code>&nbsp;<code>addlist(alist):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>i&nbsp;</code><code>in</code>&nbsp;<code>alist:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>yield</code>&nbsp;<code>i&nbsp;</code><code>+</code>&nbsp;<code>1</code> </td> 
 </tr> 
 </tbody> 
</table>

取出alist的每一项，然后把i + 1塞进去。然后通过调用取出每一项：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>alist&nbsp;</code><code>=</code>&nbsp;<code>[</code><code>1</code><code>,&nbsp;</code><code>2</code><code>,&nbsp;</code><code>3</code><code>,&nbsp;</code><code>4</code><code>]</code> <code>for</code>&nbsp;<code>x&nbsp;</code><code>in</code>&nbsp;<code>addlist(alist):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>x,</code> </td> 
 </tr> 
 </tbody> 
</table>

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

1. 包含yield的函数

假如你看到某个函数包含了yield，这意味着这个函数已经是一个Generator，它的执行会和其他普通的函数有很多不同。比如下面的简单的函数：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>def</code>&nbsp;<code>h():</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>'To&nbsp;be&nbsp;brave'</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>yield</code>&nbsp;<code>5</code> <code>h()</code> </td> 
 </tr> 
 </tbody> 
</table>

可以看到，调用h()之后，print 语句并没有执行！这就是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表达式处。比如：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>def</code>&nbsp;<code>h():</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>'Wen&nbsp;Chuan'</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>yield</code>&nbsp;<code>5</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>'Fighting!'</code> <code>c&nbsp;</code><code>=</code>&nbsp;<code>h()</code> <code>c.</code><code>next</code><code>()</code> </td> 
 </tr> 
 </tbody> 
</table>

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

Wen Chuan

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>Wen&nbsp;Chuan</code> <code>Fighting!</code> <code>Traceback&nbsp;(most&nbsp;recent&nbsp;call&nbsp;last):</code> <code>&nbsp;&nbsp;</code><code>File</code>&nbsp;<code>"/home/evergreen/Codes/yidld.py"</code><code>,&nbsp;line&nbsp;</code><code>11</code><code>,&nbsp;</code><code>in</code>&nbsp;<code>&lt;module&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>c.</code><code>next</code><code>()</code> <code>StopIteration</code> </td> 
 </tr> 
 </tbody> 
</table>

4. send(msg) 与 next()

了解了next()如何让包含yield的函数执行后，我们再来看另外一个非常重要的函数send(msg)。其实next()和send()在一定意义上作用是相似的，区别是send()可以传递yield表达式的值进去，而next()不能传递特定的值，只能传递None进去。因此，我们可以看做

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

来看这个例子：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>def</code>&nbsp;<code>h():</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>'Wen&nbsp;Chuan'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>m&nbsp;</code><code>=</code>&nbsp;<code>yield</code>&nbsp;<code>5</code>&nbsp;&nbsp;<code>#&nbsp;Fighting!</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>m</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>d&nbsp;</code><code>=</code>&nbsp;<code>yield</code>&nbsp;<code>12</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>'We&nbsp;are&nbsp;together!'</code> <code>c&nbsp;</code><code>=</code>&nbsp;<code>h()</code> <code>c.</code><code>next</code><code>()&nbsp;&nbsp;</code><code>#相当于c.send(None)</code> <code>c.send(</code><code>'Fighting!'</code><code>)&nbsp;&nbsp;</code><code>#(yield&nbsp;5)表达式被赋予了'Fighting!'</code> </td> 
 </tr> 
 </tbody> 
</table>

输出的结果为：

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的参数，即我们开始认为被压进去的东东。我们再延续上面的例子：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>def</code>&nbsp;<code>h():</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>'Wen&nbsp;Chuan'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>m&nbsp;</code><code>=</code>&nbsp;<code>yield</code>&nbsp;<code>5</code>&nbsp;&nbsp;<code>#&nbsp;Fighting!</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>m</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>d&nbsp;</code><code>=</code>&nbsp;<code>yield</code>&nbsp;<code>12</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>'We&nbsp;are&nbsp;together!'</code> <code>c&nbsp;</code><code>=</code>&nbsp;<code>h()</code> <code>m&nbsp;</code><code>=</code>&nbsp;<code>c.</code><code>next</code><code>()&nbsp;&nbsp;</code><code>#m&nbsp;获取了yield&nbsp;5&nbsp;的参数值&nbsp;5</code> <code>d&nbsp;</code><code>=</code>&nbsp;<code>c.send(</code><code>'Fighting!'</code><code>)&nbsp;&nbsp;</code><code>#d&nbsp;获取了yield&nbsp;12&nbsp;的参数值12</code> <code>print</code>&nbsp;<code>'We&nbsp;will&nbsp;never&nbsp;forget&nbsp;the&nbsp;date'</code><code>,&nbsp;m,&nbsp;</code><code>'.'</code><code>,&nbsp;d</code> </td> 
 </tr> 
 </tbody> 
</table>

输出结果：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>Wen&nbsp;Chuan&nbsp;Fighting!</code> <code>We&nbsp;will&nbsp;never&nbsp;forget&nbsp;the&nbsp;</code><code>date</code>&nbsp;<code>5&nbsp;.&nbsp;12</code> </td> 
 </tr> 
 </tbody> 
</table>

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

中断Generator是一个非常灵活的技巧，可以通过throw抛出一个GeneratorExit异常来终止Generator。Close()方法作用是一样的，其实内部它是调用了throw(GeneratorExit)的。我们看：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>def</code>&nbsp;<code>close(</code><code>self</code><code>):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>try</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>self</code><code>.throw(GeneratorExit)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>except</code>&nbsp;<code>(GeneratorExit,&nbsp;StopIteration):</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>pass</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>else</code><code>:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>raise</code>&nbsp;<code>RuntimeError(</code><code>"generator&nbsp;ignored&nbsp;GeneratorExit"</code><code>)</code> <code>#&nbsp;Other&nbsp;exceptions&nbsp;are&nbsp;not&nbsp;caught</code> </td> 
 </tr> 
 </tbody> 
</table>

因此，当我们调用了close()方法后，再调用next()或是send(msg)的话会抛出一个异常：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>Traceback&nbsp;(most&nbsp;recent&nbsp;call&nbsp;last):</code> <code>&nbsp;&nbsp;</code><code>File&nbsp;</code><code>"/home/evergreen/Codes/yidld.py"</code><code>,&nbsp;line&nbsp;14,&nbsp;</code><code>in</code>&nbsp;<code>&lt;module&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>d&nbsp;=&nbsp;c.send(</code><code>'Fighting!'</code><code>)&nbsp;&nbsp;</code><code>#d&nbsp;获取了yield&nbsp;12&nbsp;的参数值12</code> <code>StopIteration</code> </td> 
 </tr> 
 </tbody> 
</table>