前言

書接上文：喧笔，本文造第三個輪子，也是asyncio包里面非常常用的一個函數(shù)gather

一我注、知識準(zhǔn)備

● 相對于前兩個函數(shù)捆憎，gather的使用頻率更高舅柜，因?yàn)樗С侄鄠€協(xié)程任務(wù)“同時”執(zhí)行
● 理解__await__ __iter__的使用
● 理解關(guān)鍵字async/await，async/await是3.5之后的語法躲惰，和yield/yield from異曲同工
● 今天的文章有點(diǎn)長致份，請大家耐心看完

二、環(huán)境準(zhǔn)備

三础拨、gather的實(shí)現(xiàn)

先來看下官方gather的使用方法：

|># more main.py
import asyncio

async def hello():
    print('enter hello ...')
    return 'return hello ...'

async def world():
    print('enter world ...')
    return 'return world ...'

async def helloworld():
    print('enter helloworld')
    ret = await asyncio.gather(hello(), world())
    print('exit helloworld')
    return ret

if __name__ == "__main__":
    ret = asyncio.run(helloworld())
    print(ret)
    
|># python3 main.py
enter helloworld
enter hello ...
enter world ...
exit helloworld
['return hello ...', 'return world ...']

來看下造的輪子的使用方式：

? more main.py
import wilsonasyncio

async def hello():
    print('enter hello ...')
    return 'return hello ...'

async def world():
    print('enter world ...')
    return 'return world ...'

async def helloworld():
    print('enter helloworld')
    ret = await wilsonasyncio.gather(hello(), world())
    print('exit helloworld')
    return ret


if __name__ == "__main__":
    ret = wilsonasyncio.run(helloworld())
    print(ret)

    
? python3 main.py
enter helloworld
enter hello ...
enter world ...
exit helloworld
['return hello ...', 'return world ...']

自己造的輪子也很好的運(yùn)行了氮块，下面我們來看下輪子的代碼

四、代碼解析

輪子代碼

1）代碼組成

|># tree
.
├── eventloops.py 
├── futures.py
├── main.py
├── tasks.py
├── wilsonasyncio.py

2）代碼概覽：

eventloops.py

tasks.py

futures.py

3）執(zhí)行過程

3.1）入口函數(shù)

main.py

    
if __name__ == "__main__":
    ret = wilsonasyncio.run(helloworld())
    print(ret)

• ret = wilsonasyncio.run(helloworld())使用run约素，參數(shù)是用戶函數(shù)helloworld()届良，進(jìn)入run，run的流程可以參考上一小節(jié)
• run --> run_until_complete

3.2）事件循環(huán)啟動圣猎，同之前

3.3）第一次循環(huán)run_forever --> run_once

• 將_ready隊(duì)列的內(nèi)容（即：task.__step）取出來執(zhí)行士葫，這里的coro是helloworld()

    def __step(self, exc=None):
        coro = self._coro
        try:
            if exc is None:
                result = coro.send(None)
            else:
                result = coro.throw(exc)
        except StopIteration as exc:
            super().set_result(exc.value)
        else:
            blocking = getattr(result, '_asyncio_future_blocking', None)
            if blocking:
                result._asyncio_future_blocking = False
                result.add_done_callback(self.__wakeup, result)
        finally:
            self = None

• __step較之前的代碼有改動
• result = coro.send(None)，進(jìn)入用戶定義函數(shù)

async def helloworld():
    print('enter helloworld')
    ret = await wilsonasyncio.gather(hello(), world())
    print('exit helloworld')
    return ret

• ret = await wilsonasyncio.gather(hello(), world())送悔，這里沒啥可說的慢显，進(jìn)入gather函數(shù)

def gather(*coros_or_futures, loop=None):
    loop = get_event_loop()

    def _done_callback(fut):
        nonlocal nfinished
        nfinished += 1

        if nfinished == nfuts:
            results = []
            for fut in children:
                res = fut.result()
                results.append(res)

            outer.set_result(results)

    children = []
    nfuts = 0
    nfinished = 0

    for arg in coros_or_futures:
        fut = tasks.ensure_future(arg, loop=loop)
        nfuts += 1
        fut.add_done_callback(_done_callback)

        children.append(fut)

    outer = _GatheringFuture(children, loop=loop)
    return outer

