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 application configuration settings.

Method __post_init__ Validate application options and normalize their values.
Method __validateKey Validate and normalize the encryption key for cipher consumers.
Instance Variable cipher The authenticated cipher used for encryption. Default is 'AES-256-GCM'.
Instance Variable debug Whether debug mode is enabled. Default is True.
Instance Variable env The environment in which the application is running. Default is 'DEVELOPMENT'.
Instance Variable fallback_locale The locale used when a translation is missing. Default is 'en'.
Instance Variable key The encryption key, normalized to bytes. None generates a persistent key.
Instance Variable language_path Relative path to the JSON translation files. Default is 'resources/lang/'.
Instance Variable locale The locale for the application. Default is 'en'.
Instance Variable maintenance Whether maintenance mode is enabled. Default is False.
Instance Variable name The name of the application. Default is 'Orionis Application'.
Instance Variable timezone The timezone of the application. Default is 'UTC'.

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 application options and normalize their values.

Returns
NoneNo return value.
Raises
ValueErrorIf the cipher is not authenticated or another setting is invalid.
def __validateKey(self): (source)

Validate and normalize the encryption key for cipher consumers.

Returns
NoneNo return value.
cipher: str | orionis.foundation.config.app.Cipher, optional = (source)

The authenticated cipher used for encryption. Default is 'AES-256-GCM'.

debug: bool, optional = (source)

Whether debug mode is enabled. Default is True.

env: str | orionis.foundation.config.app.Environments, optional = (source)

The environment in which the application is running. Default is 'DEVELOPMENT'.

fallback_locale: str, optional = (source)

The locale used when a translation is missing. Default is 'en'.

key: str | bytes | None, optional = (source)

The encryption key, normalized to bytes. None generates a persistent key.

language_path: str, optional = (source)

Relative path to the JSON translation files. Default is 'resources/lang/'.

locale: str, optional = (source)

The locale for the application. Default is 'en'.

maintenance: bool, optional = (source)

Whether maintenance mode is enabled. Default is False.

name: str, optional = (source)

The name of the application. Default is 'Orionis Application'.

timezone: str, optional = (source)

The timezone of the application. Default is 'UTC'.