orionis.view.environment.ViewEnvironment

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

class documentation

class ViewEnvironment(IViewEnvironment): (source)

Constructor: ViewEnvironment(app)

View In Hierarchy

Encapsulate and configure a Jinja2 Environment instance.

This is the single authorised class for configuring the underlying template engine. All loaders, caches, globals, filters, tests and extensions must be registered through the public methods of this class.

The Jinja2 Environment is built once during construction and stored internally; no other class may access it directly except through getJinjaEnvironment.

Method	`__init__`	Build the Jinja2 environment from the application view configuration.
Method	`addExtension`	Register a Jinja2 extension class with the environment.
Method	`addFilter`	Register a filter callable that templates can apply with `\|`.
Method	`addGlobal`	Register a global variable or callable in all templates.
Method	`addTest`	Register a test callable used in Jinja2 `is` expressions.
Method	`getJinjaEnvironment`	Return the configured Jinja2 `Environment` instance.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_jinja_env`	Undocumented

def __init__(self, app: IApplication): (source) ¶

Build the Jinja2 environment from the application view configuration.

Parameters
app:`IApplication`	Application container used to read view configuration and resolve the base path for relative template directories.

Returns
`None`	Undocumented

def addExtension(self, extension: Any): (source) ¶

overrides orionis.view.contracts.environment.IViewEnvironment.addExtension

Parameters
extension:`Any`	A Jinja2 `Extension` subclass or its dotted import path.

Returns
`None`	Undocumented

Raises
`ViewException`	When the extension cannot be registered by Jinja2.

def addFilter(self, name: str, callback: Callable): (source) ¶

overrides orionis.view.contracts.environment.IViewEnvironment.addFilter

Parameters
name:`str`	Filter name referenced inside template expressions (e.g. `\| slug`).
callback:`Callable`	Function applied to the piped value.

Returns
`None`	Undocumented

def addGlobal(self, name: str, value: Any): (source) ¶

overrides orionis.view.contracts.environment.IViewEnvironment.addGlobal

Parameters
name:`str`	Identifier used to reference the value inside templates.
value:`Any`	Value or callable to expose as a template global.

Returns
`None`	Undocumented

def addTest(self, name: str, callback: Callable): (source) ¶

overrides orionis.view.contracts.environment.IViewEnvironment.addTest

Parameters
name:`str`	Test name referenced inside template `is` expressions.
callback:`Callable`	Function receiving the tested value and returning a bool.

Returns
`None`	Undocumented

def getJinjaEnvironment(self) -> jinja2.Environment: (source) ¶

overrides orionis.view.contracts.environment.IViewEnvironment.getJinjaEnvironment

Return the configured Jinja2 Environment instance.

Returns
`jinja2.Environment`	The internal Jinja2 environment. Treat as read-only outside this class; all mutations must flow through the typed helpers.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.view.contracts.environment.IViewEnvironment.__slots__

Undocumented

_jinja_env: jinja2.Environment = (source) ¶

Undocumented