How to set class attribute with await in __init__

by

Most magic methods aren’t designed to work with async def/await – in general, you should only be using await inside the dedicated asynchronous magic methods – __aiter__, __anext__, __aenter__, and __aexit__. Using it inside other magic methods either won’t work at all, as is the case with __init__ (unless you use some tricks described in other answers here), or will force you to always use whatever triggers the magic method call in an asynchronous context.

Existing asyncio libraries tend to deal with this in one of two ways: First, I’ve seen the factory pattern used (asyncio-redis, for example):

import asyncio

dsn = "..."

class Foo(object):
    @classmethod
    async def create(cls, settings):
        self = Foo()
        self.settings = settings
        self.pool = await create_pool(dsn)
        return self

async def main(settings):
    settings = "..."
    foo = await Foo.create(settings)

Other libraries use a top-level coroutine function that creates the object, rather than a factory method:

import asyncio

dsn = "..."

async def create_foo(settings):
    foo = Foo(settings)
    await foo._init()
    return foo

class Foo(object):
    def __init__(self, settings):
        self.settings = settings

    async def _init(self):
        self.pool = await create_pool(dsn)

async def main():
    settings = "..."
    foo = await create_foo(settings)

The create_pool function from aiopg that you want to call in __init__ is actually using this exact pattern.

This at least addresses the __init__ issue. I haven’t seen class variables that make asynchronous calls in the wild that I can recall, so I don’t know that any well-established patterns have emerged.

More Related Contents:

  1. How does asyncio actually work?
  2. How to limit concurrency with Python asyncio?
  3. How can I periodically execute a function with asyncio?
  4. Python 3.7 – asyncio.sleep() and time.sleep()
  5. asyncio.sleep() vs time.sleep()
  6. multiprocessing vs multithreading vs asyncio in Python 3
  7. How to use asyncio with existing blocking library?
  8. Simplest async/await example possible in Python
  9. Combine awaitables like Promise.all
  10. How to test Python 3.4 asyncio code?
  11. How can I wrap a synchronous function in an async coroutine?
  12. Does asyncio supports asynchronous I/O for file operations?
  13. What does “SSLError: [SSL] PEM lib (_ssl.c:2532)” mean using the Python ssl library?
  14. asyncio.sleep() vs time.sleep() in Python
  15. How to call an async function without await?
  16. multiprocessing vs multithreading vs asyncio
  17. Using asyncio.Queue for producer-consumer flow
  18. asyncio.ensure_future vs. BaseEventLoop.create_task vs. simple coroutine?
  19. How can I await inside future-like object’s __await__?
  20. Is there a way to use asyncio.Queue in multiple threads?
  21. “asyncio.run() cannot be called from a running event loop” when using Jupyter Notebook
  22. how to add a coroutine to a running asyncio loop?
  23. How to combine Celery with asyncio?
  24. How to use a variable inside a regular expression?
  25. Purpose of calling function without brackets python
  26. Python sockets error TypeError: a bytes-like object is required, not ‘str’ with send function
  27. asyncio: Is it possible to cancel a future been run by an Executor?
  28. How to embed image or picture in jupyter notebook, either from a local machine or from a web resource?
  29. How to zoom in and out of an image pygame and using the mousposition as the center of the zoom
  30. How to convert numbers to words without using num2word library?

Leave a Comment