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 the main configuration for Orionis Framework startup.

Returns
NoneThis class does not return a value upon instantiation.
Raises
TypeErrorIf any configuration section is initialized with an invalid type.
Method __post_init__ Validate and convert configuration attributes to their entity types.
Instance Variable app Application configuration settings.
Instance Variable auth Authentication configuration settings.
Instance Variable cache Cache configuration settings.
Instance Variable database Database configuration settings.
Instance Variable filesystems Filesystem configuration settings.
Instance Variable hashing Password hashing configuration settings.
Instance Variable http HTTP configuration settings.
Instance Variable logging Logging configuration settings.
Instance Variable mail Mail configuration settings.
Instance Variable mcp MCP protocol limits and trusted browser origins.
Instance Variable queue Queue configuration settings.
Instance Variable realtime Realtime invocation, message and broadcast limits.
Instance Variable scheduler Scheduled task configuration settings.
Instance Variable session Session configuration settings.
Instance Variable testing Testing configuration settings.
Instance Variable view Template rendering configuration settings.

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 and convert configuration attributes to their entity types.

Returns
NoneThis method does not return a value.
app: orionis.foundation.config.app.App | dict, optional = (source)

Application configuration settings.

auth: orionis.foundation.config.auth.Auth | dict, optional = (source)

Authentication configuration settings.

cache: orionis.foundation.config.cache.Cache | dict, optional = (source)

Cache configuration settings.

database: orionis.foundation.config.database.Database | dict, optional = (source)

Database configuration settings.

filesystems: orionis.foundation.config.filesystems.Filesystems | dict, optional = (source)

Filesystem configuration settings.

hashing: orionis.foundation.config.hashing.Hashing | dict, optional = (source)

Password hashing configuration settings.

http: orionis.foundation.config.http.HTTP | dict, optional = (source)

HTTP configuration settings.

logging: orionis.foundation.config.logging.Logging | dict, optional = (source)

Logging configuration settings.

mail: orionis.foundation.config.mail.Mail | dict, optional = (source)

Mail configuration settings.

mcp: orionis.mcp.config.McpConfig | dict, optional = (source)

MCP protocol limits and trusted browser origins.

queue: orionis.foundation.config.queue.Queue | dict, optional = (source)

Queue configuration settings.

realtime: orionis.realtime.config.RealtimeConfig | dict, optional = (source)

Realtime invocation, message and broadcast limits.

scheduler: orionis.foundation.config.scheduler.Scheduler | dict, optional = (source)

Scheduled task configuration settings.

session: orionis.foundation.config.session.Session | dict, optional = (source)

Session configuration settings.

testing: orionis.foundation.config.testing.Testing | dict, optional = (source)

Testing configuration settings.

view: orionis.foundation.config.view.View | dict, optional = (source)

Template rendering configuration settings.