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.

Explore modules View classes

orionis.foundation.config.app.App

class documentation

class App(BaseEntity): (source)

View In Hierarchy

Represent application configuration settings.

Parameters
nameThe name of the application. Default is 'Orionis Application'.
envThe environment in which the application is running. Default is 'DEVELOPMENT'.
debugWhether debug mode is enabled. Default is True.
timezoneThe timezone of the application. Default is 'UTC'.
localeThe locale for the application. Default is 'en'.
fallback_localeThe locale used when a translation is missing. Default is 'en'.
language_pathRelative path to the JSON translation files. Default is 'resources/lang/'.
cipherThe cipher used for encryption. Default is 'AES_256_CBC'.
keyThe encryption key, normalized to bytes. None generates a persistent key.
maintenanceWhether maintenance mode is enabled. Default is False.
Method __post_init__ Validate application options and normalize their values.
Method __validateKey Validate and normalize the encryption key for cipher consumers.
Class Variable cipher Undocumented
Class Variable debug Undocumented
Class Variable env Undocumented
Class Variable fallback_locale Undocumented
Class Variable key Undocumented
Class Variable language_path Undocumented
Class Variable locale Undocumented
Class Variable maintenance Undocumented
Class Variable name Undocumented
Class Variable timezone Undocumented

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

Returns
NoneComplete validation and normalization in place.
def __validateKey(self): (source)

Validate and normalize the encryption key for cipher consumers.

Returns
NoneStore the validated key as bytes and persist generated keys.
cipher: str | Cipher, optional = (source)

Undocumented

debug: bool, optional = (source)

Undocumented

env: str | Environments, optional = (source)

Undocumented

fallback_locale: str, optional = (source)

Undocumented

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

Undocumented

language_path: str, optional = (source)

Undocumented

locale: str, optional = (source)

Undocumented

maintenance: bool, optional = (source)

Undocumented

name: str, optional = (source)

Undocumented

timezone: str, optional = (source)

Undocumented