深入Python中的asyncio库——线程并发函数

Asyncio ——gather vs wait

在 Asyncio 中不仅可以多次使用 asyncio.gather，还有一个用法是 asyncio.wait，它可以允许多个协程并发执行。

那么为什么要提供2种方法呢？它们之间有什么区别，适用的场景有哪些？我们先来看两个协程的例子：

async def a():
    print('Suspending a')
    await asyncio.sleep(3)
    print('Resuming a')
    return 'A'
async def b():
    print('Suspending b')
    await asyncio.sleep(1)
    print('Resuming b')
    return 'B'

在IPython里面用gather执行一下：

In : return_value_a, return_value_b = await asyncio.gather(a(), b())
Suspending a
Suspending b
Resuming b
Resuming a
In : return_value_a, return_value_b
Out: ('A', 'B')

好的，asyncio.gather方法的名字说明了它的用途，gather的意思是“收集”，也就是可以收集协程的结果，需要注意的是它会按顺序保存对应协程的执行输入协程结果。

接着我们说asyncio.await，先执行一下：

In : done, pending = await asyncio.wait([a(), b()])
Suspending b
Suspending a
Resuming b
Resuming a
In : done
Out:
{<Task finished coro=<a() done, defined at <ipython-input-5-5ee142734d16>:1> result='A'>,
 <Task finished coro=<b() done, defined at <ipython-input-5-5ee142734d16>:8> result='B'>}
In : pending
Out: set()
In : task = list(done)[0]
In : task
Out: <Task finished coro=<b() done, defined at <ipython-input-5-5ee142734d16>:8> result='B'>
In : task.result()
Out: 'B'

asyncio.wait的返回值有2项，第一项代表已完成的任务列表(done)，第二项代表待完成的任务列表(pending)(Future)，每个任务都是一个Task实例，因为这2项所有任务都已经完成，可以执行task.result()获取协程的返回值。

Ok, 说到这里，总结下

它俩的区别的第一层区别:

asyncio.gather封装的Task全程黑盒，只告诉你协程结果。

asyncio.wait 将返回封装后的 Task（包括已完成和待处理的任务）。如果关心协程的执行结果，需要使用对应Task实例的result方法。

为什么说“第一层区别”，asyncio.wait根据名字可以理解为“等待”，所以返回值的第二项就是待处理列表，但是看上面的例子，pending是一个空集，那么在什么情况下，pending里面不是空的吗？这是第二层区别：asyncio.wait 支持选择何时返回。

asyncio.wait支持接收参数return_when，默认情况下，asyncio.wait会等待所有任务完成（return_when='ALL_COMPLETED'），它还支持FIRST_COMPLETED（第一个协程完成时返回）和FIRST_EXCEPTION（第一个返回一个例外）：

In : done, pending = await asyncio.wait([a(), b()], return_when=asyncio.tasks.FIRST_COMPLETED)
Suspending a
Suspending b
Resuming b
In : done
Out: {<Task finished coro=<b() done, defined at <ipython-input-5-5ee142734d16>:8> result='B'>}
In : pending
Out: {<Task pending coro=<a() running at <ipython-input-5-5ee142734d16>:3> wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at 0x108065e58>()]>>}

看到了吧，这次只有协程b完成了，协程a还是pending状态。

大多数情况下，使用 asyncio.gather 就足够了，如果你有特殊需要，可以选择 asyncio.wait，举两个例子：

你需要获取打包的任务才能取消或添加成功回调等。

业务上需要FIRST_COMPLETED/FIRST_EXCEPTION即返回的

asyncio.create_task vs loop.create_task vs asyncio.ensure_future

有 3 种创建任务的方法，如本节的标题。上一篇我说过，从Python 3.7开始，可以统一使用更高阶的asyncio.create_task。其实asyncio.create_task就是用loop.create_task：

def create_task(coro):
    loop = events.get_running_loop()
    return loop.create_task(coro)

loop.create_task 接受的参数需要是协程，但是除了接受协程之外，asyncio.ensure_future 还可以是 Future 对象或 awaitable 对象：

如果参数是协程，其实底层还是用的loop.create_task，返回Task对象

如果是Future对象会直接返回

如果是awaitable对象，则等待该对象的__await__方法，再次执行ensure_future，最后返回Task或Future

所以正如名称 ensure_future 所说，确保这是一个 Future 对象：Task 是 Future 的子类。如前所述，一般来说，开发者不需要自己创建 Futures。

其实上面提到的asyncio.wait和asyncio.gather中都用到了asyncio.ensure_future。对于大部分场景，协程是并发执行的，所以直接使用asyncio.create_task就够了~

下一节：