pi_portal.modules.tasks.registration.registry.TaskRegistry

class pi_portal.modules.tasks.registration.registry.TaskRegistry[source]

Bases: object

Tasks registered for use with the scheduler.

__init__() → None[source]
filter_tasks(api_enabled: bool | None = None) → Dict[TaskType, RegisteredTask][source]

Return a filtered list of tasks.

Parameters:

api_enabled (bool | None) – Set to True or False to filter by this value.

Returns:

The filtered dictionary of registered tasks, keyed by task type.

Return type:

Dict[TaskType, RegisteredTask]

register_cron_job(module_name: str) → None[source]

Register the cron job module with this task name.

Parameters:

module_name (str) – The name of the module to register.

register_task(module_name: str) → None[source]

Register the task module and any processor module with this task name.

Parameters:

module_name (str) – The name of the module to register.