API Reference¶
universalasync
¶
Modules:
-
loop_local– -
utils– -
wrapper–
Classes:
-
LoopLocal–Keep one value per event loop, like
threading.localdoes per thread, and close each value on its own loop.
Functions:
-
async_to_sync–Convert all public async methods/properties of an object to universal methods.
-
async_to_sync_wraps–Wrap an async method/property to universal method.
-
get_event_loop–Useful utility for getting event loop. Acts like get_event_loop(), but also creates new event loop if needed
-
idle–Useful for making event loop idle in the main thread for other threads to work
LoopLocal
¶
LoopLocal(close: Callable[[T], Coroutine[Any, Any, Any]])
flowchart TD
universalasync.LoopLocal[LoopLocal]
click universalasync.LoopLocal href "" "universalasync.LoopLocal"
Keep one value per event loop, like threading.local does per thread, and close each value on its own loop.
Wrapped methods run on the current thread's event loop, so resources bound to an event loop
(like aiohttp.ClientSession) need one instance per loop. LoopLocal creates them lazily, and closes every one of
them on the loop that owns it when close is called,
or when the LoopLocal is garbage collected.
Parameters:
-
(close¶Callable) –async function closing a value. It must not reference the object holding this
LoopLocal, or that object is never garbage collected. When the loop owning a value is already closed, the value is closed on another loop, and anEvent loop is closederror fromcloseis ignored: whatever was bound to that loop can't be cleaned up anymore
Methods:
-
close–Close all values, each on the event loop that owns it
-
get–Return the value of the current event loop, creating it first if needed
Source code in universalasync/loop_local.py
30 31 32 33 | |
close
¶
close() -> Any
Close all values, each on the event loop that owns it
Source code in universalasync/loop_local.py
60 61 62 63 64 65 | |
get
¶
get(create: Callable[[], T]) -> T
Return the value of the current event loop, creating it first if needed
When a value is created, values of event loops closed since then are closed and dropped.
Parameters:
-
(create¶Callable) –function creating the value. Unlike
close, it is not stored, so it may reference the object holding thisLoopLocal
Returns:
-
T(T) –value bound to the current event loop
Source code in universalasync/loop_local.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | |
async_to_sync
¶
async_to_sync(source: T) -> T
Convert all public async methods/properties of an object to universal methods.
Async __call__, classmethods and staticmethods are converted too.
Subclasses adding or overriding async members need to be converted as well.
See async_to_sync_wraps for more info
Parameters:
-
(source¶object) –object to convert
Returns:
-
object(T) –converted object. Note that parameter passed is being modified anyway
Source code in universalasync/wrapper.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | |
async_to_sync_wraps
¶
async_to_sync_wraps(function: Callable) -> Callable
Wrap an async method/property to universal method.
This allows to run wrapped methods in both async and sync contexts transparently without any additional code
When run from another thread, it runs coroutines in new thread's event loop. If the current thread's event loop is running in another thread, it runs coroutines there and waits for the result
See Example for full example
Parameters:
-
(function¶Callable) –function/property to wrap
Returns:
-
Callable(Callable) –modified function
Source code in universalasync/wrapper.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | |
get_event_loop
¶
get_event_loop() -> AbstractEventLoop
Useful utility for getting event loop. Acts like get_event_loop(), but also creates new event loop if needed
This will return a working event loop in 100% of cases.
Returns:
-
AbstractEventLoop–asyncio.AbstractEventLoop: event loop
Source code in universalasync/utils.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
idle
async
¶
idle() -> None
Useful for making event loop idle in the main thread for other threads to work
Source code in universalasync/__init__.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | |