协程的语法和生成器类似,都是定义体中包含yield关键字的函数。在协程中,yield通常出现在表达式右边。可以产出值,也可以不产出——如果 yield 关键字后面没有表达式,那么生成器产出 None。协程可能会从调用方接收数据,不过调用方把数据提供给协程使用的是 .send(value) 方法,而不是next(...) 函数。通常,调用方会把值推送给协程。

生成器的调用方可以使用 .send(…) 方法发送数据,发送的数据会成为生成器函数中 yield 表达式的值。因此,生成器可以作为协程使用。协程是指一个过程,这个过程与调用方协作,产出由调用方提供的值。生成器可以返回一个值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
def simple_coro():
print('coro begin')
x = yield 1
print('x:',x)
print('coro end')

print('begin')
a = simple_coro()
print('init coro')
try:
print(next(a))
print(a.send('a'))
except StopIteration:
pass
print('end')
###
begin
init coro
coro begin
1
x: a
coro end
end

协程可以身处四个状态中的一个。当前状态可以使用 inspect.getgeneratorstate(...) 函数确定,该函数会返回下述字符串中的一个。
GEN_CREATED 等待开始执行。
GEN_RUNNING 解释器正在执行。
GEN_SUSPENDED 在 yield 表达式处暂停。
GEN_CLOSED 执行结束。

因为 send 方法的参数会成为暂停的 yield 表达式的值,所以,仅当协程处于暂停状态时才能调用 send 方法,例如 my_coro.send(42)。不过,如果协程还没激活(即,状态是 GEN_CREATED),情况就不同了。因此,始终要调用 next(my_coro) 激活协程——也可以调用 my_coro.send(None),如果创建协程对象后立即把 None 之外的值发给它,会抛出TypeError: can't send non-None value to a just-started generator

最先调用 next(my_coro) 函数这一步通常称为“预激”(prime)协程(即,让协程向前执行到第一个 yield 表达式,准备好作为活跃的协程使用)。

协程中未处理的异常会向上冒泡,传给 next 函数或 send 方法的调用方(即触发协程的对象)

coro.throw(exc_type[, exc_value[, traceback]])
致使生成器在暂停的 yield 表达式处抛出指定的异常。如果生成器处理了抛出的异常,代码会向前执行到下一个 yield 表达式,而产出的值会成为调用 generator.throw 方法得到的返回值。如果生成器没有处理抛出的异常,异常会向上冒泡,传到调用方的上下文中。
coro.close()
致使生成器在暂停的 yield 表达式处抛出 GeneratorExit 异常。如果生成器没有处理这个异常,或者抛出了 StopIteration 异常(通常是指运行到结尾),调用方不会报错。如果收到 GeneratorExit 异常,生成器一定不能产出值,否则解释器会抛出 RuntimeError 异常。生成器抛出的其他异常会向上冒泡,传给调用方。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class TestExcept(Exception):
pass

def simple_coro():
print('coro begin')
try:
x = yield 1
except TestExcept:
print('deal')
yield 2
print('coro end')
return 10

print('begin')
a = simple_coro()
print('init coro')
try:
print('1',next(a))
print('2',a.throw(TestExcept))
print('3',next(a))
except StopIteration as e:
print('except e:',e.value)
print('end')
###
begin
init coro
coro begin
1 1
deal
2 2
coro end
except e: 10
end

TestExcept 异常传入 simple_coro 不会导致协程中止,但是,如果传入协程的异常没有处理,协程会停止,即状态变成 GEN_CLOSED。异常对象的 value 属性保存着返回的值。注意,return 表达式的值会偷偷传给调用方,赋值给 StopIteration 异常的一个属性。这样做有点不合常理,但是能保留生成器对象的常规行为——耗尽时抛出 StopIteration 异常。

yield from 结构来说,解释器不仅会捕获 StopIteration 异常,还会把 value 属性的值变成 yield from 表达式的值

在生成器 gen 中使用 yield from subgen()`subgen 会获得控制权,把产出的值传给 gen 的调用方,即调用方可以直接控制 subgen。与此同时,gen 会阻塞,等待 subgen 终止。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def yf_coro():
yield 1
yield 2
yield 3
return 'end'

def simple_coro():
print('coro begin')
gg = yield from yf_coro()
print('gg',gg)
print('coro end')

a = simple_coro()
while True:
try:
print(next(a))
except StopIteration:
break
###
coro begin
1
2
3
gg end
coro end

子生成器可能是简单的迭代器,只实现了 __next__ 方法;但是,yield from 也能处理这种子生成器。不过,引入 yield from 结构的目的是为了支持实现了 __next__sendclosethrow 方法的生成器。