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 cache configuration for the application.

Method __post_init__ Validate and normalize the cache configuration after initialization.
Instance Variable default The default cache storage type. Accepts a Drivers enum member or a plain string (e.g. 'memory', 'file'). Resolved from the CACHE_STORE environment variable or Drivers.FILE.value.
Instance Variable prefix Global key prefix applied to all cache entries. Resolved from the CACHE_PREFIX environment variable or 'orionis'.
Instance Variable stores Configuration for the available cache stores. Defaults to a Stores instance backed by a file store.

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)

Validate and normalize the cache configuration after initialization.

Returns
NoneModifies instance attributes in place via object.__setattr__.
Raises
TypeErrorIf prefix is not a str, default is not a Drivers enum or str, or stores is not a Stores instance or dict.
ValueErrorIf default is a string that does not match any valid driver.
default: orionis.foundation.config.cache.Drivers | str = (source)

The default cache storage type. Accepts a Drivers enum member or a plain string (e.g. 'memory', 'file'). Resolved from the CACHE_STORE environment variable or Drivers.FILE.value.

Global key prefix applied to all cache entries. Resolved from the CACHE_PREFIX environment variable or 'orionis'.

stores: orionis.foundation.config.cache.Stores | dict = (source)

Configuration for the available cache stores. Defaults to a Stores instance backed by a file store.