orionis.foundation.config.cache.Cache

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.

Explore modules View classes

class documentation

class Cache(BaseEntity): (source)

View In Hierarchy

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	`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) ¶

overrides orionis.support.entities.BaseEntity.__post_init__

Validate and normalize the cache configuration after initialization.

Returns
`None`	Modifies instance attributes in place via `object.__setattr__`.

Raises
`TypeError`	If `prefix` is not a `str`, `default` is not a `Drivers` enum or `str`, or `stores` is not a `Stores` instance or `dict`.
`ValueError`	If `default` is a string that does not match any valid driver.

default: 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.

prefix: str = (source) ¶

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

stores: Stores | dict = (source) ¶

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