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
class BackgroundTask(IBackgroundTask): (source)
Known subclasses: orionis.background.BackgroundTasks
Constructor: BackgroundTask(func, *args, **kwargs)
Represent a background task that can be executed asynchronously.
| Parameters | |
| func | The function to be executed in the background. |
| *args | Positional arguments to pass to the function. |
| **kwargs | Keyword arguments to pass to the function. |
| Async Method | __call__ |
Execute the background task, handling both sync and async functions. |
| Method | __init__ |
Initialize the BackgroundTask instance. |
| Async Method | run |
Run the background task. |
| Class Variable | __slots__ |
Undocumented |
| Instance Variable | __args |
Undocumented |
| Instance Variable | __func |
Undocumented |
| Instance Variable | __is |
Undocumented |
| Instance Variable | __kwargs |
Undocumented |
overridden in
orionis.background.BackgroundTasksExecute the background task, handling both sync and async functions.
| Returns | |
None | This method does not return a value. |
overridden in
orionis.background.BackgroundTasksInitialize the BackgroundTask instance.
| Parameters | |
func:Callable | The function to be executed in the background. |
*args:Any | Positional arguments to pass to the function. |
**kwargs:Any | Keyword arguments to pass to the function. |
| Returns | |
None | This method does not return a value. |