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 the configuration entity for a Redis job store.

Method __post_init__ Validate the Redis job store configuration after initialization.
Method __validateDriver Validate the driver property.
Method __validateHost Validate the host property.
Method __validateKey Validate the key property.
Method __validateRunTimesKey Validate the run_times_key property.
Class Variable password Account password subject to the declared validation constraints.
Instance Variable db Redis database index. Defaults to 0.
Instance Variable driver The driver type. Defaults to 'redis'.
Instance Variable host Redis host address. Defaults to '127.0.0.1'.
Instance Variable key Redis key used to store the serialized job definitions. Defaults to 'scheduler:tasks'.
Instance Variable port Redis port number. Defaults to 6379.
Instance Variable run_times_key Redis key used to store the next-run-time index for scheduled jobs. Defaults to 'scheduler:run_times'.

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

Validate the Redis job store configuration after initialization.

Returns
NoneValidates every field against its declared type hint.
Raises
TypeErrorIf any property does not match its expected type.
ValueErrorIf any property fails its value validation.
def __validateDriver(self: Self): (source)

Validate the driver property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf driver is not a string.
ValueErrorIf driver is an empty string.
def __validateHost(self: Self): (source)

Validate the host property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf host is not a string.
ValueErrorIf host is an empty string.
def __validateKey(self: Self): (source)

Validate the key property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf key is not a string.
ValueErrorIf key is an empty string.
def __validateRunTimesKey(self: Self): (source)

Validate the run_times_key property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf run_times_key is not a string.
ValueErrorIf run_times_key is an empty string.
password: str | None = (source)

Account password subject to the declared validation constraints.

Redis database index. Defaults to 0.

The driver type. Defaults to 'redis'.

Redis host address. Defaults to '127.0.0.1'.

Redis key used to store the serialized job definitions. Defaults to 'scheduler:tasks'.

Redis port number. Defaults to 6379.

run_times_key: str = (source)

Redis key used to store the next-run-time index for scheduled jobs. Defaults to 'scheduler:run_times'.