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

Module attributes Attribute handling behavior shared by every model.
Package collections Group the orm collections components and public imports.
Package contracts Group the orm contracts components and public imports.
Module events Lifecycle event behavior shared by every model.
Package exceptions Group the orm exceptions components and public imports.
Package factories Group the orm factories components and public imports.
Module metaclass Provide orm operations.
Module model Base class of the Orionis active-record models.
Module provider Register query builder services in the application container.
Package query Group the orm query components and public imports.
Module query_builder Entry point of the model-less query API, backing the DB facade.
Package relations Group the orm relations components and public imports.
Module resolver Static bridge between the ORM and the database connection manager.
Package schema Group the orm schema components and public imports.
Module soft_deletes Soft delete behavior shared by every model.
Module state Attribute state tracking behavior shared by every model.

From __init__.py:

Class ConnectionResolver Static bridge between the ORM and the database connection manager.
Class Model Base class of the Orionis active-record models.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXCEPTIONS_MODULE Module defining the public ORM exceptions.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
Constant _RELATIONS_MODULE Module defining the public relation classes.
Constant _TYPES_MODULE Module defining the public column types.
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.
_EXCEPTIONS_MODULE: str = (source)

Module defining the public ORM exceptions.

Value
'orionis.orm.exceptions'
_EXPORTS = (source)

Public export names mapped to their defining modules and attributes.

Value
{'BelongsToManyRelation': (_RELATIONS_MODULE, 'BelongsToManyRelation'),
 'BelongsToRelation': (_RELATIONS_MODULE, 'BelongsToRelation'),
 'BigInteger': (_TYPES_MODULE, 'BigInteger'),
 'Boolean': (_TYPES_MODULE, 'Boolean'),
 'Collection': ('orionis.orm.collections.collection', 'Collection'),
 'ColumnType': (_TYPES_MODULE, 'ColumnType'),
 'ConnectionResolver': ('orionis.orm.resolver', 'ConnectionResolver'),
...
_RELATIONS_MODULE: str = (source)

Module defining the public relation classes.

Value
'orionis.orm.relations'
_TYPES_MODULE: str = (source)

Module defining the public column types.

Value
'orionis.orm.schema.types'