Reference

Contents:

• callbacks
• coro_queue
• protocol

class async_patterns.Callbacks

Accepts callables objects and stores them in a list, then calls them all when something interesting happens

acall(*args)

This is a coroutine. Trigger a call to each callback and assume each is a coroutine, pass args to each.

add_callback(callable_)

Add callable_ to the list of callbacks. When this class’s Callbacks.__call__() function is called, callable_ will be called with the same arguments passed to that function.

Parameters:callable – a callable object

class async_patterns.CoroQueue(loop)

A queue of coroutines to be called sequentially.

Parameters:loop – event loop

close()

Cancel all pending coroutines.

This method is a coroutine.

join()

Wait for all coroutines to finish. Await the underlying asyncio.Queue object’s join method.

This method is a coroutine.

put_nowait(f, *args, **kwargs)

Put a coroutine onto the queue.

Parameters:

• f – a coroutine function
• args – arguments to be passed to the coroutine

schedule_run_forever()

Schedule asyncio to run the consumer loop.

class async_patterns.CoroQueueClass(queue=None, loop=None)

Provide a method wrapper that schedules execution of the wrapped function using a CoroQueue object.

class Foo(CoroQueueClass):
    @CoroQueueClass.wrap
    async def a(self):
        await asyncio.sleep(1)

async def test(loop):
    f = Foo()
    f._loop = loop
    await f.a()
    await f.close()

loop.run_until_complete(test(loop))