ORIONIS API REFERENCE

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.

Explore modules View classes

orionis.console.entities.Task

class documentation

class Task(BaseEntity): (source)

View In Hierarchy

Represent a scheduled event and configure its execution and timing.

Parameters
signatureUnique identifier for the event.
argsArguments to be passed to the event. Defaults to empty list.
kwargsKeyword arguments to be passed to the event. Defaults to empty dict.
purposeDescription of the event's purpose.
random_delayRandom delay in seconds before triggering.
start_dateDate and time when the event becomes active.
end_dateDate and time when the event becomes inactive.
triggerTrigger mechanism for event execution.
detailsAdditional metadata about the event.
max_instancesMaximum concurrent instances allowed. Defaults to 1.
misfire_grace_timeGrace period in seconds for misfired events.
coalesceWhether to coalesce missed runs into a single run. Defaults to True.
listenersListeners for event-specific logic. Defaults to empty list.
Returns
TaskInstance of Task with specified configuration.
Class Variable args Undocumented
Class Variable coalesce Undocumented
Class Variable details Undocumented
Class Variable end_date Undocumented
Class Variable kwargs Undocumented
Class Variable listeners Undocumented
Class Variable max_instances Undocumented
Class Variable misfire_grace_time Undocumented
Class Variable purpose Undocumented
Class Variable random_delay Undocumented
Class Variable signature Undocumented
Class Variable start_date Undocumented
Class Variable trigger Undocumented

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __post_init__ Provide a no-op initialization hook for subclass validation.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
args: list[str] | None, optional = (source)

Undocumented

coalesce: bool, optional = (source)

Undocumented

details: str | None, optional = (source)

Undocumented

end_date: datetime | None, optional = (source)

Undocumented

kwargs: dict | None, optional = (source)

Undocumented

listeners: list[Callable[..., None]], optional = (source)

Undocumented

max_instances: int, optional = (source)

Undocumented

misfire_grace_time: int | None, optional = (source)

Undocumented

purpose: str | None, optional = (source)

Undocumented

random_delay: int | None, optional = (source)

Undocumented

signature: str = (source)

Undocumented

start_date: datetime | None, optional = (source)

Undocumented

trigger: CronTrigger | DateTrigger | IntervalTrigger | None, optional = (source)

Undocumented