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.

Explore modules View classes

orionis.realtime.metadata

module documentation
(source)

Undocumented

Class _ClientParameter Retain the immutable conversion plan for one client-owned parameter.
Class _SchemaPlan Retain trusted field names and existing rule metadata for one Struct.
Class RemoteMethod Describe one pre-authorized method without retaining a Hub instance.
Function _base_annotation Remove metadata wrappers when classifying trusted annotations.
Function _dependency_type Extract a container-owned service type, including nullable dependencies.
Function _is_data Identify types whose values may safely originate in decoded client data.
Function _method_plan Compile trusted reflection metadata once, rejecting ambiguous signatures.
Function _schema_plans Compile schema traversal and local rules through nested data structures.
Function _validate_schemas Run existing schema rules across an already converted RPC data value.
Function compile_hub Build the immutable remote dispatch map exclusively from class metadata.
Constant _ARGUMENTS_MESSAGE Undocumented
Constant _COLLECTIONS Undocumented
Constant _INVALID_ARGUMENTS Undocumented
Constant _SCALARS Undocumented
Constant _VALIDATION_ERROR Undocumented
def _base_annotation(annotation: object) -> object: (source)

Remove metadata wrappers when classifying trusted annotations.

Parameters
annotation:objectResolved developer-owned annotation.
Returns
objectUnderlying annotation, preserving optionality and container parameters.
def _dependency_type(annotation: object) -> type | None: (source)

Extract a container-owned service type, including nullable dependencies.

Parameters
annotation:objectResolved trusted annotation.
Returns
type | NoneConcrete or abstract service type, or None for client data/unsupported hints.
def _is_data(annotation: object) -> bool: (source)

Identify types whose values may safely originate in decoded client data.

Parameters
annotation:objectResolved callable annotation.
Returns
boolWhether the type is a scalar, schema, enum or typed data collection.
def _method_plan(hub: type[Hub], name: str, function: FunctionType) -> RemoteMethod: (source)

Compile trusted reflection metadata once, rejecting ambiguous signatures.

Parameters
hub:type[Hub]Registered hub class.
name:strServer-owned Python method name.
function:FunctionTypeOriginal decorated function.
Returns
RemoteMethodComplete safe binding and dispatch plan.
Raises
TypeErrorIf annotations cannot be resolved or a signature is unsupported.
def _schema_plans(annotation: object) -> Mapping[type, _SchemaPlan]: (source)

Compile schema traversal and local rules through nested data structures.

Parameters
annotation:objectAccepted client annotation, possibly optional or Annotated.
Returns
Mapping[type, _SchemaPlan]Immutable traversal metadata, including recursive Struct references.
def _validate_schemas(value: object, plans: Mapping[type, _SchemaPlan]): (source)

Run existing schema rules across an already converted RPC data value.

Parameters
value:objectConverted schema or collection with a compiled schema-containing type.
plans:Mapping[type, _SchemaPlan]Trusted field and rule metadata compiled during Hub registration.
Returns
NoneExecute validation without re-inspecting callable metadata.
Raises
ValidationExceptionIf a contained schema violates a framework rule.
@lru_cache(maxsize=1024)
def compile_hub(hub: type[Hub]) -> Mapping[str, RemoteMethod]: (source)

Build the immutable remote dispatch map exclusively from class metadata.

Parameters
hub:type[Hub]Developer-owned Hub subclass registered during application boot.
Returns
Mapping[str, RemoteMethod]Bounded cached dispatch map; no instance or payload is retained.
Raises
TypeErrorIf a remote descriptor, method or annotation is unsupported.
ValueErrorIf aliases conflict or a private method is marked remote.
_ARGUMENTS_MESSAGE: str = (source)

Undocumented

Value
'Invalid arguments'
_COLLECTIONS = (source)

Undocumented

Value
frozenset(set([list, tuple, dict, set, frozenset, Sequence, Mapping]))
_INVALID_ARGUMENTS: str = (source)

Undocumented

Value
'invalid_arguments'
_SCALARS = (source)

Undocumented

Value
frozenset(set([str,
               int,
               float,
               bool,
               bytes,
               object,
               type(None),
...
_VALIDATION_ERROR: str = (source)

Undocumented

Value
'validation_error'