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.

class documentation

Represent a scheduler event entity.

Method __post_init__ Initialize the SchedulerEvent instance after dataclass construction.
Instance Variable code Unique identifier code for the scheduler event.
Instance Variable description Description of the scheduler event. Defaults to an empty string.
Instance Variable jobstore Storage backend for the scheduler job. Defaults to "memory".

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Initialize the SchedulerEvent instance after dataclass construction.

Maps the event code to a descriptive message and sets the description attribute accordingly. Calls the parent class's __post_init__ method.

Returns
NoneThis method modifies the instance in place and returns None.

Unique identifier code for the scheduler event.

description: str, optional = (source)

Description of the scheduler event. Defaults to an empty string.

jobstore: str, optional = (source)

Storage backend for the scheduler job. Defaults to "memory".