第 7 章讨论闭包时,我们分析了如何使用对象计算移动平均值:示例 7-8 定义的是一个简单的类;示例 7-14 定义的是一个高阶函数,用于生成一个闭包,在多次调用之间跟踪 totalcount 变量的值。示例 16-3 展示如何使用协程实现相同的功能。2

2这个示例的灵感来自 Jacob Holm 在 Python-ideas 邮件列表中发布的一个代码片段,他发布的消息题为“Yield-From: Finalization guarantees”(https://mail.python.org/pipermail/python-ideas/2009-April/003841.html)。在那个消息的后续回复中,那段代码有几个变体。Holm 在 003912 号消息(https://mail.python.org/pipermail/python-ideas/2009-April/003912.html)中进一步说明了自己的想法。

示例 16-3 coroaverager0.py:定义一个计算移动平均值的协程

def averager():
    total = 0.0
    count = 0
    average = None
    while True:  ➊
        term = yield average  ➋
        total += term
        count += 1
        average = total/count

➊ 这个无限循环表明,只要调用方不断把值发给这个协程,它就会一直接收值,然后生成结果。仅当调用方在协程上调用 .close() 方法,或者没有对协程的引用而被垃圾回收程序回收时,这个协程才会终止。

➋ 这里的 yield 表达式用于暂停执行协程,把结果发给调用方;还用于接收调用方后面发给协程的值,恢复无限循环。

使用协程的好处是,totalcount 声明为局部变量即可,无需使用实例属性或闭包在多次调用之间保持上下文。示例 16-4 是使用 averager 协程的 doctest。

示例 16-4 coroaverager0.py:示例 16-3 中定义的移动平均值协程的 doctest

    >>> coro_avg = averager()  ➊
    >>> next(coro_avg)  ➋
    >>> coro_avg.send(10)  ➌
    10.0
    >>> coro_avg.send(30)
    20.0
    >>> coro_avg.send(5)
    15.0

❶ 创建协程对象。

❷ 调用 next 函数,预激协程。

❸ 计算移动平均值:多次调用 .send(...) 方法,产出当前的平均值。

在上述 doctest 中(示例 16-4),调用 next(coro_avg) 函数后,协程会向前执行到 yield 表达式,产出 average 变量的初始值——None,因此不会出现在控制台中。此时,协程在 yield 表达式处暂停,等到调用方发送值。coro_avg.send(10) 那一行发送一个值,激活协程,把发送的值赋给 term,并更新 totalcountaverage 三个变量的值,然后开始 while 循环的下一次迭代,产出 average 变量的值,等待下一次为 term 变量赋值。

细心的读者可能迫切地想知道如何终止执行 averager 实例(如 coro_avg),因为定义体中有个无限循环。16.5 节会讨论这个话题。

讨论如何终止协程之前,我们要先谈谈如何启动协程。使用协程之前必须预激,可是这一步容易忘记。为了避免忘记,可以在协程上使用一个特殊的装饰器。接下来介绍这样一个装饰器。