orionis.background.BackgroundTasks

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 BackgroundTasks(BackgroundTask): (source)

Manage and execute a collection of background tasks sequentially.

This class holds an ordered list of 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	`addTask`	Add a new BackgroundTask to the task list.
Class Variable	`__slots__`	Undocumented
Instance Variable	`tasks`	Undocumented

Inherited from BackgroundTask:

overrides orionis.background.BackgroundTask.__call__

Execute all background tasks sequentially.

Returns
`None`	This method does not return a value.

def __init__(self, tasks: Sequence[BackgroundTask] | None = None): (source) ¶

overrides orionis.background.BackgroundTask.__init__

Initialize BackgroundTasks with an optional sequence of tasks.

Parameters
tasks:`Sequence[BackgroundTask] \| None`	Optional sequence of BackgroundTask instances to initialize with.

Returns
`None`	This method does not return a value.

def addTask(self, func: Callable, *args: object, **kwargs: object): (source) ¶

Add a new BackgroundTask to the task list.

Parameters
func:`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.

overrides orionis.background.BackgroundTask.__slots__

Undocumented

Undocumented