Python中yield简单用法

你或许知道带有yield的函数在Python中被称之为generator，那何为 generator？

我们暂时抛开generator，先从一个常见编程题目开始，循序渐进了解yield的概念。

生成Fibonacci数列

Fibonacci数列是一个经典递归数列，第0个数为0，第1个数为1，除第0个和第1个数外，任意一个数都可由前两个数相加得到。

Fibonacci数列（版本一）

一种Fibonacci数列简单实现：

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

运行结果：

1
1
2
3
5

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

要提高fab函数的可复用性，最好不要直接打印出数列，而是返回一个list。那么我们在版本一的基础上进行修改。

Fibonacci数列（版本二）

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

运行结果：

1
1
2
3
5

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

如果要控制内存占用，最好不要用List来保存中间结果，而是通过iterable对象来迭代。

例如，在 Python2.x中，代码：

for i in range(1000): pass

上述代码会导致生成一个1000个元素的List。

for i in xrange(1000): pass

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

利用iterable我们可以把fab函数改写为一个支持iterable的class，以下是第三个版本的fab：

Fibonacci数列（版本三）

class Fab(object):def __init__(self, max):self.max = maxself.n, self.a, self.b = 0, 0, 1def __iter__(self):return selfdef next(self):if self.n < self.max:r = self.bself.a, self.b = self.b, self.a + self.bself.n = self.n + 1return rraise StopIteration()for n in Fab(5):print n

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

1
1
2
3
5

然而，使用class改写的这个版本，代码远远没有第一版的fab函数来得简洁。如果我们想要保持第一版fab函数的简洁性，同时又要获得iterable的效果，yield闪亮登场：

Fibonacci数列（版本四）（yield）

def fab(max):n, a, b = 0, 0, 1while n < max:yield b      # 使用 yield# print ba, b = b, a + bn = n + 1for n in fab(5):print n

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

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

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 的执行流程：

>>>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函数其他相关

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

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

---

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

>>>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，我们不再需要编写读文件的迭代类，就可以轻松实现文件读取：

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

总结

以上仅仅简单介绍了 yield 的基本概念和用法，yield 在 Python 3 中还有更强大的用法。

参考资料

Python yield 使用浅析