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.

class documentation

Validate structured input against declared fields and validation rules.

Async Static Method validate Validate a payload or existing struct and await its schema rules.
Class Variable __slots__ Prevent per-instance dictionaries; the class is used statically.
async def validate(payload: object, schema: type[SchemaType]) -> SchemaType: (source)

Validate a payload or existing struct and await its schema rules.

Coerce explicitly marked values before checking types and constraints. Leave other fields strict and preserve the original payload.

Parameters
payload:objectInput data or root struct to expand and revalidate.
schema:type[orionis.schemas.Schema]Schema class used for conversion and rule validation.
Returns
orionis.schemas.SchemaConverted instance satisfying structural constraints and rules.
Raises
orionis.schemas.exceptions.ValidationExceptionIf conversion, constraints or rules reject the payload. Include collected failures grouped by field.
__slots__: tuple = (source)

Prevent per-instance dictionaries; the class is used statically.