• loop = get_event_loop()獲取事件循環(huán)
• def _done_callback(fut)這個函數(shù)是回調(diào)函數(shù)，細(xì)節(jié)后面分析欠啤，現(xiàn)在只需要知道任務(wù)（hello()與world()）執(zhí)行完之后就會回調(diào)就行
• for arg in coros_or_futures for循環(huán)確保每一個任務(wù)都是Future對象荚藻，并且add_done_callback將回調(diào)函數(shù)設(shè)置為_done_callback，還有將他們加入到_ready隊(duì)列等待下一次循環(huán)調(diào)度
• 3個重要的變量：
  ? ? ? ?children里面存放的是每一個異步任務(wù)洁段，在本例是hello()與world()
  ? ? ? ?nfuts存放是異步任務(wù)的數(shù)量应狱，在本例是2
  ? ? ? ?nfinished存放的是異步任務(wù)完成的數(shù)量，目前是0祠丝，完成的時候是2
• 繼續(xù)往下疾呻，來到了_GatheringFuture，看看源碼：

class _GatheringFuture(Future):

    def __init__(self, children, *, loop=None):
        super().__init__(loop=loop)
        self._children = children

• _GatheringFuture最主要的作用就是將多個異步任務(wù)放入self._children写半，然后用_GatheringFuture這個對象來管理岸蜗。需要注意，這個對象繼承了Future
• 至此叠蝇，gather完成初始化璃岳，返回了outer，其實(shí)就是_GatheringFuture
• 總結(jié)一下gather，初始化了3個重要的變量矾睦，后面用來存放狀態(tài)晦款；給每一個異步任務(wù)添加回調(diào)函數(shù)；將多個異步子任務(wù)合并枚冗，并且使用一個Future對象去管理

3.3.1）gather完成缓溅，回到helloworld()

async def helloworld():
    print('enter helloworld')
    ret = await wilsonasyncio.gather(hello(), world())
    print('exit helloworld')
    return ret

• ret = await wilsonasyncio.gather(hello(), world()) gather返回_GatheringFuture，隨后使用await赁温，就會進(jìn)入Future.__await__

    def __await__(self):
        if self._state == _PENDING:
            self._asyncio_future_blocking = True
            yield self
        return self.result()

• 由于_GatheringFuture的狀態(tài)是_PENDING坛怪，所以進(jìn)入if，遇到yield self股囊，將self袜匿，也就是_GatheringFuture返回（這里注意yield的用法，流程控制的功能）
• 那yield回到哪兒去了呢稚疹？從哪兒send就回到哪兒去居灯，所以，他又回到了task.__step函數(shù)里面去

    def __step(self, exc=None):
        coro = self._coro
        try:
            if exc is None:
                result = coro.send(None)
            else:
                result = coro.throw(exc)
        except StopIteration as exc:
            super().set_result(exc.value)
        else:
            blocking = getattr(result, '_asyncio_future_blocking', None)
            if blocking:
                result._asyncio_future_blocking = False
                result.add_done_callback(self.__wakeup, result)
        finally:
            self = None

• 這里是本函數(shù)的第一個核心點(diǎn)内狗，流程控制/跳轉(zhuǎn)怪嫌，需要非常的清晰，如果搞不清楚的同學(xué)柳沙，再詳細(xì)的去閱讀有關(guān)yield/yield from的文章
• 繼續(xù)往下走岩灭，由于用戶函數(shù)helloworld()沒有結(jié)束，所以不會拋異常赂鲤，所以來到了else分支
• blocking = getattr(result, '_asyncio_future_blocking', None)這里有一個重要的狀態(tài)噪径，那就是_asyncio_future_blocking，只有調(diào)用__await__数初，才會有這個參數(shù)找爱，默認(rèn)是true，這個參數(shù)主要的作用：一個異步函數(shù)妙真，如果調(diào)用了多個子異步函數(shù)缴允，那證明該異步函數(shù)沒有結(jié)束（后面詳細(xì)講解），就需要添加“喚醒”回調(diào)
• result._asyncio_future_blocking = False將參數(shù)置位False珍德，并且添加self.__wakeup回調(diào)等待喚醒
• __step函數(shù)完成

_asyncio_future_blocking

• 如果在異步函數(shù)里面出現(xiàn)了await练般，調(diào)用其他異步函數(shù)的情況，就會走到Future.__await__將_asyncio_future_blocking設(shè)置為true

async def helloworld():
    print('enter helloworld')
    ret = await wilsonasyncio.gather(hello(), world())
    print('exit helloworld')
    return ret
    
class Future:
    def __await__(self):
        if self._state == _PENDING:
            self._asyncio_future_blocking = True
            yield self
        return self.result()

• 這樣做了之后锈候，在task.__step中就會把該任務(wù)的回調(diào)函數(shù)設(shè)置為__wakeup
• 為啥要__wakeup薄料，因?yàn)?code>helloworld()并沒有執(zhí)行完成，所以需要再次__wakeup來喚醒helloworld()

這里揭示了泵琳，在Eventloop里面摄职，只要使用await調(diào)用其他異步任務(wù)誊役，就會掛起父任務(wù)，轉(zhuǎn)而去執(zhí)行子任務(wù)谷市，直至子任務(wù)完成之后蛔垢，回到父任務(wù)繼續(xù)執(zhí)行

