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

Method __post_init__ Validate and initialise the path attribute after dataclass init.
Instance Variable driver The driver type for the cache store. Defaults to 'file'.
Instance Variable path The filesystem path where cache data will be stored. Defaults to 'storage/framework/cache/data'.

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 initialise the path attribute after dataclass init.

Ensure path is a non-empty string. The selected cache driver creates the backing directory when it is initialized.

Returns
NoneValidate the configuration without changing the filesystem.
Raises
TypeErrorIf path is not a str.
ValueErrorIf path is an empty string.

The driver type for the cache store. Defaults to 'file'.

The filesystem path where cache data will be stored. Defaults to 'storage/framework/cache/data'.