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.

package documentation

Group the view filters components and public imports.

Module json Provide view filters operations through _filter_json.
Module markdown Provide view filters operations through _filter_markdown.

From __init__.py:

Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Function _filter_json Build the json template filter.
Function _filter_markdown Build the markdown template filter.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
def _filter_json() -> Callable[..., str]: (source)

Build the json template filter.

Returns
collections.abc.Callable[..., str]Callable serialising a value to a JSON string.
def _filter_markdown() -> Callable[[object], str]: (source)

Build the markdown template filter.

Returns
collections.abc.Callable[[object], str]Callable rendering a Markdown string to HTML.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'_filter_json': ('orionis.view.filters.json', '_filter_json'),
 '_filter_markdown': ('orionis.view.filters.markdown', '_filter_markdown')}