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.

package documentation

Group the cache components and public imports.

Module cache_manager Resolve configured cache stores and reuse their repositories.
Package contracts Group the cache contracts components and public imports.
Module exceptions Provide cache operations through CacheException, CacheStoreException.
Module file_based_cache Persist named cache entries in a filesystem directory.
Package locks Group the cache locks components and public imports.
Module provider Service provider for the Orionis cache system.
Module repository Async cache repository backed by a configurable storage backend.
Module serializer Encode and decode cache values with the configured serialization format.
Package serializers Group the cache serializers components and public imports.
Package stores Group the cache stores components and public imports.

From __init__.py:

Class CacheManager Resolve configured cache stores and reuse their repositories.
Class CacheRepository Async cache repository backed by a configurable storage backend.
Class FileBasedCache Persist named cache entries in a filesystem directory.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'CacheManager': ('orionis.cache.cache_manager', 'CacheManager'),
 'CacheRepository': ('orionis.cache.repository', 'CacheRepository'),
 'FileBasedCache': ('orionis.cache.file_based_cache', 'FileBasedCache')}