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

class _ClientParameter: (source)

View In Hierarchy

Retain the immutable conversion plan for one client-owned parameter.

Async Method convert Convert and validate one RPC value without accessing an HTTP request body.
Class Variable annotation Declared Python type used to validate the client argument.
Class Variable default Value used when the client omits this argument.
Class Variable keyword_only Whether the client argument must be passed by keyword.
Class Variable name Name identifying this declaration within its containing registry.
Class Variable requires_preparation Whether marked coercion or existing-Struct expansion is required.
Class Variable schema_plans Compiled schema-validation plans for the argument.
async def convert(self, value: object) -> object: (source)

Convert and validate one RPC value without accessing an HTTP request body.

Parameters
value:objectExplicit client value or trusted declared default.
Returns
objectValidated scalar, collection, enum or schema.
Raises
orionis.realtime.errors.RPCErrorIf type constraints or schema rules reject the value.
annotation: object = (source)

Declared Python type used to validate the client argument.

Value used when the client omits this argument.

keyword_only: bool = (source)

Whether the client argument must be passed by keyword.

Name identifying this declaration within its containing registry.

requires_preparation: bool = (source)

Whether marked coercion or existing-Struct expansion is required.

Compiled schema-validation plans for the argument.