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 cache store.

Method __post_init__ Validate the Redis configuration after initialization.
Method __validateDriver Validate the driver property.
Method __validateEndpoint Validate the endpoint property.
Method __validatePassword Validate the password property.
Instance Variable db Redis database index. Resolved from the REDIS_DB environment variable or defaults to 0.
Instance Variable driver The driver type. Defaults to 'redis'.
Instance Variable endpoint Redis host address. Resolved from the REDIS_HOST environment variable or defaults to '127.0.0.1'.
Instance Variable password Redis password. Resolved from the REDIS_PASSWORD environment variable or defaults to None.
Instance Variable port Redis port number. Resolved from the REDIS_PORT environment variable or defaults to 6379.

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

Validate the endpoint property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf endpoint is neither a string nor None.
def __validatePassword(self: Self): (source)

Validate the password property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf password is neither a string nor None.

Redis database index. Resolved from the REDIS_DB environment variable or defaults to 0.

The driver type. Defaults to 'redis'.

endpoint: str | None = (source)

Redis host address. Resolved from the REDIS_HOST environment variable or defaults to '127.0.0.1'.

password: str | None = (source)

Redis password. Resolved from the REDIS_PASSWORD environment variable or defaults to None.

Redis port number. Resolved from the REDIS_PORT environment variable or defaults to 6379.