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 FailureCollector No class docstring; 0/1 class variable, 1/1 static method, 7/7 class methods documented
Function _async_field_plan Reuse conversion metadata with preclassified asynchronous validators.
Function _field_plan Return a cached per-field plan used to convert a payload field by field.
Function _nested_schema Return the Orionis schema wrapped by a field annotation, if any.
Constant _ASYNC_FIELD_PLAN_CACHE Undocumented
Constant _FIELD_PLAN_CACHE Undocumented
def _async_field_plan(schema: type) -> tuple: (source)

Reuse conversion metadata with preclassified asynchronous validators.

Parameters
schema:typeSchema whose payload failed whole-object conversion.
Returns
tupleCached field conversion plans with await flags for their rule callables.
def _field_plan(schema: type) -> tuple: (source)

Return a cached per-field plan used to convert a payload field by field.

Parameters
schema:typeSchema class whose msgspec fields are inspected.
Returns
tupleEntries of (encode_name, field_type, required, nested_schema, rules), where rules holds the bound custom rule validators declared for the field.
def _nested_schema(tp: object) -> type | None: (source)

Return the Orionis schema wrapped by a field annotation, if any.

Parameters
tp:objectField annotation, possibly wrapped in Annotated or a union.
Returns
type | NoneNested schema class, or None when the field holds no schema.
_ASYNC_FIELD_PLAN_CACHE: dict[type, tuple] = (source)

Undocumented

Value
{}
_FIELD_PLAN_CACHE: dict[type, tuple] = (source)

Undocumented

Value
{}