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
Describe one pre-authorized method without retaining a Hub instance.
| Class | _ |
Retain the immutable conversion plan for one client-owned parameter. |
| Class | |
Describe one pre-authorized method without retaining a Hub instance. |
| Function | _base |
Remove metadata wrappers when classifying trusted annotations. |
| Function | _dependency |
Extract a container-owned service type, including nullable dependencies. |
| Function | _is |
Identify types whose values may safely originate in decoded client data. |
| Function | _method |
Compile trusted reflection metadata once, rejecting ambiguous signatures. |
| Function | compile |
Build the immutable remote dispatch map exclusively from class metadata. |
| Constant | _ARGUMENTS |
Invalid arguments. |
| Constant | _COLLECTIONS |
Collections used by metadata. |
| Constant | _INVALID |
invalid_arguments. |
| Constant | _SCALARS |
Scalars used by metadata. |
| Constant | _VALIDATION |
Protocol error code returned when invocation arguments fail validation. |
Extract a container-owned service type, including nullable dependencies.
| Parameters | |
annotation:object | Resolved trusted annotation. |
| Returns | |
type | None | Concrete or abstract service type, or None for client data/unsupported hints. |
Compile trusted reflection metadata once, rejecting ambiguous signatures.
| Parameters | |
hub:type[orionis.realtime.Hub] | Registered hub class. |
name:str | Server-owned Python method name. |
function:types.FunctionType | Original decorated function. |
| Returns | |
orionis.realtime.metadata.RemoteMethod | Complete safe binding and dispatch plan. |
| Raises | |
TypeError | If annotations cannot be resolved or a signature is unsupported. |
Build the immutable remote dispatch map exclusively from class metadata.
| Parameters | |
hub:type[orionis.realtime.Hub] | Developer-owned Hub subclass registered during application boot. |
| Returns | |
collections.abc.Mapping[str, orionis.realtime.metadata.RemoteMethod] | Bounded cached dispatch map; no instance or payload is retained. |
| Raises | |
TypeError | If a remote descriptor, method or annotation is unsupported. |
ValueError | If aliases conflict or a private method is marked remote. |