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

Own an MCP byte iterator even if the HTTP stream is never started.

Method __aiter__ Return this owned, single-use event source.
Async Method __anext__ Frame one message only when the native HTTP adapter is ready.
Method __init__ Transfer iterator and admission-slot ownership to the response.
Async Method aclose Close the producer and release admission before scope disposal.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _release Value supplied for release.
Instance Variable _source Source whose values or lifecycle are consumed by this operation.
def __aiter__(self) -> Self: (source)

Return this owned, single-use event source.

Returns
typing.SelfThis owned, single-use event source.
async def __anext__(self) -> ServerSentEvent: (source)

Frame one message only when the native HTTP adapter is ready.

Returns
orionis.http.ServerSentEventResult of the operation described above.
def __init__(self, source: AsyncIterator[bytes], release: Callable[[], None]): (source)

Transfer iterator and admission-slot ownership to the response.

Parameters
source:collections.abc.AsyncIterator[bytes]Source whose values or lifecycle are consumed by this operation.
release:collections.abc.Callable[[], None]Value supplied for release.
Returns
NoneComplete the documented operation without returning a value.
async def aclose(self): (source)

Close the producer and release admission before scope disposal.

Returns
NoneComplete the documented operation without returning a value.
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

_release = (source)

Value supplied for release.

Source whose values or lifecycle are consumed by this operation.