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

Module coercion Prepare explicitly coercible values without changing the source payload.
Module compiler Compile metadata into native constraints and reject incompatible declarations.
Module constraint_plan Provide schemas operations.
Module constraints Provide schemas operations.
Package contracts Group the schemas contracts components and public imports.
Package entities Group the schemas entities components and public imports.
Module exception_parser Translate validation exceptions into structured field errors.
Package exceptions Group the schemas exceptions components and public imports.
Module failure_collector Collect and organize validation failures by field path.
Module fields Define fields for schemas.
Module instance_payload Provide schemas operations through instance_payload.
Package meta Group the schemas meta components and public imports.
Module metadata Declare field conversion markers and documentation metadata.
Module rule Define a reusable validation rule and its failure message.
Package rules Group the schemas rules components and public imports.
Module rules_executor Compile bounded rule plans and collect nested validation failures.
Module schema Compile schema declarations and provide their structured representation.
Module validator Validate structured input against declared fields and validation rules.

From __init__.py:

Class Schema Define the base class for Orionis schema declarations.
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
{'Schema': ('orionis.schemas.schema', 'Schema')}