orionis.realtime

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

package documentation

(source)

Undocumented

Module	`clients`	No module docstring; 0/3 constant, 3/3 functions, 1/1 class documented
Module	`config`	No module docstring; 1/1 class documented
Module	`connection`	No module docstring; 0/2 constant, 1/1 class documented
Package	`contracts`	No package docstring; 2/2 classes, 0/2 module documented
Module	`decorators`	No module docstring; 0/2 constant, 1/1 function documented
Module	`entities`	Undocumented
Module	`errors`	No module docstring; 3/3 exceptions documented
Module	`groups`	Undocumented
Module	`hub`	Undocumented
Module	`manager`	No module docstring; 1/1 class documented
Module	`metadata`	No module docstring; 0/5 constant, 7/7 functions, 3/3 classes documented
Module	`protocol`	No module docstring; 0/5 constant, 3/3 functions, 6/6 classes documented
Module	`provider`	No module docstring; 1/1 class documented
Module	`runtime`	No module docstring; 0/1 constant, 1/1 class documented

From __init__.py:

Class	`BroadcastResult`	Count delivered and failed recipients without retaining connections.
Class	`ConnectionManager`	Own worker-local connections and isolate every group by Hub class.
Class	`Hub`	Define an invocation-scoped realtime endpoint with explicit remote methods.
Class	`HubClients`	Select ready clients within one Hub in the current worker.
Class	`HubContext`	Expose connection identity without providing service location.
Class	`HubGroups`	Manage group membership owned by the current Hub connection.
Class	`HubProtocol`	Encode Orionis Realtime v1 using route-selected JSON or MessagePack.
Function	`__dir__`	List declared exports and loaded package attributes.
Function	`__getattr__`	Resolve and cache a declared realtime export.
Function	`remote`	Mark an instance method for remote dispatch without wrapping it.
Constant	`_EXPORTS`	Undocumented

def __dir__() -> list[str]: (source) ¶

List declared exports and loaded package attributes.

Returns
`list[str]`	Sorted public and loaded names.

def __getattr__(name: str) -> object: (source) ¶

Resolve and cache a declared realtime export.

Parameters
name:`str`	Public package attribute requested by application code.

Returns
`object`	Declared realtime class or decorator.

Raises
`AttributeError`	If the name is not exported.

@overload

def remote(function: F, *, name: str | None = None) -> F:

@overload

def remote(function: None = None, *, name: str | None = None) -> Callable[[F], F]:

(source) ¶

Mark an instance method for remote dispatch without wrapping it.

Parameters
function:`F \| None, optional`	Method supplied by bare decorator syntax.
name:`str \| None, optional`	Explicit public alias, otherwise the Python method name.

Returns
`F \| Callable[[F], F]`	Original function, or a decorator returning the original function.

Raises
`TypeError`	If the decorated object is not a Python function.
`ValueError`	If the method name or alias is invalid, or the method is already marked.

_EXPORTS: dict = (source) ¶

Undocumented

Value

{'BroadcastResult': ('orionis.realtime.entities', 'BroadcastResult'),
 'ConnectionManager': ('orionis.realtime.manager', 'ConnectionManager'),
 'Hub': ('orionis.realtime.hub', 'Hub'),
 'HubClients': ('orionis.realtime.clients', 'HubClients'),
 'HubContext': ('orionis.realtime.hub', 'HubContext'),
 'HubGroups': ('orionis.realtime.groups', 'HubGroups'),
 'HubProtocol': ('orionis.realtime.protocol', 'HubProtocol'),
...