Asyncio.gather vs asyncio.wait
在上篇文章已经看到多次用 asyncio.gather了,还有另外一个用法是 asyncio.wait,他们都可以让多个协程并发执行。那为什么提供2个方法呢?他们有什么区别,适用场景是怎么样的呢?其实我之前也是有点困惑,直到我读了asyncio的源码。我们先看2个协程的例子:
在IPython里面用gather执行一下:
Ok, asyncio.gather方法的名字说明了它的用途,gather的意思是「搜集」,也就是能够收集协程的结果,而且要注意,它会按输入协程的顺序保存的对应协程的执行结果。
接着我们说 asyncio.await,先执行一下:
asyncio.wait的返回值有2项,第一项表示完成的任务列表(done),第二项表示等待(Future)完成的任务列表(pending),每个任务都是一个Task实例,由于这2个任务都已经完成,所以可以执行 task.result()获得协程返回值。
Ok, 说到这里,我总结下它俩的区别的第一层区别:
asyncio.gather封装的Task全程黑盒,只告诉你协程结果。
asyncio.wait会返回封装的Task(包含已完成和挂起的任务),如果你关注协程执行结果你需要从对应Task实例里面用result方法自己拿。
为什么说「第一层区别」, asyncio.wait看名字可以理解为「等待」,所以返回值的第二项是pending列表,但是看上面的例子,pending是空集合,那么在什么情况下,pending里面不为空呢?这就是第二层区别: asyncio.wait支持选择返回的时机。
asyncio.wait支持一个接收参数 return_when,在默认情况下, asyncio.wait会等待全部任务完成(returnwhen=‘ALLCOMPLETED’),它还支持FIRSTCOMPLETED(第一个协程完成就返回)和FIRSTEXCEPTION(出现第一个异常就返回):
看到了吧,这次只有协程b完成了,协程a还是pending状态。
在大部分情况下,用asyncio.gather是足够的,如果你有特殊需求,可以选择asyncio.wait,举2个例子:
需要拿到封装好的Task,以便取消或者添加成功回调等
业务上需要FIRSTCOMPLETED/FIRSTEXCEPTION即返回的