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 collection of cache storage backends for the application.

Method __post_init__ Validate and convert store configuration attributes after init.
Method __validateFile Validate and convert the file store attribute.
Method __validateOptional Validate and optionally convert an optional store attribute.
Instance Variable database Database-backed cache storage configuration. Defaults to None.
Instance Variable file File-based cache storage configuration.
Instance Variable memcached Memcached cache storage configuration. Defaults to None.
Instance Variable memory In-memory cache storage configuration. Defaults to None.
Instance Variable redis Redis cache storage configuration. Defaults to None.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
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
def __post_init__(self): (source)

Validate and convert store configuration attributes after init.

Returns
NoneValidates all store fields and converts dicts to typed instances.
Raises
TypeErrorIf any store attribute is not of the expected type.
def __validateFile(self): (source)

Validate and convert the file store attribute.

Returns
NoneConverts a dict to a File instance via object.__setattr__.
Raises
TypeErrorIf file is not a File instance or a dict.
def __validateOptional(self, name: str, cls: type): (source)

Validate and optionally convert an optional store attribute.

Parameters
name:strName of the attribute to validate on this instance.
cls:typeExpected concrete type for the attribute value.
Returns
NoneConverts a dict value to a cls instance via object.__setattr__ when applicable.
Raises
TypeErrorIf the attribute value is not an instance of cls, a dict, or None.
database: Database | dict | None = (source)

Database-backed cache storage configuration. Defaults to None.

file: File | dict = (source)

File-based cache storage configuration.

memcached: Memcached | dict | None = (source)

Memcached cache storage configuration. Defaults to None.

memory: Memory | dict | None = (source)

In-memory cache storage configuration. Defaults to None.

redis: Redis | dict | None = (source)

Redis cache storage configuration. Defaults to None.