Skip to content

trcks.oop.BaseAwaitableWrapper

Bases: BaseWrapper[Awaitable[_T_co]]

Base class for all asynchronous wrappers in the trcks.oop package.

Note

This class is not particularly useful by itself. If you want to wrap and process a value, please consider using one of its subclasses, such as trcks.oop.AwaitableWrapper.

Source code in src/trcks/oop/_base_awaitable_wrapper.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class BaseAwaitableWrapper(BaseWrapper[Awaitable[_T_co]]):
    """Base class for all asynchronous wrappers in the [trcks.oop][] package.

    Note:
        This class is not particularly useful by itself.
        If you want to wrap and process a value,
        please consider using one of its subclasses,
        such as [trcks.oop.AwaitableWrapper][].
    """

    __slots__: tuple[str, ...] = ()

    @property
    async def core_as_coroutine(self) -> _T_co:
        """The wrapped [collections.abc.Awaitable][] object
        transformed into a coroutine.

        This is useful for functions that expect a coroutine
        (e.g. [asyncio.run][] in Python 3.13 and older).

        Note:
            The attribute `trcks.oop.BaseAwaitableWrapper.core`
            has type [collections.abc.Awaitable][],
            a superclass of [collections.abc.Coroutine][].

        Example:
            >>> import asyncio
            >>> from trcks.oop import BaseAwaitableWrapper
            >>> loop = asyncio.new_event_loop()
            >>> future: asyncio.Future[str] = loop.create_future()
            >>> future.set_result("Hello, world!")
            >>> wrapped_future = BaseAwaitableWrapper(future)
            >>> wrapped_future
            BaseAwaitableWrapper(core=<Future finished result='Hello, world!'>)
            >>> coro = wrapped_future.core_as_coroutine
            >>> coro
            <coroutine object BaseAwaitableWrapper.core_as_coroutine at 0x...>
            >>> loop.run_until_complete(coro)
            'Hello, world!'
            >>> loop.close()
        """
        return await self.core

core_as_coroutine async property

The wrapped collections.abc.Awaitable object transformed into a coroutine.

This is useful for functions that expect a coroutine (e.g. asyncio.run in Python 3.13 and older).

Note

The attribute trcks.oop.BaseAwaitableWrapper.core has type collections.abc.Awaitable, a superclass of collections.abc.Coroutine.

Example 
>>> import asyncio
>>> from trcks.oop import BaseAwaitableWrapper
>>> loop = asyncio.new_event_loop()
>>> future: asyncio.Future[str] = loop.create_future()
>>> future.set_result("Hello, world!")
>>> wrapped_future = BaseAwaitableWrapper(future)
>>> wrapped_future
BaseAwaitableWrapper(core=<Future finished result='Hello, world!'>)
>>> coro = wrapped_future.core_as_coroutine
>>> coro
<coroutine object BaseAwaitableWrapper.core_as_coroutine at 0x...>
>>> loop.run_until_complete(coro)
'Hello, world!'
>>> loop.close()