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 RemoteMethod: (source)

View In Hierarchy

Describe one pre-authorized method without retaining a Hub instance.

Async Method bind Bind and validate client-owned parameters, providing declared defaults.
Class Variable client_names Names of arguments the client is permitted to supply.
Class Variable dependencies Service dependencies resolved for the remote invocation.
Class Variable is_stream Whether the remote method produces streamed results.
Class Variable method_name Python method name implementing the remote target.
Class Variable parameters Client-supplied parameters accepted by the remote method.
Class Variable positional Parameter metadata used to bind positional client arguments.
async def bind(self, args: list[object], kwargs: dict[str, object]) -> dict[str, object]: (source)

Bind and validate client-owned parameters, providing declared defaults.

Parameters
args:list[object]Positional RPC values, excluding every dependency-injected parameter.
kwargs:dict[str, object]Named RPC values, restricted to the compiled client parameter set.
Returns
dict[str, object]Converted client arguments; container dependencies are never included.
Raises
orionis.realtime.errors.RPCErrorIf an argument is missing, duplicated, unknown or invalid.
client_names: frozenset[str] = (source)

Names of arguments the client is permitted to supply.

dependencies: Mapping[str, type] = (source)

Service dependencies resolved for the remote invocation.

is_stream: bool = (source)

Whether the remote method produces streamed results.

method_name: str = (source)

Python method name implementing the remote target.

Client-supplied parameters accepted by the remote method.

Parameter metadata used to bind positional client arguments.