Python yield 使用浅析


Posted in Python onMay 28, 2015

初学 Python 的开发者经常会发现很多 Python 函数中用到了 yield 关键字,然而,带有 yield 的函数执行流程却和普通函数不一样,yield 到底用来做什么,为什么要设计 yield ?本文将由浅入深地讲解 yield 的概念和用法,帮助读者体会 Python 里 yield 简单而强大的功能。

您可能听说过,带有 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 

 ... 

 1 

 1 

 2 

 3 

 5

然而,使用 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 

 ... 

 1 

 1 

 2 

 3 

 5

简单地讲,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 3实战爬虫之爬取京东图书的图片详解
Oct 09 Python
Python引用类型和值类型的区别与使用解析
Oct 17 Python
selenium+python截图不成功的解决方法
Jan 30 Python
在python中实现调用可执行文件.exe的3种方法
Jul 07 Python
浅谈python3中input输入的使用
Aug 02 Python
Pytorch 保存模型生成图片方式
Jan 10 Python
Python中 Global和Nonlocal的用法详解
Jan 20 Python
jupyter 实现notebook中显示完整的行和列
Apr 09 Python
Python日志:自定义输出字段 json格式输出方式
Apr 27 Python
Django 用户登陆访问限制实例 @login_required
May 13 Python
python新手学习使用库
Jun 11 Python
查找适用于matplotlib的中文字体名称与实际文件名对应关系的方法
Jan 05 Python
Python中super的用法实例
May 28 #Python
Python中的super用法详解
May 28 #Python
Python读写ini文件的方法
May 28 #Python
Python实现给文件添加内容及得到文件信息的方法
May 28 #Python
Python功能键的读取方法
May 28 #Python
python实现将文本转换成语音的方法
May 28 #Python
Python 26进制计算实现方法
May 28 #Python
You might like
PHP判断表达式中括号是否匹配的简单实例
2016/10/22 PHP
PHP递归算法的简单实例
2019/02/28 PHP
PHP如何实现阿里云短信sdk灵活应用在项目中的方法
2019/06/14 PHP
js弹出层之1:JQuery.Boxy (二)
2011/10/06 Javascript
jquery增加时编辑jqGrid(实例代码)
2013/11/08 Javascript
如何实现修改密码时密码框显示保存到cookie的密码
2013/12/10 Javascript
jquery插件jTimer(jquery定时器)使用方法
2013/12/23 Javascript
JavaScript中window.open用法实例详解
2015/04/15 Javascript
Javascript类型系统之String字符串类型详解
2016/06/21 Javascript
AngularJS下对数组的对比分析
2016/08/24 Javascript
简单谈谈ES6的六个小特性
2016/11/18 Javascript
jQuery插件echarts实现的单折线图效果示例【附demo源码下载】
2017/03/04 Javascript
利用jquery正则表达式在页面验证url网址输入是否正确
2017/04/04 jQuery
vue的diff算法知识点总结
2018/03/29 Javascript
jQuery实现经典的网页3D轮播图封装功能【附源码下载】
2019/02/15 jQuery
简单实现vue中的依赖收集与响应的方法
2019/02/18 Javascript
简单了解pytest测试框架setup和tearDown
2020/04/14 Python
Python中常见的数制转换有哪些
2020/05/27 Python
Python 如何操作 SQLite 数据库
2020/08/17 Python
HTML5和CSS3让网页设计提升到下一个高度
2009/08/14 HTML / CSS
css3圆角边框和边框阴影示例
2014/05/05 HTML / CSS
萌新的HTML5 入门指南
2020/11/06 HTML / CSS
雅诗兰黛香港官网:Estee Lauder香港
2017/09/26 全球购物
全球速卖通西班牙站:AliExpress西班牙
2017/10/30 全球购物
英国护发和美妆在线商店:Klip Shop
2019/03/24 全球购物
应届毕业生自我评价分享
2013/12/15 职场文书
英语老师推荐信
2014/02/26 职场文书
竞选部长演讲稿
2014/04/26 职场文书
上党课的心得体会
2014/09/02 职场文书
2015年小学教导处工作总结
2015/05/26 职场文书
2015年学校办公室工作总结
2015/05/26 职场文书
运动会新闻稿
2015/07/17 职场文书
少先大队干部竞选稿
2015/11/20 职场文书
医德医风学习心得体会
2016/01/25 职场文书
Springboot使用Spring Data JPA实现数据库操作
2021/06/30 Java/Android
python使用opencv对图像添加噪声(高斯/椒盐/泊松/斑点)
2022/04/06 Python