使用asyncio.Queue进行生产者-消费者流

Question

我对于如何使用asyncio.Queue特定的生产者-消费者模式感到困惑，在该模式中，生产者和消费者都可以同时并独立地进行操作。

首先，考虑以下示例，该示例紧随docs中的asyncio.Queue示例：

import asyncio
import random
import time

async def worker(name, queue):
    while True:
        sleep_for = await queue.get()
        await asyncio.sleep(sleep_for)
        queue.task_done()
        print(f'{name} has slept for {sleep_for:0.2f} seconds')

async def main(n):
    queue = asyncio.Queue()
    total_sleep_time = 0
    for _ in range(20):
        sleep_for = random.uniform(0.05, 1.0)
        total_sleep_time += sleep_for
        queue.put_nowait(sleep_for)
    tasks = []
    for i in range(n):
        task = asyncio.create_task(worker(f'worker-{i}', queue))
        tasks.append(task)
    started_at = time.monotonic()
    await queue.join()
    total_slept_for = time.monotonic() - started_at
    for task in tasks:
        task.cancel()
    # Wait until all worker tasks are cancelled.
    await asyncio.gather(*tasks, return_exceptions=True)
    print('====')
    print(f'3 workers slept in parallel for {total_slept_for:.2f} seconds')
    print(f'total expected sleep time: {total_sleep_time:.2f} seconds')

if __name__ == '__main__':
    import sys
    n = 3 if len(sys.argv) == 1 else sys.argv[1]
    asyncio.run(main())

关于此脚本，有一个更详细的细节：queue.put_nowait(sleep_for)通过常规的for循环将项目同步放入队列。

我的目标是创建一个使用async def worker()（或consumer()）和的脚本async def producer()。两者都应安排为同时运行。没有一个消费者协程明确地与生产者绑定或链接。

我如何修改上面的程序，以便生产者是可以与消费者/工人同时调度的协程？

PYMOTW还有另一个例子。它要求生产者提前知道消费者的数量，None并向消费者发出生产已经完成的信号。

Answer 1

我如何修改上面的程序，以便生产者是可以与消费者/工人同时调度的协程？

可以对示例进行概括，而无需更改其基本逻辑：

• 将插入循环移到单独的生产者协程。
• 在后台启动消费者，让他们在生产物品时对其进行处理。
• 在消费者运行时，启动生产者并等待他们完成生产物品，例如await producer()或await gather(*producers)，等等。
• 完成所有生产者后，请等待消费者使用来处理其余项目await queue.join()。
• 取消消费者，所有消费者现在都在等待队列中的下一个物品的交付，因为我们知道生产者已经完成，所以永远不会到达。

这是实现上述内容的示例：

import asyncio, random

async def rnd_sleep(t):
    # sleep for T seconds on average
    await asyncio.sleep(t * random.random() * 2)

async def producer(queue):
    while True:
        # produce a token and send it to a consumer
        token = random.random()
        print(f'produced {token}')
        if token < .05:
            break
        await queue.put(token)
        await rnd_sleep(.1)

async def consumer(queue):
    while True:
        token = await queue.get()
        # process the token received from a producer
        await rnd_sleep(.3)
        queue.task_done()
        print(f'consumed {token}')

async def main():
    queue = asyncio.Queue()

    # fire up the both producers and consumers
    producers = [asyncio.create_task(producer(queue))
                 for _ in range(3)]
    consumers = [asyncio.create_task(consumer(queue))
                 for _ in range(10)]

    # with both producers and consumers running, wait for
    # the producers to finish
    await asyncio.gather(*producers)
    print('---- done producing')

    # wait for the remaining tasks to be processed
    await queue.join()

    # cancel the consumers, which are now idle
    for c in consumers:
        c.cancel()

asyncio.run(main())

请注意，在现实生活中的生产者和消费者（尤其是涉及网络访问的生产者和消费者）中，您可能希望捕获处理期间发生的与IO相关的异常。如果异常是可恢复的（就像大多数与网络相关的异常一样），则只需捕获异常并记录错误即可。您仍应调用，task_done()因为否则queue.join()将由于未处理的项目而挂起。如果有必要重新尝试处理该项目，则可以在调用之前将其返回到队列中task_done()。例如：

# like the above, but handling exceptions during processing:
async def consumer(queue):
    while True:
        token = await queue.get()
        try:
            # this uses aiohttp or whatever
            await process(token)
        except aiohttp.ClientError as e:
            print(f"Error processing token {token}: {e}")
            # If it makes sense, return the token to the queue to be
            # processed again. (You can use a counter to avoid
            # processing a faulty token infinitely.)
            #await queue.put(token)
        queue.task_done()
        print(f'consumed {token}')