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)
Register and run the application's scheduled tasks.
| Method | __register |
Register the application's available scheduler event callbacks. |
| Async Method | __shutdown |
Request graceful shutdown and wait until it completes. |
| Method | __start |
Display a formatted scheduler start message on the console. |
| Async Method | handle |
Run the application's scheduled tasks worker. |
| Class Variable | description |
Command description. |
| Class Variable | signature |
Command signature and description. |
| Class Variable | timestamps |
Indicates whether timestamps will be shown in the command output. |
Register the application's available scheduler event callbacks.
| Parameters | |
scheduler:object | Application scheduler that may define event callbacks. |
scheduleorionis.console.contracts.ISchedule | Schedule service receiving the callbacks. |
| Returns | |
None | The callbacks are registered on the schedule service. |
Request graceful shutdown and wait until it completes.
| Parameters | |
scheduleorionis.console.contracts.ISchedule | Scheduler service to shut down. |
| Returns | |
None | The scheduler service has completed its shutdown sequence. |
Display a formatted scheduler start message on the console.
| Parameters | |
console:orionis.console.Console | Rich console used to display the startup message. |
| Returns | |
None | The startup information is printed to the console. |
Run the application's scheduled tasks worker.
| Parameters | |
app:orionis.IApplication | Application instance for configuration and service resolution. |
console:orionis.console.Console | Rich console used to display scheduler startup information. |
| Returns | |
int | None | One when the configured backend is unavailable, otherwise None. |