初步解析Python中的yield函数的用法


Posted in Python onApril 03, 2015

您可能听说过,带有 yield 的函数在 Python 中被称之为 generator(生成器),何谓 generator ?

我们先抛开 generator,以一个常见的编程题目来展示 yield 的概念。

如何生成斐波那契?盗?/strong>

斐波那契(Fibonacci)?盗惺且桓龇浅<虻サ牡莨槭?校??谝桓龊偷诙?鍪?猓?我庖桓鍪?伎捎汕傲礁鍪?嗉拥玫健S眉扑慊?绦蚴涑鲮巢?瞧?盗械那 N 个数是一个非常简单的问题,许多初学者都可以轻易写出如下函数:

清单 1. 简单输出斐波那契?盗星 N 个数
 

def fab(max):
 n, a, b = 0, 0, 1
 while n < max:
  print b
  a, b = b, a + b
  n = n + 1

执行 fab(5),我们可以得到如下输出:
 

>>> fab(5)
1
1
2
3
5

结果没有问题,但有经验的开发者会指出,直接在 fab 函数中用 print 打印数字会导致该函数可复用性较差,因为 fab 函数返回 None,其他函数无法获得该函数生成的数列。

要提高 fab 函数的可复用性,最好不要直接打印出数列,而是返回一个 List。以下是 fab 函数改写后的第二个版本:

清单 2. 输出斐波那契?盗星 N 个数第二版
 

def fab(max):
 n, a, b = 0, 0, 1
 L = []
 while n < max:
  L.append(b)
  a, b = b, a + b
  n = n + 1
 return L

可以使用如下方式打印出 fab 函数返回的 List:
 

>>> for n in fab(5):
...  print n
...
1
1
2
3
5

改写后的 fab 函数通过返回 List 能满足复用性的要求,但是更有经验的开发者会指出,该函数在运行中占用的内存会随着参数 max 的增大而增大,如果要控制内存占用,最好不要用 List

来保存中间结果,而是通过 iterable 对象来迭代。例如,在 Python2.x 中,代码:

清单 3. 通过 iterable 对象来迭代
 

for i in range(1000): pass

会导致生成一个 1000 个元素的 List,而代码:
 

for i in xrange(1000): pass

则不会生成一个 1000 个元素的 List,而是在每次迭代中返回下一个数值,内存空间占用很小。因为 xrange 不返回 List,而是返回一个 iterable 对象。

利用 iterable 我们可以把 fab 函数改写为一个支持 iterable 的 class,以下是第三个版本的 Fab:
清单 4. 第三个版本

class Fab(object):
 
 def __init__(self, max):
  self.max = max
  self.n, self.a, self.b = 0, 0, 1
 
 def __iter__(self):
  return self
 
 def next(self):
  if self.n < self.max:
   r = self.b
   self.a, self.b = self.b, self.a + self.b
   self.n = self.n + 1
   return r
  raise StopIteration()

Fab 类通过 next() 不断返回数列的下一个数,内存占用始终为常数:
 

>>> for n in Fab(5):
...  print n
...

然而,使用 class 改写的这个版本,代码远远没有第一版的 fab 函数来得简洁。如果我们想要保持第一版 fab 函数的简洁性,同时又要获得 iterable 的效果,yield 就派上用场了:
清单 5. 使用 yield 的第四版
 

def fab(max):
 n, a, b = 0, 0, 1
 while n < max:
  yield b
  # print b
  a, b = b, a + b
  n = n + 1
 
