orionis.console.commands.schedule.work.ScheduleWorkCommand

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 ScheduleWorkCommand(BaseCommand): (source)

Method	`__registerListeners`	Register the application's available scheduler event callbacks.
Async Method	`__shutdownSchedule`	Request graceful shutdown and wait until it completes.
Method	`__startPanel`	Display a formatted scheduler start message on the console.
Async Method	`handle`	Run the application's scheduled tasks worker.
Class Variable	`description`	Undocumented
Class Variable	`signature`	Undocumented
Class Variable	`timestamps`	Undocumented

def __registerListeners(self, scheduler: object, schedule_service: ISchedule): (source) ¶

Parameters
scheduler:`object`	Application scheduler that may define event callbacks.
schedule_service:`ISchedule`	Schedule service receiving the callbacks.

Returns
`None`	The callbacks are registered on the schedule service.

async def __shutdownSchedule(self, schedule_service: ISchedule): (source) ¶

Request graceful shutdown and wait until it completes.

Parameters
schedule_service:`ISchedule`	Scheduler service to shut down.

Returns
`None`	The scheduler service has completed its shutdown sequence.

def __startPanel(self, console: Console): (source) ¶

Display a formatted scheduler start message on the console.

Parameters
console:`Console`	Rich console used to display the startup message.

Returns
`None`	The startup information is printed to the console.

async def handle(self, app: IApplication, console: Console) -> int | None: (source) ¶

Run the application's scheduled tasks worker.

Parameters
app:`IApplication`	Application instance for configuration and service resolution.
console:`Console`	Rich console used to display scheduler startup information.

Returns
`int \| None`	One when the configured backend is unavailable, otherwise None.

Undocumented

Undocumented

Undocumented