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 |
Validate application options and normalize their values. |
| Method | __validate |
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 |
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 |
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 | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | __init__ |
Initialize declared fields and public extra attributes. |
| Method | _dynamic |
Return public instance attributes that are not declared fields. |
| Method | _validate |
Validate names and storage for public extra attributes. |
| Method | get |
Describe declared fields and, optionally, dynamic attributes. |
| Method | to |
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 |
Cache declared fields and normalized type names for each concrete class. |
Validate application options and normalize their values.
| Returns | |
None | No return value. |
| Raises | |
ValueError | If the cipher is not authenticated or another setting is invalid. |