7.4 Python生成器详解

深入学习Python生成器(Generator)的使用方法,包括生成器的基本概念、创建方式、yield关键字的使用,掌握斐波那契数列和杨辉三角等经典算法的生成器实现。

列表生成式能直接创建列表,但列表容量受内存限制。创建一个包含100万元素的列表不仅占用大量存储空间,如果只需要访问前几个元素,后面大部分元素占用的空间就白白浪费了。

如果列表元素能按某种算法推算出来,能不能在循环过程中不断推算后续元素?这样就不必创建完整的list,节省大量空间。Python里这种一边循环一边计算的机制叫生成器(generator)。

创建generator有很多种方法。最简单的是把列表生成式的 [] 改成 ()

>>> L = [x * x for x in range(10)]
>>> L
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> g = (x * x for x in range(10))
>>> g
<generator object <genexpr> at 0x1022ef630>

创建 Lg 的区别只在最外层的 []()L 是list,g 是generator。

可以直接打印list的每个元素,但怎么打印generator的每个元素?

要一个个打印出来,可以用 next() 函数获得generator的下一个返回值:

>>> next(g)
0
>>> next(g)
1
>>> next(g)
4
>>> next(g)
9
>>> next(g)
16
>>> next(g)
25
>>> next(g)
36
>>> next(g)
49
>>> next(g)
64
>>> next(g)
81
>>> next(g)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

generator保存的是算法,每次调用 next(g) 就计算出 g 的下一个元素的值,直到最后一个元素,没有更多元素时抛出 StopIteration 错误。

不断调用 next(g) 太麻烦了,正确方法是用 for 循环,因为generator也是可迭代对象:

>>> g = (x * x for x in range(10))
>>> for n in g:
...     print(n)
... 
0
1
4
9
16
25
36
49
64
81

创建generator后,基本不会调用 next(),而是用 for 循环来迭代,也不需要关心 StopIteration 错误。

generator很强大。如果推算算法比较复杂,用类似列表生成式的 for 循环实现不了,还能用函数实现。

比如著名的斐波那契数列(Fibonacci),除第一个和第二个数外,任意一个数都是前两个数相加:

1, 1, 2, 3, 5, 8, 13, 21, 34, …

斐波那契数列用列表生成式写不出来,但用函数打印很容易:

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        print(b)
        a, b = b, a + b
        n = n + 1
    return 'done'

注意,赋值语句:

a, b = b, a + b

相当于:

t = (b, a + b) # t是一个tuple
a = t[0]
b = t[1]

但不必显式写出临时变量t就能赋值。

函数能输出斐波那契数列的前N个数:

>>> fib(6)
1
1
2
3
5
8
'done'

fib 函数实际上定义了斐波那契数列的推算规则,能从第一个元素开始推算后续任意元素,这种逻辑很像generator。

上面的函数和generator只差一步。要把 fib 变成generator函数,只需把 print(b) 改为 yield b

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        yield b
        a, b = b, a + b
        n = n + 1
    return 'done'

这就是定义generator的另一种方法。函数定义包含 yield 关键字,它就不再是普通函数,而是generator函数。调用generator函数返回一个generator:

>>> f = fib(6)
>>> f
<generator object fib at 0x104feaaa0>

generator函数和普通函数的执行流程不一样。普通函数顺序执行,遇到 return 或最后一行就返回。generator函数在每次调用 next() 时执行,遇到 yield 就返回,再次执行时从上次的 yield 处继续。

定义一个generator函数,依次返回数字1、3、5:

def odd():
    print('step 1')
    yield 1
    print('step 2')
    yield(3)
    print('step 3')
    yield(5)

调用generator函数时,先生成generator对象,再用 next() 不断获得下一个返回值:

>>> o = odd()
>>> next(o)
step 1
1
>>> next(o)
step 2
3
>>> next(o)
step 3
5
>>> next(o)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

odd 不是普通函数,而是generator函数。执行过程中遇到 yield 就中断,下次继续执行。执行3次 yield 后没有 yield 可执行了,第4次调用 next(o) 就报错。

注意: 调用generator函数会创建generator对象,多次调用会创建多个相互独立的generator。

这样调用 next() 每次都返回1:

>>> next(odd())
step 1
1
>>> next(odd())
step 1
1
>>> next(odd())
step 1
1

因为 odd() 会创建新的generator对象,上述代码实际创建了3个完全独立的generator,对3个generator分别调用 next() 当然每个都返回第一个值。

正确写法是创建一个generator对象,然后不断对这个对象调用 next()

>>> g = odd()
>>> next(g)
step 1
1
>>> next(g)
step 2
3
>>> next(g)
step 3
5

回到 fib 的例子,在循环过程中不断调用 yield 就会不断中断。要给循环设置条件来退出,不然会产生无限数列。

把函数改成generator函数后,基本不会用 next() 获取下一个返回值,而是直接用 for 循环迭代:

>>> for n in fib(6):
...     print(n)
...
1
1
2
3
5
8

但用 for 循环调用generator时,拿不到 return 语句的返回值。要拿到返回值,必须捕获 StopIteration 错误,返回值包含在 StopIterationvalue 中:

>>> g = fib(6)
>>> while True:
...     try:
...         x = next(g)
...         print('g:', x)
...     except StopIteration as e:
...         print('Generator return value:', e.value)
...         break
...
g: 1
g: 1
g: 2
g: 3
g: 5
g: 8
Generator return value: done

关于如何捕获错误,后面的错误处理会详细讲解。

练习

杨辉三角定义如下:

          1
         / \
        1   1
       / \ / \
      1   2   1
     / \ / \ / \
    1   3   3   1
   / \ / \ / \ / \
  1   4   6   4   1
 / \ / \ / \ / \ / \
1   5   10  10  5   1

把每一行看做一个list,写一个generator,不断输出下一行的list:

def triangles():
    pass

# 期待输出:
# [1]
# [1, 1]
# [1, 2, 1]
# [1, 3, 3, 1]
# [1, 4, 6, 4, 1]
# [1, 5, 10, 10, 5, 1]
# [1, 6, 15, 20, 15, 6, 1]
# [1, 7, 21, 35, 35, 21, 7, 1]
# [1, 8, 28, 56, 70, 56, 28, 8, 1]
# [1, 9, 36, 84, 126, 126, 84, 36, 9, 1]
n = 0
results = []
for t in triangles():
    results.append(t)
    n = n + 1
    if n == 10:
        break

for t in results:
    print(t)

if results == [
    [1],
    [1, 1],
    [1, 2, 1],
    [1, 3, 3, 1],
    [1, 4, 6, 4, 1],
    [1, 5, 10, 10, 5, 1],
    [1, 6, 15, 20, 15, 6, 1],
    [1, 7, 21, 35, 35, 21, 7, 1],
    [1, 8, 28, 56, 70, 56, 28, 8, 1],
    [1, 9, 36, 84, 126, 126, 84, 36, 9, 1]
]:
    print('测试通过!')
else:
    print('测试失败!')

参考源码

do_generator.py

小结

generator是很强大的工具。在Python中,可以简单地把列表生成式改成generator,也可以通过函数实现复杂逻辑的generator。

理解generator的工作原理:它在 for 循环过程中不断计算下一个元素,在适当条件结束循环。对于函数改成的generator,遇到 return 或执行到函数体最后一行就是结束指令,for 循环随之结束。

注意区分普通函数和generator函数。普通函数调用直接返回结果:

>>> r = abs(6)
>>> r
6

generator函数的调用实际返回generator对象:

>>> g = fib(6)
>>> g
<generator object fib at 0x1022ef948>