只要 Python 函数的定义体中有 yield 关键字,该函数就是生成器函数。调用生成器函数 时,会返回一个生成器对象。也就是说,生成器函数是生成器工厂。
普通的函数与生成器函数在句法上唯一的区别是,在后者的定义体中有 yield 关键字。
"""
生成器原理
"""
# 只要 Python 函数中包含关键字 yield,该函数就是生成器函数。
def gen_123():
# 生成器函数的定义体中通常都有循环,不过这不是必要条件;这里我重复使用 yield。
yield 1
yield 2
yield 3
yield 4
if __name__ == '__main__':
# 仔细看,gen_123 是函数对象。
print(gen_123)
# 但是调用时,gen_123() 返回一个生成器对象。
print(gen_123())
# 生成器是迭代器,会生成传给 yield 关键字的表达式的值。
for i in gen_123():
print(i)
# 为了仔细检查,我们把生成器对象赋值给 g。
g = gen_123()
# 因为 g 是迭代器,所以调用 next(g) 会获取 yield 生成的下一个元素。
print(next(g))
print(next(g))
print(next(g))
print(next(g))
# 生成器函数的定义体执行完毕后,生成器对象会抛出 StopIteration 异常。
print(next(g))
运行结果:
生成器函数会创建一个生成器对象,包装生成器函数的定义体。把生成器传给 next(...)
函数时,生成器函数会向前,执行函数定义体中的下一个 yield
语句,返回产出的值,并在函数定义体的当前位置暂停。最终,函数的定义体返回时,外层的生成器对象会抛出StopIteration
异常——这一点与迭代器协议一致。
使用准确的词语描述从生成器中获取结果的过程,有助于理解生成器。注意,我说的是产出或生成值。如果说生成器“返回”值,就会让人难以理解。函数返回值;调用生成器函数返回生成器;生成器产出或生成值。生成器不会以常规的方式“返回”值:生成器函数定义体中的 return 语句会触发生成器对象抛出 StopIteration
异常。
在 Python 3.3 之前,如果生成器函数中的 return
语句有返回值,那么会报错。现在可以这么做,不过return
语句仍会导致 StopIteration
异常抛出。调用方可以从异常对象中获取返回值。可是,只有把生成器函数当成协程使用时,这么做才有意义。
下面来看一下,生成器的执行原理:
重这里面可以看出:
1、定义生成器函数的方式与普通的函数无异,只不过要使用 yield 关键字。
2、明确表明了,上文中的当前位置暂停 的含义。
3、到达生成器函数定义体的末尾时,生成器对象抛出 StopIteration
异常。