引言
你可能听说过,带有 yield 的函数在 Python 中被称之为 generator(生成器),又或者都没关注过,Python 中还有个 yield 的存在。如果你了解过 Python 中的 yield,那你知道何谓 generator 吗?
yield 的概念
理解yield 的 generator 概念,首先以一个常见的编程题目来展示 yield 的概念。
如何生成斐波那契數列
斐波那契(Fibonacci)數列是一个非常简单的递归数列,除第一个和第二个数外,任意一个数都可由前两个数相加得到。用计算机程序输出斐波那契數列的前 N 个数是一个非常简单的问题,有些 Python 基础的小伙伴都可以轻易写出如下函数:
第 1 版本:简单输出斐波那契數列前 N 个数
def createNum(count):
n, a, b = 0, 0, 1
while n < count:
print b
a, b = b, a + b
n = n + 1
createNum(5)
执行以上代码,我们可以得到如下输出:
1
1
2
3
5
输出结果是没有问题的,但是版本 1 中的写法是直接在 createNum 函数中用 print 打印数字会导致该函数可复用性较差,因为 createNum 函数返回 None,其他函数无法获得该函数生成的数列。
要提高 createNum 函数的可复用性,最好不要直接打印出数列,而是返回一个 List。以下是 createNum 函数改写后的第二个版本:
第 2 版本:输出斐波那契數列前 N 个数
def createNum(count):
n, a, b = 0, 0, 1
L = []
while n < count:
L.append(b)
a, b = b, a + b
n = n + 1
return L
for n in createNum(5):
print n
该版本中 createNum 函数返回的 List的结果如下:
1
1
2
3
5
改写后的 createNum 函数通过返回 List 能满足复用性的要求,但是与此同时也会存在一个明显的问题是:该函数在运行中占用的内存会随着参数 count 的增大而增大,如果要控制内存占用,最好不要用 List 来保存中间结果,而是通过 iterable 对象来迭代。在每次迭代中返回下一个数值,如此:内存空间占用很小。因为是直接返回一个 iterable 对象。
第 3 版本:使用 yield 输出斐波那契數列前 N 个数
def createNum(count):
n, a, b = 0, 0, 1
while n < count:
yield b # 使用 yield
# print(b)
a, b = b, a + b
n = n + 1
for n in createNum(5):
print n
也可以手动调用 createNum(5) 的 next() 方法(因为 createNum(5) 是一个 generator 对象,该对象具有 next() 方法),这样我们就可以更清楚地看到 createNum 的执行流程:
第 4 版本:执行流程
def createNum(count):
n, a, b = 0, 0, 1
while n < count:
yield b # 使用 yield
# print(b)
a, b = b, a + b
n = n + 1
#使用for循环来执行createNum()函数,它返回一个迭代值,下次迭代从yield语句的下一条语句继续执行
<!--for n in createNum(5):
print n-->
#使用next方法来执行createNum()函数,generator(生成器)对象具有next()方法
num = createNum(5)
print(next(num))
print(next(num))
print(next(num))
print(next(num))
print(next(num))
print(next(num))
运行以上代码,结果输出如下:
1
1
2
3
5
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
StopIteration
由输出结果可发现在执行第 6 个 print(next(num)) 时抛出一个 StopIteration 的异常,是因为在第 5 个 print(next(num)) 执行完时函数已经结束,再执行第 6 个print(next(num))时,generator 自动抛出 StopIteration 异常,表示迭代完成。在 for 循环里,无需处理 StopIteration 异常,循环会正常结束。
yield 的作用
简单地讲,yield 的作用就是把一个函数变成一个 generator,带有 yield 的函数不再是一个普通函数,Python 解释器会将其视为一个 generator,调用 createNum(5) 不会执行 createNum 函数,而是返回一个 iterable 对象!
在 for 循环执行时,每次循环都会执行 createNum 函数内部的代码,执行到 yield b 时,createNum 函数就会返回一个迭代值,下次迭代时,代码从 yield b 的下一条语句继续执行,而函数的本地变量看起来和上次中断执行前是完全一样的,于是函数继续执行,直到再次遇到 yield。
yield 使用场景
- 迭代生成数据(生产者,数据量巨大时优势更加明显,它可以不占用大量内存)
- 接收数据(消费者)
- 中断(协作式的任务)
总结
一个带有 yield 的函数就是一个 generator,它和普通函数不同,生成一个 generator 看起来像函数调用,但不会执行任何函数代码,直到对其调用 next()(在 for 循环中会自动调用 next())才开始执行。虽然执行流程仍按函数的流程执行,但每执行到一个 yield 语句就会中断,并返回一个迭代值,下次执行时从 yield 的下一个语句继续执行。看起来就好像一个函数在正常执行的过程中被 yield 中断了数次,每次中断都会通过 yield 返回当前的迭代值。
yield 的好处是显而易见的,把一个函数改写为一个 generator 就获得了迭代能力,比起用类的实例保存状态来计算下一个 next() 的值,不仅代码简洁,而且执行流程异常清晰。