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 orm schema column components and public imports.

Module definition Framework-agnostic description of a database column.
Module options Secondary, type-specific knobs mirroring SQLAlchemy constructor args.

From __init__.py:

Class ColumnDefinition Framework-agnostic description of a database column.
Class ColumnOptions Secondary, type-specific knobs mirroring SQLAlchemy constructor args.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
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.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'ColumnDefinition': ('orionis.orm.schema.column.definition',
                      'ColumnDefinition'),
 'ColumnOptions': ('orionis.orm.schema.column.options', 'ColumnOptions')}