orionis.view.globals

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

package documentation

(source)

Undocumented

Module	`app`	Undocumented
Module	`asset`	No module docstring; 1/1 function documented
Module	`bcrypt`	Undocumented
Module	`cache`	Undocumented
Module	`collection`	Undocumented
Module	`config`	Undocumented
Module	`csrf`	Undocumented
Module	`datetime`	Undocumented
Module	`dump`	Undocumented
Module	`errors`	No module docstring; 0/1 constant, 1/1 class documented
Module	`flash`	Undocumented
Module	`lang`	Undocumented
Module	`old`	Undocumented
Module	`request`	Undocumented
Module	`route`	No module docstring; 0/3 constant, 3/3 functions documented
Module	`session`	Undocumented
Module	`stringable`	Undocumented
Module	`url`	No module docstring; 0/4 constant, 3/3 functions documented
Module	`version`	Undocumented

From __init__.py:

Function	`_global_app`	Build the `app` template global.
Function	`_global_asset`	Build the async `asset` template global bound to the application.
Function	`_global_cache`	Build the `cache` template global.
Function	`_global_choice`	Build the `choice` template global.
Function	`_global_collect`	Build the `collect` template global.
Function	`_global_config`	Build the `config` template global bound to the application.
Function	`_global_csrf_field`	Build the async `csrf_field` template global bound to the application.
Function	`_global_csrf_token`	Build the async `csrf_token` template global bound to the application.
Function	`_global_decrypt`	Build the `decrypt` template global.
Function	`_global_dump`	Build the `dump` template global.
Function	`_global_encrypt`	Build the `encrypt` template global.
Function	`_global_errors`	Build the `errors` template global.
Function	`_global_flash`	Build the async `flash` template global.
Function	`_global_framework_version`	Build the `framework_version` template global.
Function	`_global_locale`	Build the `locale` template global.
Function	`_global_locales`	Build the `locales` template global.
Function	`_global_now`	Build the `now` template global.
Function	`_global_old`	Build the async `old` template global.
Function	`_global_python_version`	Build the `python_version` template global.
Function	`_global_request`	Build the async `request` template global.
Function	`_global_route`	Build the async `route` template global bound to the application.
Function	`_global_secure_asset`	Build the async `secure_asset` template global bound to the app.
Function	`_global_secure_url`	Build the async `secure_url` template global bound to the application.
Function	`_global_session`	Build the async `session` template global.
Function	`_global_stringable`	Build the `stringable` template global.
Function	`_global_today`	Build the `today` template global.
Function	`_global_trans`	Build the `trans` (and `__`) template global.
Function	`_global_url`	Build the async `url` template global bound to the application.

def _global_app(app: IApplication) -> Any: (source) ¶

Build the app template global.

Parameters
app:`IApplication`	Application container to expose in templates.

Returns
`Any`	Callable returning the application instance.

def _global_asset(app: IApplication) -> Any: (source) ¶

Build the async asset template global bound to the application.

Parameters
app:`IApplication`	Application container used to resolve the storage manager.

Returns
`Any`	Async callable that builds the public URL of a stored file.

def _global_cache(app: IApplication) -> Any: (source) ¶

Build the cache template global.

Parameters
app:`IApplication`	Application container to expose in templates.

Returns
`Any`	Callable returning the application instance.

def _global_choice() -> Any: (source) ¶

Build the choice template global.

Returns
`Any`	Callable that translates a pluralized key based on a quantity.

def _global_collect() -> Any: (source) ¶

Build the collect template global.

Returns
`Any`	Callable wrapping a value in a `Collection` instance.

def _global_config(app: IApplication) -> Any: (source) ¶

Build the config template global bound to the application.

Parameters
app:`IApplication`	Application container providing configuration access.

Returns
`Any`	Callable that retrieves a dot-separated configuration key.

def _global_csrf_field(app: IApplication) -> Any: (source) ¶

Build the async csrf_field template global bound to the application.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that returns a hidden input field with the CSRF token.

def _global_csrf_token(app: IApplication) -> Any: (source) ¶

Build the async csrf_token template global bound to the application.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that reads the CSRF token from the session.

def _global_decrypt(app: IApplication) -> Any: (source) ¶

Build the decrypt template global.

Parameters
app:`IApplication`	Application container to expose in templates.

Returns
`Any`	Callable returning the application instance.

def _global_dump() -> Any: (source) ¶

Build the dump template global.

Returns
`Any`	Callable dumping the given variables and returning safe HTML.

def _global_encrypt(app: IApplication) -> Any: (source) ¶

Build the encrypt template global.

Parameters
app:`IApplication`	Application container to expose in templates.

Returns
`Any`	Callable returning the application instance.

def _global_errors(app: IApplication) -> Any: (source) ¶

Build the errors template global.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Bag exposing the validation errors flashed for this request.

def _global_flash(app: IApplication) -> Any: (source) ¶

Build the async flash template global.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that reads one-request status messages.

def _global_framework_version() -> Any: (source) ¶

Build the framework_version template global.

Returns
`Any`	Callable that returns the framework version.

def _global_locale() -> Any: (source) ¶

Build the locale template global.

Returns
`Any`	Callable that returns the active application locale.

def _global_locales() -> Any: (source) ¶

Build the locales template global.

Returns
`Any`	Callable that returns every locale with a translation source.

def _global_now() -> Any: (source) ¶

Build the now template global.

Returns
`Any`	Callable returning the current date and time.

def _global_old(app: IApplication) -> Any: (source) ¶

Build the async old template global.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that reads the previously submitted form input.

def _global_python_version() -> Any: (source) ¶

Build the python_version template global.

Returns
`Any`	Callable that returns the Python version.

def _global_request(app: IApplication) -> Any: (source) ¶

Build the async request template global.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that resolves the current HTTP request.

def _global_route(app: IApplication) -> Any: (source) ¶

Build the async route template global bound to the application.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that builds the URL of a named route.

def _global_secure_asset(app: IApplication) -> Any: (source) ¶

Build the async secure_asset template global bound to the app.

Parameters
app:`IApplication`	Application container used to resolve the storage manager.

Returns
`Any`	Async callable that builds the HTTPS URL of a stored file.

def _global_secure_url(app: IApplication) -> Any: (source) ¶

Build the async secure_url template global bound to the application.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that builds an HTTPS URL from a path.

def _global_session(app: IApplication) -> Any: (source) ¶

Build the async session template global.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that resolves the current session.

def _global_stringable() -> Any: (source) ¶

Build the stringable template global.

Returns
`Any`	Callable wrapping a value in a `Stringable` instance.

def _global_today() -> Any: (source) ¶

Build the today template global.

Returns
`Any`	Callable returning the current date without time component.

def _global_trans() -> Any: (source) ¶

Build the trans (and __) template global.

Returns
`Any`	Callable that translates a key for a given or the active locale.

def _global_url(app: IApplication) -> Any: (source) ¶

Build the async url template global bound to the application.

Parameters
app:`IApplication`	Application container used for service resolution.

Returns
`Any`	Async callable that builds a URL from a path.