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

Module belongs_to Inverse relationship: the foreign key lives on the parent row.
Module belongs_to_many Many-to-many relationship backed by an intermediate pivot table.
Module has_many One-to-many relationship: the related table owns the foreign key.
Module has_one One-to-one relationship: the related table owns the foreign key.
Module has_one_or_many Shared machinery for the hasOne/hasMany relationship kinds.
Module mixin Relationship factories and loaded-relation storage for every model.
Module relation Base class for every query builder bound to a parent model instance.

From __init__.py:

Class BelongsToManyRelation Many-to-many relationship backed by an intermediate pivot table.
Class BelongsToRelation Inverse relationship: the foreign key lives on the parent row.
Class HasManyRelation One-to-many relationship: the related table owns the foreign key.
Class HasOneOrManyRelation Shared machinery for the hasOne/hasMany relationship kinds.
Class HasOneRelation One-to-one relationship: the related table owns the foreign key.
Class Relation Base class for every query builder bound to a parent model instance.
Class RelationsMixin Relationship factories and loaded-relation storage for every model.
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
{'BelongsToManyRelation': ('orionis.orm.relations.belongs_to_many',
                           'BelongsToManyRelation'),
 'BelongsToRelation': ('orionis.orm.relations.belongs_to', 'BelongsToRelation'),
 'HasManyRelation': ('orionis.orm.relations.has_many', 'HasManyRelation'),
 'HasOneOrManyRelation': ('orionis.orm.relations.has_one_or_many',
                          'HasOneOrManyRelation'),
 'HasOneRelation': ('orionis.orm.relations.has_one', 'HasOneRelation'),
...