THE ORIONIS API
Build with clarity.
Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.
class documentation
Manage and execute a collection of background tasks sequentially.
This class holds an ordered list of orionis.background.BackgroundTask
instances
and runs them one after another when invoked.
| Async Method | __call__ |
Execute all background tasks sequentially. |
| Method | __init__ |
Initialize BackgroundTasks with an optional sequence of tasks. |
| Method | add |
Add a new BackgroundTask to the task list. |
| Class Variable | __slots__ |
Declare the instance attribute slots reserved by this class. |
| Instance Variable | tasks |
Optional sequence of BackgroundTask instances to initialize with. |
Inherited from BackgroundTask:
| Async Method | __execute |
Run synchronous work and release its result if the caller cancels. |
| Async Method | run |
Run the background task. |
| Instance Variable | __args |
Positional arguments to pass to the function. |
| Instance Variable | __func |
The function to be executed in the background. |
| Instance Variable | __is |
Is async produced by is_async_callable. |
| Instance Variable | __kwargs |
Keyword arguments to pass to the function. |
Initialize BackgroundTasks with an optional sequence of tasks.
| Parameters | |
tasks:collections.abc.Sequence[orionis.background.BackgroundTask] | None | Optional sequence of BackgroundTask instances to initialize with. |
| Returns | |
None | This method does not return a value. |
Add a new BackgroundTask to the task list.
| Parameters | |
func:collections.abc.Callable | The function to be executed as a background task. |
*args:object | Positional arguments to pass to the function. |
**kwargs:object | Keyword arguments to pass to the function. |
| Returns | |
None | This method does not return a value. |