初步解析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使用Scrapy爬取妹子图
May 28 Python
详解Python的Django框架中的模版继承
Jul 16 Python
Python测试人员需要掌握的知识
Feb 08 Python
pandas 使用apply同时处理两列数据的方法
Apr 20 Python
python 定义给定初值或长度的list方法
Jun 23 Python
对Python中list的倒序索引和切片实例讲解
Nov 15 Python
详解如何用TensorFlow训练和识别/分类自定义图片
Aug 05 Python
python实现获取单向链表倒数第k个结点的值示例
Oct 24 Python
Python注释、分支结构、循环结构、伪“选择结构”用法实例分析
Jan 09 Python
Python列表list操作相关知识小结
Jan 29 Python
Python基于进程池实现多进程过程解析
Apr 30 Python
Django 实现图片上传和下载功能
Dec 31 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读取txt文件组成SQL并插入数据库的代码(原创自Zjmainstay)
2012/07/31 PHP
PHP缓存技术的多种方法小结
2012/08/14 PHP
php使用json_decode后数字对象转换成了科学计数法的解决方法
2017/02/20 PHP
PHP实现的函数重载功能示例
2018/08/03 PHP
jquery实现的元素的left增加N像素 鼠标移开会慢慢的移动到原来的位置
2010/03/21 Javascript
基于jquery用于查询操作的实现代码
2010/05/10 Javascript
js的一些常用方法小结
2011/06/29 Javascript
node.js中的fs.realpath方法使用说明
2014/12/16 Javascript
js获取数组的最后一个元素
2015/04/14 Javascript
基于jQuery实现的仿百度首页滑动选项卡效果代码
2015/11/16 Javascript
理解js对象继承的N种模式
2016/01/25 Javascript
JS中动态创建元素的三种方法总结(推荐)
2016/10/20 Javascript
js实现上传图片预览方法
2016/10/25 Javascript
详解微信小程序开发之下拉刷新 上拉加载
2016/11/24 Javascript
AngularJS使用angular.bootstrap完成模块手动加载的方法分析
2017/01/19 Javascript
JS如何判断浏览器类型和详细区分IE各版本浏览器
2017/03/04 Javascript
webpack 4.0.0-beta.0版本新特性介绍
2018/02/10 Javascript
Nodejs调用Dll模块的方法
2018/09/17 NodeJs
详解JavaScript中的强制类型转换
2019/04/15 Javascript
vue elementUI 表单校验功能之数组多层嵌套
2019/06/04 Javascript
javaScript把其它类型转换为Number类型
2019/10/13 Javascript
[03:02]辉夜杯主赛事第二日 每日之星
2015/12/27 DOTA
[52:08]DOTA2上海特级锦标赛主赛事日 - 3 败者组第三轮#2Fnatic VS OG第一局
2016/03/05 DOTA
Python解析json文件相关知识学习
2016/03/01 Python
用django-allauth实现第三方登录的示例代码
2019/06/24 Python
Python循环结构的应用场景详解
2019/07/11 Python
详解Django模版中加载静态文件配置方法
2019/07/21 Python
Python垃圾回收机制三种实现方法
2020/04/27 Python
如何开发一个JQuery插件
2016/07/28 面试题
环境科学毕业生自荐信
2013/11/21 职场文书
毕业生的自我评价
2013/12/30 职场文书
国际贸易专业个人求职信格式
2014/02/02 职场文书
学习雷锋标语
2014/06/25 职场文书
缅怀先烈主题班会
2015/08/14 职场文书
祝福语集锦:给百岁老人祝寿贺词
2019/11/19 职场文书
Html5生成验证码的示例代码
2021/05/10 Javascript