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.

module documentation

Undocumented

Class ModelMeta Metaclass discovering model columns and building their metadata.
Class ModelMetadata Precomputed metadata describing a model class.
Function pluralize Pluralize an English word using conventional heuristics.
Function snake_case Convert a CamelCase class name into snake_case.
Constant _ACCESSOR_PREFIX Undocumented
Constant _ACCESSOR_SUFFIX Undocumented
Constant _CAMEL_BOUNDARY Undocumented
Constant _ES_SUFFIXES Undocumented
Constant _FORWARDED_BUILDER_METHODS Undocumented
Constant _GUARD_ALL Undocumented
Constant _MUTATOR_PREFIX Undocumented
Constant _SCOPE_PREFIX Undocumented
Constant _VOWELS Undocumented
Constant MODEL_EVENTS Undocumented
def pluralize(word: str) -> str: (source)

Pluralize an English word using conventional heuristics.

Parameters
word:strSingular word to pluralize.
Returns
strPluralized word.
def snake_case(name: str) -> str: (source)

Convert a CamelCase class name into snake_case.

Leading underscores are ignored so private class names still map to clean table names.

Parameters
name:strClass name to convert.
Returns
strsnake_case version of the name.
_ACCESSOR_PREFIX: str = (source)

Undocumented

Value
'get'
_ACCESSOR_SUFFIX: str = (source)

Undocumented

Value
'Attribute'
_CAMEL_BOUNDARY = (source)

Undocumented

Value
re.compile(r'(?<!^)(?=[A-Z])')
_ES_SUFFIXES: tuple[str, ...] = (source)

Undocumented

Value
('s', 'x', 'z', 'ch', 'sh')
_FORWARDED_BUILDER_METHODS: frozenset[str] = (source)

Undocumented

Value
frozenset(set(['addSelect',
               'avg',
               'count',
               'crossJoin',
               'distinct',
               'doesntExist',
               'exists',
...
_GUARD_ALL: str = (source)

Undocumented

Value
'*'
_MUTATOR_PREFIX: str = (source)

Undocumented

Value
'set'
_SCOPE_PREFIX: str = (source)

Undocumented

Value
'scope'

Undocumented

Value
frozenset('aeiou')
MODEL_EVENTS: tuple[str, ...] = (source)

Undocumented

Value
('retrieved',
 'saving',
 'creating',
 'created',
 'updating',
 'updated',
 'saved',
...