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
Collect and organize validation failures by field path.
| Class | |
Collect and organize validation failures by field path. |
| Function | _field |
Return a class-owned plan for collecting field validation failures. |
| Function | _nested |
Return the Orionis schema wrapped by a field annotation, if any. |
| Function | _payload |
Map array-like schema positions to encoded field names. |
| Constant | _INVALID |
Sentinel distinguishing invalid from ordinary values. |
Return a class-owned plan for collecting field validation failures.
Retain field types and rules only through their schema owner. Look up the exact class so subclasses do not reuse a parent's incomplete field plan.
| Parameters | |
schema:type | Schema class whose msgspec fields are inspected. |
| Returns | |
tuple | Entries of (encode_name, field_type, required, nested_annotation, rules, attribute, default, factory), where rules holds the bound custom validators and attribute is the Python field name. |
Map array-like schema positions to encoded field names.
| Parameters | |
payload:collections.abc.Mapping | list | tuple | Field mapping or positional schema data, including any tag. |
schema:type | Schema defining field order, encoded names and tag configuration. |
| Returns | |
collections.abc.Mapping | Original mapping or positional values keyed by encoded field name. |