Skip to navigation

nemoguardrails.server.experimental.provider.sse

View as MarkdownOpen in Claude

Parse Server-Sent Events without provider-specific knowledge.

The parser preserves complete upstream events byte-for-byte while exposing the event type and joined data fields needed by provider adapters.

Module Contents

Classes

NameDescription
AmbiguousServerSentEventReport SSE bytes that common clients interpret differently.
ServerSentEventRepresent one complete SSE event.
ServerSentEventTooLargeReport an SSE event that exceeds the configured buffering limit.
TruncatedServerSentEventReport an unfinished SSE block containing fields at end of stream.
_SSEFramer-

Functions

NameDescription
iter_sse_eventsYield complete SSE blocks from arbitrary HTTP byte chunks.

API

class nemoguardrails.server.experimental.provider.sse.AmbiguousServerSentEvent()

Bases: ValueError

Report SSE bytes that common clients interpret differently.

class nemoguardrails.server.experimental.provider.sse.ServerSentEvent(
raw: bytes,
lines: tuple[bytes, ...]
)
Dataclass

Represent one complete SSE event.

data
bytes | None

Return joined SSE data fields, or None when none are present.

event_type
bytes | None

Return the last SSE event field, or None when it is absent.

lines
tuple[bytes, ...]

Event field and comment lines without line endings.

raw
bytes

Original event bytes, including its terminating blank line when supplied by the upstream server.

classmethod

Create an event while retaining its original representation.

Parameters:

raw
bytes

Exactly one complete SSE block, without stream-start BOM handling.

Returns: ServerSentEvent

The parsed event representation.

class nemoguardrails.server.experimental.provider.sse.ServerSentEventTooLarge()

Bases: ValueError

Report an SSE event that exceeds the configured buffering limit.

class nemoguardrails.server.experimental.provider.sse.TruncatedServerSentEvent()

Bases: ValueError

Report an unfinished SSE block containing fields at end of stream.

class nemoguardrails.server.experimental.provider.sse._SSEFramer(
max_event_bytes: int,
stream_start: bool = True
)
line_start
= 0
lines
list[bytes] = []
raw
= bytearray()
nemoguardrails.server.experimental.provider.sse._SSEFramer._append(
value: int
) -> None
nemoguardrails.server.experimental.provider.sse._SSEFramer._end_line(
ending_length: int
nemoguardrails.server.experimental.provider.sse._SSEFramer._field_line(
line: bytes
) -> bytes
nemoguardrails.server.experimental.provider.sse._SSEFramer.feed(
chunk: bytes
nemoguardrails.server.experimental.provider.sse._SSEFramer.finish() -> collections.abc.Iterator[nemoguardrails.server.experimental.provider.sse.ServerSentEvent]
nemoguardrails.server.experimental.provider.sse.iter_sse_events(
source: collections.abc.AsyncIterator[bytes],
max_event_bytes: int = 1024 * 1024
async

Yield complete SSE blocks from arbitrary HTTP byte chunks.

Preserve raw bytes, including an initial BOM ignored only for field parsing. Drop unfinished comment tails; reject all other unfinished field blocks.

Parameters:

source
AsyncIterator[bytes]

Raw upstream response byte stream.

max_event_bytes
intDefaults to 1024 * 1024

Maximum bytes buffered for one event.

Raises:

  • ValueError: If max_event_bytes is not positive.
  • ServerSentEventTooLarge: If one event exceeds the limit.
  • TruncatedServerSentEvent: If the stream ends in an unfinished field block.
  • AmbiguousServerSentEvent: If a line after stream start begins with a BOM.