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

Package column Group the orm schema column components and public imports.
Package constraints Group the orm schema constraints components and public imports.
Module table Framework-agnostic description of a database table.
Package types Group the orm schema types components and public imports.

From __init__.py:

Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _CONSTRAINTS_MODULE Module exporting table and foreign-key constraints.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
Constant _TYPES_MODULE Module exporting logical column declarations.
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.
_CONSTRAINTS_MODULE: str = (source)

Module exporting table and foreign-key constraints.

Value
'orionis.orm.schema.constraints'
_EXPORTS = (source)

Public export names mapped to their defining modules and attributes.

Value
{'BigInteger': (_TYPES_MODULE, 'BigInteger'),
 'Boolean': (_TYPES_MODULE, 'Boolean'),
 'ColumnDefinition': ('orionis.orm.schema.column', 'ColumnDefinition'),
 'ColumnOptions': ('orionis.orm.schema.column', 'ColumnOptions'),
 'ColumnType': (_TYPES_MODULE, 'ColumnType'),
 'CompositeForeignKey': (_CONSTRAINTS_MODULE, 'CompositeForeignKey'),
 'Date': (_TYPES_MODULE, 'Date'),
...
_TYPES_MODULE: str = (source)

Module exporting logical column declarations.

Value
'orionis.orm.schema.types'