Python yield 利用浅析
您大概传闻过,带有 yield 的函数在 Python 中被称之为 generator(生成器),何谓 generator ?
我们先抛开 generator,以一个常见的编程题目来展示 yield 的观念。
如何生成斐波那契數列
斐波那契(Fibonacci)數列是一个很是简朴的递归数列,除第一个和第二个数外,任意一个数都可由前两个数相加获得。用计较机措施输出斐波那契數列的前 N 个数是一个很是简朴的问题,很多初学者都可以等闲写出如下函数:
清单 1. 简朴输出斐波那契數列前 N 个数
deffab(max): n, a, b =0, 0, 1 whilen < max: printb a, b =b, a +b n =n +1
执行 fab(5),我们可以获得如下输出:
>>> fab(5)
功效没有问题,但有履历的开拓者会指出,直接在 fab 函数顶用 print 打印数字会导致该函数可复用性较差,因为 fab 函数返回 None,其他函数无法得到该函数生成的数列。
要提高 fab 函数的可复用性,最好不要直接打印出数列,而是返回一个 List。以下是 fab 函数改写后的第二个版本:
清单 2. 输出斐波那契數列前 N 个数第二版
deffab(max): n, a, b =0, 0, 1 L =[] whilen < max: L.append(b) a, b =b, a +b n =n +1 returnL
可以利用如下方法打印出 fab 函数返回的 List:
>>> forn infab(5):
… printn
…
改写后的 fab 函数通过返回 List 能满意复用性的要求,可是更有履历的开拓者会指出,该函数在运行中占用的内存会跟着参数 max 的增大而增大,假如要节制内存占用,最好不要用 List
来生存中间功效,而是通过 iterable 工具来迭代。譬喻,在 Python2.x 中,代码:
清单 3. 通过 iterable 工具来迭代
fori inrange(1000): pass
会导致生成一个 1000 个元素的 List,而代码:
fori inxrange(1000): pass
则不会生成一个 1000 个元素的 List,而是在每次迭代中返回下一个数值,内存空间占用很小。因为 xrange 不返回 List,而是返回一个 iterable 工具。
操作 iterable 我们可以把 fab 函数改写为一个支持 iterable 的 class,以下是第三个版本的 Fab:
清单 4. 第三个版本
classFab(object): def__init__(self, max): self.max=max self.n, self.a, self.b =0, 0, 1 def__iter__(self): returnself defnext(self): ifself.n < self.max: r =self.b self.a, self.b =self.b, self.a +self.b self.n =self.n +1 returnr raiseStopIteration()
Fab 类通过 next() 不绝返回数列的下一个数,内存占用始终为常数:
>>> forn inFab(5):
… printn
…
然而,利用 class 改写的这个版本,代码远远没有第一版的 fab 函数来得简捷。假如我们想要保持第一版 fab 函数的简捷性,同时又要得到 iterable 的结果,yield 就派上用场了:
清单 5. 利用 yield 的第四版
deffab(max): n, a, b =0, 0, 1 whilen < max: yieldb # print b a, b =b, a +b n =n +1
第四个版本的 fab 和第一版对比,仅仅把 print b 改为了 yield b,就在保持简捷性的同时得到了 iterable 的结果。
挪用第四版的 fab 和第二版的 fab 完全一致:
>>> forn infab(5):
… printn
…
简朴地讲,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()
>>> f.next()
>>> f.next()
>>> f.next()
>>> f.next()
>>> f.next()
Traceback (most recent call last):
File"", line 1, in StopIteration
当函数执行竣事时,generator 自动抛出 StopIteration 异常,暗示迭代完成。在 for 轮回里,无需处理惩罚 StopIteration 异常,轮回会正常竣事。
我们可以得出以下结论:
#p#分页标题#e#
一个带有 yield 的函数就是一个 generator,它和普通函数差异,生成一个 generator 看起来像函数挪用,但不会执行任何函数代码,直到对其挪用 next()(在 for 轮回中会自动挪用 next())才开始执行。固然执行流程仍按函数的流程执行,但每执行到一个 yield 语句就会间断,并返回一个迭代值,下次执行时从 yield 的下一个语句继承执行。看起来就仿佛一个函数在正常执行的进程中被 yield 间断了数次,每次间断城市通过 yield 返回当前的迭代值。
yield 的长处是显而易见的,把一个函数改写为一个 generator 就得到了迭代本领,比起用类的实例生存状态来计较下一个 next() 的值,不只代码简捷,并且执行流程异常清晰。
如何判定一个函数是否是一个非凡的 generator 函数?可以操作 isgeneratorfunction 判定:
清单 7. 利用 isgeneratorfunction 判定
>>> frominspect importisgeneratorfunction
>>> isgeneratorfunction(fab)
True
要留意区分 fab 和 fab(5),fab 是一个 generator function,而 fab(5) 是挪用 fab 返回的一个 generator,比如类的界说和类的实例的区别:
清单 8. 类的界说和类的实例
>>> importtypes
>>> isinstance(fab, types.GeneratorType)
False
>>> isinstance(fab(5), types.GeneratorType)
True
fab 是无法迭代的,而 fab(5) 是可迭代的:
>>> fromcollections importIterable
>>> 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 的例子
defread_file(fpath): BLOCK_SIZE =1024 with open(fpath, 'rb') as f: whileTrue: block =f.read(BLOCK_SIZE) ifblock: yieldblock else: return
以上仅仅简朴先容了 yield 的根基观念和用法,yield 在 Python 3 中尚有更强大的用法,我们会在后续文章中接头。
注:本文的代码均在 Python 2.7 中调试通过