初步解析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 相关文章推荐
bat和python批量重命名文件的实现代码
May 19 Python
Python实现统计文本文件字数的方法
May 05 Python
Python Selenium Cookie 绕过验证码实现登录示例代码
Apr 10 Python
Python排序算法之选择排序定义与用法示例
Apr 29 Python
利用pyinstaller将py文件打包为exe的方法
May 14 Python
python利用微信公众号实现报警功能
Jun 10 Python
python3解析库pyquery的深入讲解
Jun 26 Python
Python神奇的内置函数locals的实例讲解
Feb 22 Python
Python字符串的常见操作实例小结
Apr 08 Python
Python zip函数打包元素实例解析
Dec 11 Python
解决jupyter notebook显示不全出现框框或者乱码问题
Apr 09 Python
解决Pytorch dataloader时报错每个tensor维度不一样的问题
May 28 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
php中ltrim()、rtrim()与trim()删除字符空格实例
2014/11/25 PHP
网站防止被刷票的一些思路与方法
2015/01/08 PHP
学习php设计模式 php实现工厂模式(factory)
2015/12/07 PHP
PHP中抽象类、接口的区别与选择分析
2016/03/29 PHP
Yii+MYSQL锁表防止并发情况下重复数据的方法
2016/07/14 PHP
PHP制作登录异常ip检测功能的实例代码
2016/11/16 PHP
Yii 2.0在Grid中格式化时间方法示例
2017/06/06 PHP
基于PHP-FPM进程池探秘
2017/10/17 PHP
利用PHP扩展Xhprof分析项目性能实践教程
2018/09/05 PHP
PHP7 其他语言层面的修改
2021/03/09 PHP
JqueryMobile动态生成listView并实现刷新的两种方法
2014/03/05 Javascript
PHP中CURL的几个经典应用实例
2015/01/23 Javascript
限制上传文件大小和格式的jQuery插件实例
2015/01/24 Javascript
JavaScript编程中的Promise使用大全
2015/07/28 Javascript
基于jquery实现左右按钮点击的图片切换效果
2021/01/27 Javascript
JQuery中Ajax()的data参数类型实例分析
2015/12/15 Javascript
jQuery文字横向滚动效果的实现代码
2016/05/31 Javascript
关于在Servelet中如何获取当前时间的操作方法
2016/06/28 Javascript
JS基于面向对象实现的拖拽功能示例
2016/12/20 Javascript
微信小程序 连续旋转动画(this.animation.rotate)详解
2017/04/07 Javascript
React Native使用百度Echarts显示图表的示例代码
2017/11/07 Javascript
vue-router路由与页面间导航实例解析
2017/11/07 Javascript
JavaScript实现横版菜单栏
2020/03/17 Javascript
详细分析vue响应式原理
2020/06/22 Javascript
[40:48]DOTA2上海特级锦标赛D组败者赛 Liquid VS COL第二局
2016/02/28 DOTA
[37:03]完美世界DOTA2联赛PWL S3 INK ICE vs GXR 第二场 12.16
2020/12/18 DOTA
Python中的defaultdict模块和namedtuple模块的简单入门指南
2015/04/01 Python
Python subprocess库的使用详解
2018/10/26 Python
使用python的turtle绘画滑稽脸实例
2019/11/21 Python
Python time库基本使用方法分析
2019/12/13 Python
HTML5 Canvas图像模糊完美解决办法
2018/02/06 HTML / CSS
英国翻新电子产品购物网站:Tech Trade
2017/12/25 全球购物
人力资源部培训专员岗位职责
2014/01/02 职场文书
财务总监管理岗位职责
2014/03/08 职场文书
农村党员一句话承诺
2014/05/30 职场文书
创业分两种人:那么哪些适合创业?,哪些适合不适合创业呢?
2019/08/23 职场文书