先喝口水，休息一下迫悠，下面更復(fù)雜鹏漆。。创泄。

3.4）第二次循環(huán)run_forever --> run_once

eventloops.py

    def run_once(self):
        ntodo = len(self._ready)
        for _ in range(ntodo):
            handle = self._ready.popleft()
            handle._run()

• 從隊(duì)列中取出數(shù)據(jù)艺玲，此時_ready隊(duì)列有兩個任務(wù)，hello() world()鞠抑，在gather的for循環(huán)時添加的

async def hello():
    print('enter hello ...')
    return 'return hello ...'

async def world():
    print('enter world ...')
    return 'return world ...'

• 由于hello() world()沒有await調(diào)用其他異步任務(wù)饭聚，所以他們的執(zhí)行比較簡單，分別一次task.__step就結(jié)束了搁拙，到達(dá)set_result()處
• set_result()將回調(diào)函數(shù)放入_ready隊(duì)列秒梳，等待下次循環(huán)執(zhí)行

3.5）第三次循環(huán)run_forever --> run_once

• 我們來看下回調(diào)函數(shù)

    def _done_callback(fut):
        nonlocal nfinished
        nfinished += 1

        if nfinished == nfuts:
            results = []
            for fut in children:
                res = fut.result()
                results.append(res)

            outer.set_result(results)

• 沒錯，這是本文的第二個核心點(diǎn)箕速，我們來仔細(xì)分析一下
• 這段代碼最主要的邏輯端幼，其實(shí)就是，只有當(dāng)所有的子任務(wù)執(zhí)行完之后弧满，才會啟動父任務(wù)的回調(diào)函數(shù)，本文中只有hello() world()都執(zhí)行完之后if nfinished == nfuts: 此熬，才會啟動父任務(wù)_GatheringFuture的回調(diào)outer.set_result(results)
• results.append(res)將子任務(wù)的結(jié)果取出來庭呜，放進(jìn)父任務(wù)的results里面
• 子任務(wù)執(zhí)行完成，終于到了喚醒父任務(wù)的時候了task.__wakeup

    def __wakeup(self, future):
        try:
            future.result()
        except Exception as exc:
            raise exc
        else:
            self.__step()
        self = None

3.6）第四次循環(huán)run_forever --> run_once

• future.result()從_GatheringFuture取出結(jié)果犀忱，然后進(jìn)入task.__step

    def __step(self, exc=None):
        coro = self._coro
        try:
            if exc is None:
                result = coro.send(None)
            else:
                result = coro.throw(exc)
        except StopIteration as exc:
            super().set_result(exc.value)
        else:
            blocking = getattr(result, '_asyncio_future_blocking', None)
            if blocking:
                result._asyncio_future_blocking = False
                result.add_done_callback(self.__wakeup, result)
        finally:
            self = None

• result = coro.send(None)其實(shí)就是helloworld() --> send又要跳回到當(dāng)初yield的地方募谎，那就是Future.__await__

    def __await__(self):
        if self._state == _PENDING:
            self._asyncio_future_blocking = True
            yield self
        return self.result()

• return self.result()終于返回到helloworld()函數(shù)里面去了

async def helloworld():
    print('enter helloworld')
    ret = await wilsonasyncio.gather(hello(), world())
    print('exit helloworld')
    return ret

• helloworld終于也執(zhí)行完了，返回了ret

3.7）第五次循環(huán)run_forever --> run_once

• 循環(huán)結(jié)束
• 回到run

3.8）回到主函數(shù)阴汇，獲取返回值

if __name__ == "__main__":
    ret = wilsonasyncio.run(helloworld())
    print(ret)

3.9）執(zhí)行結(jié)果

? python3 main.py
enter helloworld
enter hello ...
enter world ...
exit helloworld
['return hello ...', 'return world ...']

五数冬、流程總結(jié)

gather.jpg

六、小結(jié)

● 終于結(jié)束了搀庶，這是一個非常長的小節(jié)了拐纱，但是我感覺很多細(xì)節(jié)還是沒有說到，大家有問題請及時留言探討
● _GatheringFuture一個非常重要的對象哥倔，它不但追蹤了hello() world()的執(zhí)行狀態(tài)秸架，喚醒helloworld()，并且將返回值傳遞給helloworld
● await async yield對流程的控制需要特別關(guān)注
● 本文中的代碼咆蒿，參考了python 3.7.7中asyncio的源代碼东抹，裁剪而來
● 本文中代碼：代碼

至此蚂子，本文結(jié)束
在下才疏學(xué)淺，有撒湯漏水的缭黔，請各位不吝賜教...