Como definir o atributo de classe com await em __init__

Como posso definir uma classe com await no construtor ou corpo da classe?

Por exemplo, o que eu quero:

import asyncio

# some code


class Foo(object):

    async def __init__(self, settings):
        self.settings = settings
        self.pool = await create_pool(dsn)

foo = Foo(settings)
# it raises:
# TypeError: __init__() should return None, not 'coroutine'

ou exemplo com atributo de corpo de classe:

class Foo(object):

    self.pool = await create_pool(dsn)  # Sure it raises syntax Error

    def __init__(self, settings):
        self.settings = settings

foo = Foo(settings)

Minha solução (mas gostaria de ver uma forma mais elegante)

class Foo(object):

    def __init__(self, settings):
        self.settings = settings

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

foo = Foo(settings)
await foo.init()

A maioria dos métodos mágicos não são projetados para trabalhar com async def/ await- em geral, você só deve estar usando awaitdentro dos métodos mágicos assíncronos dedicados - __aiter__, __anext__, __aenter__, e __aexit__. Usá-lo dentro de outros métodos mágicos não funcionará, como é o caso com __init__(a menos que você use alguns truques descritos em outras respostas aqui), ou irá forçá-lo a sempre usar o que quer que acione a chamada do método mágico em um contexto assíncrono.

asyncioBibliotecas existentes tendem a lidar com isso de duas maneiras: primeiro, eu vi o padrão de fábrica usado ( asyncio-redispor exemplo):

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)

Outras bibliotecas usam uma função de co-rotina de nível superior que cria o objeto, em vez de um método de fábrica:

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)

A create_poolfunção aiopgque você deseja chamar __init__está, na verdade, usando esse padrão exato.

Isso pelo menos resolve o __init__problema. Eu não vi variáveis ​​de classe que fazem chamadas assíncronas que eu possa me lembrar, então não sei se surgiram padrões bem estabelecidos.

Outra maneira de fazer isso, por diversão:

class aobject(object):
    """Inheriting this class allows you to define an async __init__.

    So you can create objects by doing something like `await MyClass(params)`
    """
    async def __new__(cls, *a, **kw):
        instance = super().__new__(cls)
        await instance.__init__(*a, **kw)
        return instance

    async def __init__(self):
        pass

#With non async super classes

class A:
    def __init__(self):
        self.a = 1

class B(A):
    def __init__(self):
        self.b = 2
        super().__init__()

class C(B, aobject):
    async def __init__(self):
        super().__init__()
        self.c=3

#With async super classes

class D(aobject):
    async def __init__(self, a):
        self.a = a

class E(D):
    async def __init__(self):
        self.b = 2
        await super().__init__(1)

# Overriding __new__

class F(aobject):
    async def __new__(cls):
        print(cls)
        return await super().__new__(cls)

    async def __init__(self):
        await asyncio.sleep(1)
        self.f = 6

async def main():
    e = await E()
    print(e.b) # 2
    print(e.a) # 1

    c = await C()
    print(c.a) # 1
    print(c.b) # 2
    print(c.c) # 3

    f = await F() # Prints F class
    print(f.f) # 6

import asyncio
loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Eu recomendaria um método de fábrica separado. É seguro e simples. No entanto, se você insiste em uma asyncversão de __init__(), aqui está um exemplo:

def asyncinit(cls):
    __new__ = cls.__new__

    async def init(obj, *arg, **kwarg):
        await obj.__init__(*arg, **kwarg)
        return obj

    def new(cls, *arg, **kwarg):
        obj = __new__(cls, *arg, **kwarg)
        coro = init(obj, *arg, **kwarg)
        #coro.__init__ = lambda *_1, **_2: None
        return coro

    cls.__new__ = new
    return cls

Uso:

@asyncinit
class Foo(object):
    def __new__(cls):
        '''Do nothing. Just for test purpose.'''
        print(cls)
        return super().__new__(cls)

    async def __init__(self):
        self.initialized = True

async def f():
    print((await Foo()).initialized)

loop = asyncio.get_event_loop()
loop.run_until_complete(f())

Resultado:

<class '__main__.Foo'>
True

Explicação:

A construção de sua classe deve retornar um coroutineobjeto em vez de sua própria instância.

Melhor ainda, você pode fazer algo assim, o que é muito fácil:

import asyncio

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

    async def async_init(self):
        await create_pool(dsn)

    def __await__(self):
        return self.async_init().__await__()

loop = asyncio.get_event_loop()
foo = loop.run_until_complete(Foo(settings))

Basicamente, o que acontece aqui é __init__() chamado primeiro, como de costume. Em seguida, __await__()é chamado e aguarda async_init().

Resposta [quase] canônica por @ojii

@dataclass
class Foo:
    settings: Settings
    pool: Pool

    @classmethod
    async def create(cls, settings: Settings, dsn):
        return cls(settings, await create_pool(dsn))

Dependendo de suas necessidades, você também pode usar AwaitLoaderde: https://pypi.org/project/async-property/

Dos documentos:

AwaitLoaderchamará await instance.load(), se existir, antes de carregar as propriedades.