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

Stream typed server-sent events through the existing response transport.

Method __init__ Initialize a lazy UTF-8 event stream with SSE response headers.
Method getRawHeaders Serialize headers without a fixed event-stream content length.
Method getStream Return the owned byte iterator without starting its event source.
Method getStringHeaders Serialize headers without a fixed event-stream content length.
Class Variable __slots__ Declare that this class introduces no additional instance slots.

Inherited from StreamingResponse:

Method _wrapSyncIterable Adapt a synchronous iterable of bytes to an asynchronous iterable.
Instance Variable _body HTTP response body or encoded payload returned to the client.

Inherited from Response (via StreamingResponse):

Method addHeader Add a header to the response.
Method deleteCookie Delete a cookie by setting its expiration to the past.
Method getBody Return the response body as bytes.
Method getFlashData Return the data queued by withFlash() for the session flash bag.
Method getHeader Get the values for a header.
Method getMediaType Return the media type of the response.
Method getStatusCode Return the HTTP status code of the response.
Method hasHeader Check if a header is present.
Method hasStream Check if the response has a stream.
Method removeHeader Remove a header from the response.
Method render Render the content to bytes.
Async Method runBackground Run the background task if it exists.
Method setCookie Set a cookie header in the response.
Method setHeader Set a header, replacing any existing values.
Method withBackground Set the background task and return the response.
Method withCookie Attach a cookie and return the response for chaining.
Method withCookies Attach several cookies at once and return the response.
Method withHeaders Merge response headers and return the response.
Method withoutCookie Expire a cookie and return the response for chaining.
Method withStatusCode Set the HTTP status code and return the response.
Class Variable charset Encode text responses using UTF-8.
Instance Variable _flash Initialize flash data when it is first queued.
Instance Variable _headers The headers to include in the response.
Instance Variable _raw_headers Protocol-ready header pairs emitted with the response.
Instance Variable _stream Iterator supplying response body chunks.
Instance Variable background The background task to run after response.
Instance Variable media_type The media type of the response.
Instance Variable status_code The HTTP status code for the response.

Inherited from _FlashData (via StreamingResponse, Response):

Method withErrors Flash validation errors for the next request.
Method withFlash Queue a status message for the owning response or pending view.
Method withInput Flash the submitted payload so the next request can repopulate it.
def __init__(self: Self, content: AsyncIterable[ServerSentEvent | str] | Iterable[ServerSentEvent | str], status_code: HTTPStatus | int = 200, headers: Mapping[str, str] | None = None, background: BackgroundTask | None = None): (source)

Initialize a lazy UTF-8 event stream with SSE response headers.

Parameters
content:AsyncIterable[ServerSentEvent | str] | Iterable[ServerSentEvent | str]Events or strings, each encoded only when the transport requests it.
status_code:orionis.http.enums.HTTPStatus | int, optionalHTTP status code for the response.
headers:collections.abc.Mapping[str, str] | None, optionalResponse headers; Content-Length is discarded for event streams.
background:orionis.background.BackgroundTask | None, optionalTask to run after successful delivery and producer cleanup.
Returns
NoneValidate response metadata while deferring producer iteration and I/O.
Raises
TypeErrorIf the content does not implement synchronous or asynchronous iteration.
def getRawHeaders(self: Self) -> list[tuple[bytes, bytes]]: (source)

Serialize headers without a fixed event-stream content length.

Returns
list of tuple of bytesASGI response headers, excluding any later Content-Length mutation.
def getStream(self: Self) -> _EventStreamIterator: (source)

Return the owned byte iterator without starting its event source.

Returns
orionis.http.sse._EventStreamIteratorLazy encoder whose aclose() method finalizes the event source.
def getStringHeaders(self: Self) -> list[tuple[str, str]]: (source)

Serialize headers without a fixed event-stream content length.

Returns
list of tuple of strRSGI response headers, excluding any later Content-Length mutation.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.