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.
Group the view globals components and public imports.
| Module | app |
Provide view globals operations through _global_app. |
| Module | asset |
Provide view globals operations. |
| Module | auth |
Provide view globals operations through _global_auth. |
| Module | bcrypt |
Provide view globals operations through _global_encrypt, _global_decrypt. |
| Module | cache |
Provide view globals operations through _global_cache. |
| Module | collection |
Provide view globals operations through _global_collect. |
| Module | config |
Provide view globals operations through _global_config. |
| Module | csrf |
Provide view globals operations. |
| Module | datetime |
Provide view globals operations through _global_now, _global_today. |
| Module | dump |
Provide view globals operations through _global_dump. |
| Module | errors |
Expose validation errors from the current request session. |
| Module | flash |
Provide view globals operations through _global_flash. |
| Module | lang |
Provide view globals operations. |
| Module | old |
Provide view globals operations through _global_old. |
| Module | request |
Provide view globals operations through _global_request. |
| Module | route |
Provide view globals operations. |
| Module | session |
Provide view globals operations through _global_session. |
| Module | stringable |
Provide view globals operations through _global_stringable. |
| Module | url |
Provide view globals operations. |
| Module | version |
Provide view globals operations. |
From __init__.py:
| Function | __dir__ |
List loaded attributes and declared public exports. |
| Function | __getattr__ |
Resolve and cache a public package export. |
| Function | _global |
Build the app template global. |
| Function | _global |
Build the async asset template global bound to the application. |
| Function | _global |
Build the auth template global. |
| Function | _global |
Build the cache template global. |
| Function | _global |
Build the choice template global. |
| Function | _global |
Build the collect template global. |
| Function | _global |
Build the config template global bound to the application. |
| Function | _global |
Build the async csrf_field template global bound to the application. |
| Function | _global |
Build the async csrf_token template global bound to the application. |
| Function | _global |
Build the decrypt template global. |
| Function | _global |
Build the dump template global. |
| Function | _global |
Build the encrypt template global. |
| Function | _global |
Build the errors template global. |
| Function | _global |
Build the async flash template global. |
| Function | _global |
Build the framework_version template global. |
| Function | _global |
Build the locale template global. |
| Function | _global |
Build the locales template global. |
| Function | _global |
Build the now template global. |
| Function | _global |
Build the async old template global. |
| Function | _global |
Build the python_version template global. |
| Function | _global |
Build the async request template global. |
| Function | _global |
Build the async route template global bound to the application. |
| Function | _global |
Build the async secure_asset template global bound to the app. |
| Function | _global |
Build the async secure_url template global bound to the application. |
| Function | _global |
Build the async session template global. |
| Function | _global |
Build the stringable template global. |
| Function | _global |
Build the today template global. |
| Function | _global |
Build the trans (and __) template global. |
| Function | _global |
Build the async url template global bound to the application. |
| Constant | _EXPORTS |
Public export names mapped to their defining modules and attributes. |
| Constant | _LANG |
Locate the shared translation global builders. |
Resolve and cache a public package export.
| Parameters | |
name:str | Public attribute requested from this package. |
| Returns | |
object | Exported object from its defining module. |
| Raises | |
AttributeError | If the requested attribute is not exported. |
Build the app template global.
| Parameters | |
app:orionis.IApplication | Application container to expose in templates. |
| Returns | |
collections.abc.Callable | Callable returning the application instance. |
Build the async asset template global bound to the application.
| Parameters | |
app:orionis.IApplication | Application container used to resolve the storage manager. |
| Returns | |
collections.abc.Callable | Async callable that builds the public URL of a stored file. |
Build the auth template global.
| Returns | |
collections.abc.Callable | Callable exposing the authentication facade without caching a user. |
Build the cache template global.
| Parameters | |
app:orionis.IApplication | Application container to expose in templates. |
| Returns | |
collections.abc.Callable | Async callable reading the configured cache store. |
Build the choice template global.
| Returns | |
collections.abc.Callable | Callable that translates a pluralized key based on a quantity. |
Build the collect template global.
| Returns | |
collections.abc.Callable | Callable wrapping a value in the framework collection type. |
Build the config template global bound to the application.
| Parameters | |
app:orionis.IApplication | Application container providing configuration access. |
| Returns | |
collections.abc.Callable | Callable that retrieves a dot-separated configuration key. |
Build the async csrf_field template global bound to the application.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that returns a hidden input field with the CSRF token. |
Build the async csrf_token template global bound to the application.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that reads the CSRF token from the session. |
Build the decrypt template global.
| Parameters | |
app:orionis.IApplication | Application container to expose in templates. |
| Returns | |
collections.abc.Callable | Async callable decrypting payloads through the configured encrypter. |
Build the dump template global.
| Returns | |
collections.abc.Callable | Callable dumping the given variables and returning safe HTML. |
Build the encrypt template global.
| Parameters | |
app:orionis.IApplication | Application container to expose in templates. |
| Returns | |
collections.abc.Callable | Async callable encrypting plaintext through the configured encrypter. |
Build the errors template global.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
orionis.view.globals.errors.ErrorBag | Bag exposing the validation errors flashed for this request. |
Build the async flash template global.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that reads one-request status messages. |
Build the framework_version template global.
| Returns | |
collections.abc.Callable | Callable that returns the framework version. |
Build the locale template global.
| Returns | |
collections.abc.Callable | Callable that returns the active application locale. |
Build the locales template global.
| Returns | |
collections.abc.Callable | Callable that returns every locale with a translation source. |
Build the now template global.
| Returns | |
collections.abc.Callable | Callable returning the current date and time. |
Build the async old template global.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that reads the previously submitted form input. |
Build the python_version template global.
| Returns | |
collections.abc.Callable | Callable that returns the Python version. |
Build the async request template global.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that resolves the current HTTP request. |
Build the async route template global bound to the application.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that builds the URL of a named route. |
Build the async secure_asset template global bound to the app.
| Parameters | |
app:orionis.IApplication | Application container used to resolve the storage manager. |
| Returns | |
collections.abc.Callable | Async callable that builds the HTTPS URL of a stored file. |
Build the async secure_url template global bound to the application.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that builds an HTTPS URL from a path. |
Build the async session template global.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that resolves the current session. |
Build the stringable template global.
| Returns | |
collections.abc.Callable | Callable wrapping a value in a orionis.support.types.Stringable
instance. |
Build the today template global.
| Returns | |
collections.abc.Callable | Callable returning the current date at midnight. |
Build the trans (and __) template global.
| Returns | |
collections.abc.Callable | Callable that translates a key for a given or the active locale. |
Build the async url template global bound to the application.
| Parameters | |
app:orionis.IApplication | Application container used for service resolution. |
| Returns | |
collections.abc.Callable | Async callable that builds a URL from a path. |
Public export names mapped to their defining modules and attributes.
| Value |
|