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.
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 __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 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: 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.
database: orionis.foundation.config.cache.Database | dict | None = (source)

Database-backed cache storage configuration. Defaults to None.

file: orionis.foundation.config.cache.File | dict = (source)

File-based cache storage configuration.

memcached: orionis.foundation.config.cache.Memcached | dict | None = (source)

Memcached cache storage configuration. Defaults to None.

memory: orionis.foundation.config.cache.Memory | dict | None = (source)

In-memory cache storage configuration. Defaults to None.

redis: orionis.foundation.config.cache.Redis | dict | None = (source)

Redis cache storage configuration. Defaults to None.