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.
Undocumented
| Method | coalesce |
Set the coalesce behavior for missed task executions. |
| Method | cron |
Schedule the task using a CRON-like expression. |
| Method | daily |
Schedule the task to run once per day. |
| Method | daily |
Schedule the task to run daily at a specific hour, minute, and second. |
| Method | end |
Set the end date for task execution. |
| Method | entity |
Create and return a TaskEntity instance from the current Task. |
| Method | every |
Configure the event to run at a custom interval. |
| Method | every |
Schedule to run at fixed intervals measured in days. |
| Method | every |
Schedule to run every N days at a specific hour, minute, and second. |
| Method | every |
Schedule to run every eight hours. |
| Method | every |
Schedule to run every eight hours at a specific minute and second. |
| Method | every |
Schedule to run every eleven hours. |
| Method | every |
Schedule to run every eleven hours at a specific minute and second. |
| Method | every |
Schedule the task to run at every even hour of the day. |
| Method | every |
Schedule the task to run every fifteen minutes. |
| Method | every |
Schedule to run every fifteen minutes at a specific second. |
| Method | every |
Schedule the task to run every fifteen seconds. |
| Method | every |
Schedule the task to run every fifty-five minutes. |
| Method | every |
Schedule the task to run every fifty-five minutes at a specific second. |
| Method | every |
Schedule the task to run every fifty-five seconds. |
| Method | every |
Schedule to run every fifty minutes. |
| Method | every |
Schedule to run every fifty minutes at a specific second. |
| Method | every |
Schedule the task to run every fifty seconds. |
| Method | every |
Schedule to run every five days. |
| Method | every |
Schedule event to run every five days at a specific hour, minute, and second. |
| Method | every |
Schedule the task to run every five hours. |
| Method | every |
Schedule to run every five hours at a specific minute and second. |
| Method | every |
Schedule the task to run every five minutes. |
| Method | every |
Schedule the task to run every five minutes at a specific second. |
| Method | every |
Schedule the task to run every five seconds. |
| Method | every |
Schedule the task to run every forty-five minutes. |
| Method | every |
Schedule the task to run every forty-five minutes at a specific second. |
| Method | every |
Schedule the task to run every forty-five seconds. |
| Method | every |
Schedule the task to run every forty minutes. |
| Method | every |
Schedule to run every forty minutes at a specific second. |
| Method | every |
Schedule the task to run every forty seconds. |
| Method | every |
Schedule to run every four days. |
| Method | every |
Schedule to run every four days at a specific hour, minute, and second. |
| Method | every |
Schedule the task to run every four hours. |
| Method | every |
Schedule to run every four hours at a specific minute and second. |
| Method | every |
Schedule the task to run every Friday at a specific hour, minute, and second. |
| Method | every |
Schedule the task to run at fixed intervals in hours. |
| Method | every |
Schedule the task to run every N hours at a specific minute and second. |
| Method | every |
Schedule the task to run every minute at a specific second. |
| Method | every |
Schedule the task to run at fixed intervals in minutes. |
| Method | every |
Schedule to run at a specific second of every N-minute interval. |
| Method | every |
Schedule event to run every Monday at a specific hour, minute, and second. |
| Method | every |
Schedule to run every nine hours. |
| Method | every |
Schedule to run every nine hours at a specific minute and second. |
| Method | every |
Schedule the task to run at every odd hour of the day. |
| Method | every |
Schedule the task to run every Saturday at a specific hour, minute, and second. |
| Method | every |
Schedule the task to run at fixed intervals in seconds. |
| Method | every |
Schedule the task to run every seven days. |
| Method | every |
Schedule event to run every seven days at a specific hour, minute, and second. |
| Method | every |
Schedule to run every seven hours. |
| Method | every |
Schedule to run every seven hours at a specific minute and second. |
| Method | every |
Schedule the task to run every six days. |
| Method | every |
Schedule event to run every six days at a specific hour, minute, and second. |
| Method | every |
Schedule to run every six hours. |
| Method | every |
Schedule to run every six hours at a specific minute and second. |
| Method | every |
Schedule the task to run every Sunday at a specific hour, minute, and second. |
| Method | every |
Schedule to run every ten hours. |
| Method | every |
Schedule to run every ten hours at a specific minute and second. |
| Method | every |
Schedule to run every ten minutes. |
| Method | every |
Schedule to run every ten minutes at a specific second. |
| Method | every |
Schedule the task to run every ten seconds. |
| Method | every |
Schedule to run every thirty-five minutes. |
| Method | every |
Schedule to run every 35 minutes at a specific second. |
| Method | every |
Schedule the task to run every thirty-five seconds. |
| Method | every |
Schedule the task to run every thirty minutes. |
| Method | every |
Schedule to run every thirty minutes at a specific second. |
| Method | every |
Schedule the task to run every thirty seconds. |
| Method | every |
Schedule to run every three days. |
| Method | every |
Schedule to run every three days at a specific hour, minute, and second. |
| Method | every |
Schedule the task to run every three hours. |
| Method | every |
Schedule to run every three hours at a specific minute and second. |
| Method | every |
Schedule event to run every Thursday at a specific hour, minute, and second. |
| Method | every |
Schedule event to run every Tuesday at a specific hour, minute, and second. |
| Method | every |
Schedule to run every twelve hours. |
| Method | every |
Schedule to run every twelve hours at a specific minute and second. |
| Method | every |
Schedule the task to run every twenty-five minutes. |
| Method | every |
Schedule to run every twenty-five minutes at a specific second. |
| Method | every |
Schedule the task to run every twenty-five seconds. |
| Method | every |
Schedule to run every twenty minutes. |
| Method | every |
Schedule to run every twenty minutes at a specific second. |
| Method | every |
Schedule the task to run every twenty seconds. |
| Method | every |
Schedule to run every two days. |
| Method | every |
Schedule to run every two days at a specific hour, minute, and second. |
| Method | every |
Schedule the task to run every two hours. |
| Method | every |
Schedule to run every two hours at a specific minute and second. |
| Method | every |
Schedule event to run every Wednesday at a specific hour, minute, and second. |
| Method | every |
Configure the event to run at fixed intervals measured in weeks. |
| Method | hourly |
Schedule the task to run every hour. |
| Method | hourly |
Schedule the task to run every hour at a specific minute and second. |
| Method | max |
Set the maximum number of concurrent task instances. |
| Method | misfire |
Set the misfire grace time in seconds. |
| Method | on |
Register a callback for a specific task event. |
| Method | once |
Schedule the task to execute once at a specific date and time. |
| Method | purpose |
Set the purpose or description for the scheduled command. |
| Method | random |
Configure a random delay before task execution. |
| Method | register |
Register a task listener for task events. |
| Method | start |
Set the start date for task execution. |
| Method | weekly |
Schedule the task to run every week. |
str | None = None, month: str | None = None, day: str | None = None, week: str | None = None, day_of_week: str | None = None, hour: str | None = None, minute: str | None = None, second: str | None = None) -> bool:
(source)
¶
orionis.console.fluent.TaskSchedule the task using a CRON-like expression.
This method configures the event to execute according to cron rules, allowing highly customizable schedules (e.g., every Monday at 8am).
| Parameters | |
year:str | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
month:str | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
day:str | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
week:str | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
daystr | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
hour:str | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
minute:str | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
second:str | None | Cron-like expressions defining when the job should run. Examples: */5 (every 5 units), 1-5 (range), 0,15,30,45 (list). |
| Returns | |
bool | True if the cron scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule the task to run once per day.
Configure the event to execute daily at midnight using a CronTrigger.
Restrict the schedule with start_date and end_date if set.
Apply random delay (jitter) if configured.
| Returns | |
bool | Always returns True after configuring the daily schedule. |
orionis.console.fluent.TaskSchedule the task to run daily at a specific hour, minute, and second.
Validate input ranges for hour, minute, and second. Set up a CronTrigger for daily execution at the specified time. Store a description of the schedule.
| Parameters | |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
int, month: int, day: int, hour: int = 0, minute: int = 0, second: int = 0) -> ITask:
(source)
¶
orionis.console.fluent.TaskSet the end date for task execution.
| Parameters | |
year:int | The year component. |
month:int | The month component (1-12). |
day:int | The day component (1-31). |
hour:int, optional | The hour component (0-23). Default is 0. |
minute:int, optional | The minute component (0-59). Default is 0. |
second:int, optional | The second component (0-59). Default is 0. |
| Returns | |
Self | The current Task instance for method chaining. |
| Raises | |
TypeError | If any date component is not an integer. |
ValueError | If hour, minute, or second are outside their valid ranges. |
int | None = 0, max_instances: int | None = 1, misfire_grace_time: int | None = 0, *, coalesce: bool | None = True) -> TaskEntity:
(source)
¶
orionis.console.fluent.TaskCreate and return a TaskEntity instance from the current Task.
Collect all relevant attributes of the Task and encapsulate them in a TaskEntity object.
| Parameters | |
randomint | None, optional | Random delay in seconds before triggering. Defaults to 0. |
maxint | None, optional | Maximum concurrent instances allowed. Defaults to 1. |
misfireint | None, optional | Grace period in seconds for misfired events. Defaults to 0. |
coalesce:bool | None, optional | Whether to coalesce missed runs into a single run. Defaults to True. |
| Returns | |
TaskEntity | The TaskEntity instance containing the task's data. |
| Raises | |
ValueError | If signature or trigger is not set. |
int = 0, days: int = 0, hours: int = 0, minutes: int = 0, seconds: int = 0) -> bool:
(source)
¶
orionis.console.fluent.TaskConfigure the event to run at a custom interval.
Validates that all interval parameters are non-negative integers and that at least one is greater than zero. Sets up an IntervalTrigger with the specified intervals.
| Parameters | |
weeks:int, optional | Number of weeks between executions. Must be non-negative. Default is 0. |
days:int, optional | Number of days between executions. Must be non-negative. Default is 0. |
hours:int, optional | Number of hours between executions. Must be non-negative. Default is 0. |
minutes:int, optional | Number of minutes between executions. Must be non-negative. Default is 0. |
seconds:int, optional | Number of seconds between executions. Must be non-negative. Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
| Raises | |
ValueError | If any parameter is not a non-negative integer or if all are zero. |
orionis.console.fluent.TaskSchedule to run at fixed intervals measured in days.
Validates that days is a positive integer. Sets up an IntervalTrigger with
the specified interval in days, using any configured start and end dates, and
random delay (jitter) if set.
| Parameters | |
days:int | Value supplied for days. |
| Returns | |
bool | True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule to run every N days at a specific hour, minute, and second.
Validates input ranges for days, hour, minute, and second. Sets up a CronTrigger for the specified interval and time. Returns True if scheduling was configured.
| Parameters | |
days:int | Interval in days. Must be a positive integer. |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule to run every eight hours.
Delegate scheduling to everyHours with an interval of eight hours.
Return True if scheduling was configured.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every eight hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of eight hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule to run every eleven hours.
Delegates scheduling to everyHours with an interval of 11 hours.
Returns True if scheduling was configured.
| Returns | |
bool | True if scheduling was configured. |
orionis.console.fluent.TaskSchedule to run every eleven hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of 11 hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run at every even hour of the day.
Configure the event to execute at every even-numbered hour using a CronTrigger.
The schedule can be restricted by start_date and end_date. If a random delay
(jitter) is set, it is applied to the trigger.
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule the task to run every fifteen minutes.
Set up an interval trigger for execution every fifteen minutes. The schedule
can be limited by start_date and end_date. If a random delay (jitter) is
set, it is applied to the trigger.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every fifteen minutes at a specific second.
This method sets the event to execute at the given second (0-59) of every
fifteen-minute interval. The schedule can be limited by start_date and
end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Parameters | |
seconds:int | Second (0-59) of each fifteen-minute interval. |
| Returns | |
bool | Returns True if scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every fifteen seconds.
Configure the event to execute at a fixed interval of fifteen seconds using an
IntervalTrigger. The schedule can be restricted by start_date and end_date.
If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule the task to run every fifty-five minutes.
Configure the event to execute at a fixed interval of fifty-five minutes using
an IntervalTrigger. The schedule can be restricted by start_date and
end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule the task to run every fifty-five minutes at a specific second.
Notes
This method delegates scheduling to everyMinutesAt with an interval of
55 minutes and the specified second.
| Parameters | |
seconds:int | The specific second (0-59) of each fifty-five-minute interval at which the event should be executed. |
| Returns | |
bool | Return True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule the task to run every fifty-five seconds.
Configure the event to execute at a fixed interval of fifty-five seconds using
an IntervalTrigger. The scheduling window can be restricted by start_date
and end_date. If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every fifty minutes.
Configures the event to execute at a fixed interval of fifty minutes using an
IntervalTrigger. The schedule can be restricted by start_date and end_date.
If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule to run every fifty minutes at a specific second.
Configures the event to execute at the specified second (0-59) of every
fifty-minute interval. The scheduling window can be restricted by start_date
and end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Parameters | |
seconds:int | Specific second (0-59) of each fifty-minute interval. |
| Returns | |
bool | Returns True if scheduling is configured successfully. |
| Raises | |
ValueError | If seconds is not an integer between 0 and 59 (inclusive). |
orionis.console.fluent.TaskSchedule the task to run every fifty seconds.
Configure the event to execute at a fixed interval of fifty seconds using an
IntervalTrigger. The scheduling window can be restricted by start_date and
end_date. If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every five days.
Use the everyDays method with an interval of five days. The scheduling
window can be restricted by start_date and end_date. If a random delay
(jitter) is configured, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyDays. |
orionis.console.fluent.TaskSchedule event to run every five days at a specific hour, minute, and second.
Validate input ranges for hour, minute, and second. Delegate scheduling to
everyDaysAt with an interval of 5 days and the specified time.
| Parameters | |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every five hours.
Use the everyHours method with an interval of five hours. The schedule can be
restricted by start_date and end_date. If a random delay (jitter) is set, it
will be applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every five hours at a specific minute and second.
Validates input ranges for minute and second. Delegates scheduling to
everyHoursAt with an interval of five hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every five minutes.
Configures the event to execute at a fixed interval of five minutes using an
IntervalTrigger. The scheduling window can be restricted by start_date and
end_date. Applies random delay (jitter) if set.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule the task to run every five minutes at a specific second.
Set the event to execute at the specified second (0-59) of every five-minute
interval. The scheduling window can be restricted by start_date and
end_date. If a random delay (jitter) is configured, it will be applied.
| Parameters | |
seconds:int | Second (0-59) of each five-minute interval. |
| Returns | |
bool | True if scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every five seconds.
This method sets up the event to execute at a fixed interval of five seconds
using an IntervalTrigger. The scheduling window can be limited by the
start_date and end_date attributes if they are set. If a random delay
(jitter) is configured, it will be applied to the trigger.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule the task to run every forty-five minutes.
Configure the event to execute at a fixed interval of forty-five minutes using
an IntervalTrigger. The schedule can be restricted by start_date and
end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule the task to run every forty-five minutes at a specific second.
Set up the event to execute at the given second (0-59) of every forty-five-
minute interval. The schedule can be limited by start_date and end_date.
If a random delay (jitter) is set, it is applied to the trigger.
| Parameters | |
seconds:int | The second (0-59) of each forty-five-minute interval to execute the event. |
| Returns | |
bool | Returns True if the scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every forty-five seconds.
Configures the event to execute at a fixed interval of forty-five seconds using
an IntervalTrigger. The schedule can be limited by start_date and end_date.
If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule the task to run every forty minutes.
Configures the event to execute at a fixed interval of forty minutes using an
IntervalTrigger. The schedule can be restricted by start_date and end_date.
If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule to run every forty minutes at a specific second.
Configures the event to execute at the specified second (0-59) of every
forty-minute interval. The scheduling window can be restricted by start_date
and end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Parameters | |
seconds:int | The specific second (0-59) of each forty-minute interval. |
| Returns | |
bool | Returns True if scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every forty seconds.
Configure the event to execute at a fixed interval of forty seconds using an
IntervalTrigger. The schedule can be restricted by start_date and end_date.
If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every four days at a specific hour, minute, and second.
| Parameters | |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every four hours.
Use the everyHours method with an interval of four hours. The schedule can be
restricted by start_date and end_date. If a random delay (jitter) is set, it
will be applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every four hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of four hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every Friday at a specific hour, minute, and second.
Validates input ranges for hour, minute, and second. Sets up a CronTrigger for Fridays at the specified time. Stores a description of the schedule.
| Parameters | |
hour:int | Hour of the day (0-23). |
minute:int, optional | Minute of the hour (0-59). Default is 0. |
second:int, optional | Second of the minute (0-59). Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule the task to run at fixed intervals in hours.
Validate that hours is a positive integer. Set up an IntervalTrigger with the
specified interval in hours, using any configured start and end dates,
and random delay (jitter) if set.
| Parameters | |
hours:int | Value supplied for hours. |
| Returns | |
bool | True if the scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every N hours at a specific minute and second.
Validates input for hours, minute, and second. Sets up an IntervalTrigger with the specified interval and time.
| Parameters | |
hours:int | Interval in hours. Must be a positive integer. |
minute:int | Minute of the hour in [0, 59]. |
second:int, optional | Second of the minute in [0, 59]. Default is 0. |
| Returns | |
bool | True if scheduling was configured successfully. |
| Raises | |
ValueError | If any parameter is out of valid range or not an integer. |
orionis.console.fluent.TaskSchedule the task to run every minute at a specific second.
Validate that seconds is an integer in [0, 59]. Set a CronTrigger to execute
at the specified second of every minute. Ignore any previously set jitter.
Notes
The event will be triggered at the specified second of every minute.
| Parameters | |
seconds:int | The second (0-59) of each minute to execute the event. |
| Returns | |
bool | True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run at fixed intervals in minutes.
Validates that minutes is a positive integer. Sets an IntervalTrigger with
the specified interval, using any configured start_date, end_date, and
random delay (jitter) if set.
| Parameters | |
minutes:int | Interval in minutes. Must be a positive integer. |
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run at a specific second of every N-minute interval.
Validates input for minutes and seconds. Sets a CronTrigger to execute at the specified second of every N-minute interval. Returns True if scheduling is set.
| Parameters | |
minutes:int | Interval in minutes. Must be a positive integer. |
seconds:int | Second of the minute (0-59). |
| Returns | |
bool | True if scheduling was configured successfully. |
| Raises | |
ValueError | If minutes is not a positive integer or seconds is not in [0, 59]. |
orionis.console.fluent.TaskSchedule event to run every Monday at a specific hour, minute, and second.
Validates input ranges for hour, minute, and second. Sets up a CronTrigger for Mondays at the specified time. Stores a description of the schedule.
| Parameters | |
hour:int | Value supplied for hour. |
minute:int | Value supplied for minute. |
second:int | Value supplied for second. |
| Returns | |
bool | Returns True if the scheduling was successfully configured. |
| Raises | |
ValueError | If hour, minute, or second are not integers within their valid ranges. |
orionis.console.fluent.TaskSchedule to run every nine hours.
Delegates scheduling to everyHours with an interval of nine hours.
Returns True if scheduling was configured.
| Returns | |
bool | True if scheduling was configured. |
orionis.console.fluent.TaskSchedule to run every nine hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of nine hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run at every odd hour of the day.
Configure the event to execute at every odd-numbered hour using a CronTrigger.
The schedule can be restricted by start_date and end_date. If a random delay
(jitter) is set, it is applied to the trigger.
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule the task to run every Saturday at a specific hour, minute, and second.
Validate the input ranges for hour, minute, and second. Set up a CronTrigger for Saturdays at the specified time. Store a description of the schedule.
| Parameters | |
hour:int | Hour of the day (0-23). |
minute:int, optional | Minute of the hour (0-59). Default is 0. |
second:int, optional | Second of the minute (0-59). Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule the task to run at fixed intervals in seconds.
Validate that seconds is a positive integer. Set an IntervalTrigger to run
at the specified interval. If a random delay is set, raise an error. Return
True if scheduling is configured.
| Parameters | |
seconds:int | Interval in seconds. Must be a positive integer. |
| Returns | |
bool | True if scheduling was configured successfully. |
| Raises | |
ValueError | If seconds is not a positive integer or if random delay is set. |
orionis.console.fluent.TaskSchedule the task to run every seven days.
Use the everyDays method with an interval of seven days. The scheduling
window can be restricted by start_date and end_date. If a random delay
(jitter) is configured, it is applied to the trigger.
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule event to run every seven days at a specific hour, minute, and second.
Validate input ranges for hour, minute, and second. Delegate scheduling to
everyDaysAt with an interval of 7 days and the specified time.
| Parameters | |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule to run every seven hours.
Use everyHours with an interval of seven hours. Restrict schedule with
start_date and end_date if set. Apply random delay (jitter) if configured.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every seven hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of seven hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every six days.
Use the everyDays method with an interval of six days. The scheduling window
can be restricted by start_date and end_date. If a random delay (jitter) is
configured, it is applied to the trigger.
| Returns | |
bool | Returns True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule event to run every six days at a specific hour, minute, and second.
Validate input ranges for hour, minute, and second. Delegate scheduling to
everyDaysAt with an interval of 6 days and the specified time.
| Parameters | |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule to run every six hours.
Delegates scheduling to everyHours with an interval of six hours.
Returns True if scheduling was configured.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every six hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of six hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every Sunday at a specific hour, minute, and second.
Validate input ranges for hour, minute, and second. Set up a CronTrigger for Sundays at the specified time. Store a description of the schedule.
| Parameters | |
hour:int | Hour of the day (0-23). |
minute:int, optional | Minute of the hour (0-59). Default is 0. |
second:int, optional | Second of the minute (0-59). Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule to run every ten hours.
Delegate scheduling to everyHours with an interval of ten hours.
The scheduling window can be restricted by start_date and end_date.
Applies random delay (jitter) if configured.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every ten hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of ten hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule to run every ten minutes.
Configures the event to execute at a fixed interval of ten minutes using an
IntervalTrigger. The scheduling window can be restricted by start_date and
end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every ten minutes at a specific second.
Configures the event to execute at the specified second (0-59) of every
ten-minute interval. Ignores any previously set random delay (jitter).
The scheduling window can be restricted by start_date and end_date.
| Parameters | |
seconds:int | The second (0-59) of each ten-minute interval to execute the event. |
| Returns | |
bool | Returns True if scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every ten seconds.
Configure the event to execute at a fixed interval of ten seconds using an
IntervalTrigger. The schedule can be limited by start_date and end_date.
If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every thirty-five minutes.
This method sets the event to execute at a fixed interval of thirty-five minutes
using an IntervalTrigger. The schedule can be limited by start_date and
end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule to run every 35 minutes at a specific second.
Notes
The event is triggered at the specified second of every 35-minute interval.
| Parameters | |
seconds:int | Second (0-59) of each 35-minute interval to execute the event. |
| Returns | |
bool | Return True if scheduling is configured successfully. |
| Raises | |
ValueError | If seconds is not an integer between 0 and 59 (inclusive). |
orionis.console.fluent.TaskSchedule the task to run every thirty-five seconds.
Configures the event to execute at a fixed interval of thirty-five seconds
using an IntervalTrigger. The schedule can be restricted by start_date
and end_date. If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Returns True after configuring the interval trigger for execution every thirty-five seconds. |
orionis.console.fluent.TaskSchedule the task to run every thirty minutes.
Configures the event to execute at a fixed interval of thirty minutes using an
IntervalTrigger. The schedule can be restricted by start_date and end_date.
If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule to run every thirty minutes at a specific second.
Configures the event to execute at the given second (0-59) of every
thirty-minute interval. The schedule can be restricted by start_date
and end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Parameters | |
seconds:int | Second of each thirty-minute interval to execute the event. |
| Returns | |
bool | Returns True if scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every thirty seconds.
Configures the event to execute at a fixed interval of thirty seconds using an
IntervalTrigger. The schedule can be limited by start_date and end_date.
If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every three days at a specific hour, minute, and second.
Validates input ranges for hour, minute, and second. Delegates scheduling to
everyDaysAt with an interval of 3 days and the specified time.
| Parameters | |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every three hours.
Use the everyHours method with an interval of three hours. The schedule can be
restricted by start_date and end_date. If a random delay (jitter) is set, it
will be applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every three hours at a specific minute and second.
Set up the event to execute every three hours at the given minute and second.
The schedule can be limited by start_date and end_date. Jitter is not used.
| Parameters | |
minute:int | Minute of the hour in [0, 59]. |
second:int, optional | Second of the minute in [0, 59]. Default is 0. |
| Returns | |
bool | True if scheduling is configured successfully. |
| Raises | |
ValueError | If minute or second are not integers in valid ranges. |
orionis.console.fluent.TaskSchedule event to run every Thursday at a specific hour, minute, and second.
Validates input ranges for hour, minute, and second. Sets up a CronTrigger for Thursdays at the specified time. Stores a description of the schedule.
| Parameters | |
hour:int | Hour of the day (0-23). |
minute:int, optional | Minute of the hour (0-59). Default is 0. |
second:int, optional | Second of the minute (0-59). Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule event to run every Tuesday at a specific hour, minute, and second.
Validates input ranges for hour, minute, and second. Sets up a CronTrigger for Tuesdays at the specified time. Stores a description of the schedule.
| Parameters | |
hour:int | Hour of the day (0-23). |
minute:int, optional | Minute of the hour (0-59). Default is 0. |
second:int, optional | Second of the minute (0-59). Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskSchedule to run every twelve hours.
Delegates scheduling to everyHours with an interval of 12 hours.
The scheduling window can be restricted by start_date and end_date.
Applies random delay (jitter) if configured.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every twelve hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of 12 hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every twenty-five minutes.
Configures the event to execute at a fixed interval of twenty-five minutes
using an IntervalTrigger. The scheduling window can be restricted by
start_date and end_date. If a random delay (jitter) is set, it is
applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule to run every twenty-five minutes at a specific second.
Set up the event to execute at the given second (0-59) of every twenty-five-
minute interval. The schedule can be limited by start_date and end_date.
| Parameters | |
seconds:int | Second (0-59) of each twenty-five-minute interval. |
| Returns | |
bool | Returns True if scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every twenty-five seconds.
Configure the event to execute at a fixed interval of twenty-five seconds using
an IntervalTrigger. The schedule can be restricted by start_date and
end_date. If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every twenty minutes.
This method sets the event to execute at a fixed interval of twenty minutes
using an IntervalTrigger. The schedule can be limited by start_date and
end_date. If a random delay (jitter) is set, it is applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyMinute. |
orionis.console.fluent.TaskSchedule to run every twenty minutes at a specific second.
Configures the event to execute at the specified second (0-59) of every
twenty-minute interval. The schedule can be restricted by start_date
and end_date. If a random delay (jitter) is set, it is applied to the
trigger.
| Parameters | |
seconds:int | Second (0-59) of each twenty-minute interval. |
| Returns | |
bool | Returns True if scheduling is configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every twenty seconds.
Configures the event to execute at a fixed interval of twenty seconds using an
IntervalTrigger. The schedule can be restricted by start_date and end_date.
If a random delay (jitter) is set, it is not applied.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule to run every two days at a specific hour, minute, and second.
Validate input ranges for hour, minute, and second. Delegate scheduling to
everyDaysAt with an interval of 2 days and the specified time.
| Parameters | |
hour:int | Hour of the day in range [0, 23]. |
minute:int, optional | Minute of the hour in range [0, 59]. Default is 0. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | Returns True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule the task to run every two hours.
Use the everyHours method with an interval of two hours. The schedule can be
restricted by start_date and end_date. If a random delay (jitter) is set,
it will be applied to the trigger.
| Returns | |
bool | Always returns True after delegating scheduling to everyHours. |
orionis.console.fluent.TaskSchedule to run every two hours at a specific minute and second.
Validate input ranges for minute and second. Delegate scheduling to
everyHoursAt with an interval of two hours and the specified time.
| Parameters | |
minute:int | Minute of the hour in range [0, 59]. |
second:int, optional | Second of the minute in range [0, 59]. Default is 0. |
| Returns | |
bool | True if scheduling was configured successfully. |
orionis.console.fluent.TaskSchedule event to run every Wednesday at a specific hour, minute, and second.
Validates input ranges for hour, minute, and second. Sets up a CronTrigger for Wednesdays at the specified time. Stores a description of the schedule.
| Parameters | |
hour:int | Hour of the day (0-23). |
minute:int, optional | Minute of the hour (0-59). Default is 0. |
second:int, optional | Second of the minute (0-59). Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
orionis.console.fluent.TaskConfigure the event to run at fixed intervals measured in weeks.
Validates that the weeks parameter is a positive integer. Sets up an
IntervalTrigger with the specified interval in weeks. Returns True if
the scheduling was successfully configured.
| Parameters | |
weeks:int | Number of weeks between executions. Must be a positive integer. |
| Returns | |
bool | True if the scheduling was successfully configured. |
| Raises | |
ValueError | If weeks is not a positive integer. |
orionis.console.fluent.TaskSchedule the task to run every hour.
Configure the event to execute once every hour. The schedule starts from
start_date and ends at end_date if set. If a random delay (jitter) is
configured, it is applied to the trigger. The event is triggered at regular
hourly intervals.
| Returns | |
bool | Always returns True after configuring the interval trigger. |
orionis.console.fluent.TaskSchedule the task to run every hour at a specific minute and second.
Validate that minute and second are integers within valid ranges. Set up
an IntervalTrigger to execute the event every hour at the specified minute and
second. Store a human-readable description of the schedule.
| Parameters | |
minute:int | Minute of the hour in the range [0, 59]. |
second:int, optional | Second of the minute in the range [0, 59]. Default is 0. |
| Returns | |
bool | True if the scheduling was successfully configured. |
| Raises | |
ValueError | If minute or second are not integers in valid ranges. |
orionis.console.fluent.TaskSet the misfire grace time in seconds.
| Parameters | |
seconds:int, optional | Number of seconds for the misfire grace period. Must be a positive integer greater than zero. Default is 60. |
| Returns | |
Task | This instance for method chaining. |
| Raises | |
ValueError | If seconds is not a positive integer. |
orionis.console.fluent.TaskRegister a callback for a specific task event.
| Parameters | |
event:TaskEventListener | The event type to listen for. |
callback:Callable | The function to call when the event occurs. |
| Returns | |
Task | The current Task instance for method chaining. |
| Raises | |
ValueError | If event is not a TaskEventListener or callback is not callable. |
int, month: int, day: int, hour: int = 0, minute: int = 0, second: int = 0) -> bool:
(source)
¶
orionis.console.fluent.TaskSchedule the task to execute once at a specific date and time.
Configure the task to run a single time at the specified date and time using the provided year, month, day, hour, minute, and second values. This sets both start and end dates to the specified datetime and uses a DateTrigger for one-time execution.
| Parameters | |
year:int | The year component. |
month:int | The month component (1-12). |
day:int | The day component (1-31). |
hour:int, optional | The hour component (0-23). Default is 0. |
minute:int, optional | The minute component (0-59). Default is 0. |
second:int, optional | The second component (0-59). Default is 0. |
| Returns | |
bool | True if the scheduling was configured successfully. |
| Raises | |
ValueError | If random delay is set or if date components are invalid. |
TypeError | If any date component is not an integer. |
orionis.console.fluent.TaskSet the purpose or description for the scheduled command.
| Parameters | |
purpose:str | Purpose or description to associate with the scheduled command. Must be a non-empty string. |
| Returns | |
Task | The current instance for method chaining. |
| Raises | |
ValueError | If the purpose is not a non-empty string. |
orionis.console.fluent.TaskConfigure a random delay before task execution.
| Parameters | |
maxint, optional | Maximum delay in seconds before execution. Must be between 0 and 120. Default is 10. |
| Returns | |
Task | The current Task instance for method chaining. |
| Raises | |
ValueError | If max_seconds is not an integer in [0, 120]. |
orionis.console.fluent.TaskRegister a task listener for task events.
| Parameters | |
listener:BaseTaskListener | Listener instance implementing the BaseTaskListener interface. |
| Returns | |
Self | The current Task instance for method chaining. |
| Raises | |
TypeError | If the listener does not implement BaseTaskListener. |
int, month: int, day: int, hour: int = 0, minute: int = 0, second: int = 0) -> ITask:
(source)
¶
orionis.console.fluent.TaskSet the start date for task execution.
| Parameters | |
year:int | The year component. |
month:int | The month component (1-12). |
day:int | The day component (1-31). |
hour:int, optional | The hour component (0-23). Default is 0. |
minute:int, optional | The minute component (0-59). Default is 0. |
second:int, optional | The second component (0-59). Default is 0. |
| Returns | |
Self | The current Task instance for method chaining. |
| Raises | |
TypeError | If any date component is not an integer. |
ValueError | If hour, minute, or second are outside their valid ranges. |
orionis.console.fluent.TaskSchedule the task to run every week.
Configure the event to execute once per week on Sunday at 00:00:00. The schedule
can be restricted by start_date and end_date. If a random delay (jitter) is
configured, it is applied to the trigger.
| Returns | |
bool | True if the scheduling was successfully configured. |