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 view engine configuration for the application.

Method __post_init__ Validate template paths and cache settings without coercing values.
Instance Variable auto_reload Reload templates from disk whenever the source file changes. Typically True in development and False in production.
Instance Variable autoescape Enable automatic HTML escaping of all template variables.
Instance Variable cache_path Optional filesystem path used for Jinja2 bytecode caching. None disables disk-based caching.
Instance Variable cache_size Maximum number of compiled templates kept in the LRU memory cache. A value of 0 disables the cache; -1 keeps templates without a limit.
Instance Variable paths Ordered list of directory paths searched for templates.

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 template paths and cache settings without coercing values.

Returns
NoneThis method performs validation and normalization and returns None.
Raises
TypeErrorIf any of the runner options are of an incorrect type.
ValueErrorIf any of the runner options are invalid.
auto_reload: bool = (source)

Reload templates from disk whenever the source file changes. Typically True in development and False in production.

autoescape: bool = (source)

Enable automatic HTML escaping of all template variables.

cache_path: str | None = (source)

Optional filesystem path used for Jinja2 bytecode caching. None disables disk-based caching.

cache_size: int = (source)

Maximum number of compiled templates kept in the LRU memory cache. A value of 0 disables the cache; -1 keeps templates without a limit.

Ordered list of directory paths searched for templates.