'''

第四个版本的 fab 和第一版相比,仅仅把 print b 改为了 yield b,就在保持简洁性的同时获得了 iterable 的效果。

调用第四版的 fab 和第二版的 fab 完全一致:
 

>>> for n in fab(5):
...  print n
...

简单地讲,yield 的作用就是把一个函数变成一个 generator,带有 yield 的函数不再是一个普通函数,Python 解释器会将其视为一个 generator,调用 fab(5) 不会执行 fab 函数,而是返回一个 iterable 对象!在 for 循环执行时,每次循环都会执行 fab 函数内部的代码,执行到 yield b 时,fab 函数就返回一个迭代值,下次迭代时,代码从 yield b 的下一条语句继续执行,而函数的本地变量看起来和上次中断执行前是完全一样的,于是函数继续执行,直到再次遇到 yield。

也可以手动调用 fab(5) 的 next() 方法(因为 fab(5) 是一个 generator 对象,该对象具有 next() 方法),这样我们就可以更清楚地看到 fab 的执行流程:

清单 6. 执行流程
 

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

当函数执行结束时,generator 自动抛出 StopIteration 异常,表示迭代完成。在 for 循环里,无需处理 StopIteration 异常,循环会正常结束。

我们可以得出以下结论:

一个带有 yield 的函数就是一个 generator,它和普通函数不同,生成一个 generator 看起来像函数调用,但不会执行任何函数代码,直到对其调用 next()(在 for 循环中会自动调用 next())才开始执行。虽然执行流程仍按函数的流程执行,但每执行到一个 yield 语句就会中断,并返回一个迭代值,下次执行时从 yield 的下一个语句继续执行。看起来就好像一个函数在正常执行的过程中被 yield 中断了数次,每次中断都会通过 yield 返回当前的迭代值。

yield 的好处是显而易见的,把一个函数改写为一个 generator 就获得了迭代能力,比起用类的实例保存状态来计算下一个 next() 的值,不仅代码简洁,而且执行流程异常清晰。

如何判断一个函数是否是一个特殊的 generator 函数?可以利用 isgeneratorfunction 判断:

清单 7. 使用 isgeneratorfunction 判断
 

>>> from inspect import isgeneratorfunction
>>> isgeneratorfunction(fab)
True

要注意区分 fab 和 fab(5),fab 是一个 generator function,而 fab(5) 是调用 fab 返回的一个 generator,好比类的定义和类的实例的区别:

清单 8. 类的定义和类的实例
 

>>> import types
>>> isinstance(fab, types.GeneratorType)
False
>>> isinstance(fab(5), types.GeneratorType)
True

fab 是无法迭代的,而 fab(5) 是可迭代的:
 

>>> from collections import Iterable
>>> isinstance(fab, Iterable)
False
>>> isinstance(fab(5), Iterable)
True

每次调用 fab 函数都会生成一个新的 generator 实例,各实例互不影响:

>>> f1 = fab(3)
>>> f2 = fab(5)
>>> print 'f1:', f1.next()
f1: 1
>>> print 'f2:', f2.next()
f2: 1
>>> print 'f1:', f1.next()
f1: 1
>>> print 'f2:', f2.next()
f2: 1
>>> print 'f1:', f1.next()
f1: 2
>>> print 'f2:', f2.next()
f2: 2
>>> print 'f2:', f2.next()
f2: 3
>>> print 'f2:', f2.next()
f2: 5

return 的作用

在一个 generator function 中,如果没有 return,则默认执行至函数完毕,如果在执行过程中 return,则直接抛出 StopIteration 终止迭代。

另一个例子

另一个 yield 的例子来源于文件读取。如果直接对文件对象调用 read() 方法,会导致不可预测的内存占用。好的方法是利用固定长度的缓冲区来不断读取文件内容。通过 yield,我们不再需要编写读文件的迭代类,就可以轻松实现文件读取:

清单 9. 另一个 yield 的例子
 

def read_file(fpath):
 BLOCK_SIZE = 1024
 with open(fpath, 'rb') as f:
  while True:
   block = f.read(BLOCK_SIZE)
   if block:
    yield block
   else:
    return

以上仅仅简单介绍了 yield 的基本概念和用法,yield 在 Python 3 中还有更强大的用法,我们会在后续文章中讨论。

注:本文的代码均在 Python 2.7 中调试通过

Python 相关文章推荐
Python程序员鲜为人知但你应该知道的17个问题
Jun 04 Python
python定时执行指定函数的方法
May 27 Python
python矩阵的转置和逆转实例
Dec 12 Python
Python设计模式之外观模式实例详解
Jan 17 Python
pyqt5实现绘制ui,列表窗口,滚动窗口显示图片的方法
Jun 20 Python
django表单的Widgets使用详解
Jul 22 Python
python实现kNN算法识别手写体数字的示例代码
Aug 16 Python
python3 map函数和filter函数详解
Aug 26 Python
Python读写操作csv和excle文件代码实例
Mar 16 Python
python xlwt模块的使用解析
Apr 13 Python
浅谈Python中的正则表达式
Jun 28 Python
一些让Python代码简洁的实用技巧总结
Aug 23 Python
几个提升Python运行效率的方法之间的对比
Apr 03 #Python
对于Python的Django框架使用的一些实用建议
Apr 03 #Python
《Python之禅》中对于Python编程过程中的一些建议
Apr 03 #Python
给Python初学者的一些编程技巧
Apr 03 #Python
Python新手在作用域方面经常容易碰到的问题
Apr 03 #Python
Python中设置变量作为默认值时容易遇到的错误
Apr 03 #Python
用Python编写一个简单的Lisp解释器的教程
Apr 03 #Python
You might like
Base64在线编码解码实现代码 演示与下载
2011/01/08 PHP
php读取文件内容的几种方法详解
2013/06/26 PHP
PHP正则表达式过滤html标签属性(DEMO)
2016/05/04 PHP
php 输入输出流详解及示例代码
2016/08/25 PHP
ThinkPHP框架中使用Memcached缓存数据的方法
2018/03/31 PHP
jQuery EasyUI API 中文文档 - ProgressBar 进度条
2011/09/29 Javascript
鼠标滚轮改变图片大小的示例代码
2013/11/20 Javascript
jQuery中removeAttr()方法用法实例
2015/01/05 Javascript
JS+CSS实现Div弹出窗口同时背景变暗的方法
2015/03/04 Javascript
JS数组合并push与concat区别分析
2015/12/17 Javascript
实例讲解JavaScript的Backbone.js框架中的View视图
2016/05/05 Javascript
JS 实现导航菜单中的二级下拉菜单的几种方式
2016/10/31 Javascript
利用Vue.js实现checkbox的全选反选效果
2017/01/18 Javascript
基于JavaScript实现瀑布流效果
2017/03/29 Javascript
Angular4实现鼠标悬停3d倾斜效果
2017/10/25 Javascript
NodeJs入门教程之定时器和队列
2019/03/08 NodeJs
vue+elementUI 复杂表单的验证、数据提交方案问题
2019/06/24 Javascript
微信小程序 生成携带参数的二维码
2019/10/23 Javascript
原生js实现贪食蛇小游戏的思路详解
2019/11/26 Javascript
nuxt.js添加环境变量,区分项目打包环境操作
2020/11/06 Javascript
微信小程序实现倒计时功能
2020/11/19 Javascript
Vue 简单实现前端权限控制的示例
2020/12/25 Vue.js
vue3+typeScript穿梭框的实现示例
2020/12/29 Vue.js
Python List列表对象内置方法实例详解
2019/10/22 Python
python实现提取COCO,VOC数据集中特定的类
2020/03/10 Python
Pandas对DataFrame单列/多列进行运算(map, apply, transform, agg)
2020/06/14 Python
详解python metaclass(元类)
2020/08/13 Python
Wiggle中国:英国骑行、跑步、游泳 & 铁三运动装备专卖网店
2016/08/02 全球购物
GAP欧盟网上商店:GAP EU
2016/09/13 全球购物
美国男女折扣服饰百货连锁店:Stein Mart
2017/05/02 全球购物
新西兰领先的内衣店:Bendon Lingerie新西兰
2018/07/11 全球购物
BIFFI美国站:意大利BIFFI BOUTIQUES豪华多品牌时装零售公司
2020/02/11 全球购物
链表面试题-一个链表的结点结构
2015/05/04 面试题
奶茶店创业计划书范文
2014/01/17 职场文书
给护士表扬信
2014/01/19 职场文书
法人单位授权委托书范文
2014/10/06 职场文书