Skip to content

fix(streaming): add aclose() to AsyncStream for standard async cleanup protocol #2944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
s-zx wants to merge 2 commits into
base: main
Choose a base branch
from
+33 −8
Open

fix(streaming): add aclose() to AsyncStream for standard async cleanup protocol #2944

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4b4483
fix(streaming): skip empty SSE data and move error check outside thre…
s-zx Mar 8, 2026
0b82169
fix(streaming): add aclose() to AsyncStream for standard async cleanu…
s-zx Mar 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 33 additions & 8 deletions src/openai/_streaming.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,20 @@ def __stream__(self) -> Iterator[_T]:
if sse.data.startswith("[DONE]"):
break

# Skip SSE meta-only events that carry no data (e.g. standalone
# `retry:` or `id:` directives). Per the SSE spec these are valid
# but contain an empty data field; calling sse.json() on them
# raises JSONDecodeError.
if not sse.data or not sse.data.strip():
continue

# we have to special case the Assistants `thread.` events since we won't have an "event" key in the data
if sse.event and sse.event.startswith("thread."):
data = sse.json()

yield process_data(data={"data": data, "event": sse.event}, cast_to=cast_to, response=response)
else:
data = sse.json()
# Handle error events that carry an "error" event type (outside thread.* scope)
if sse.event == "error" and is_mapping(data) and data.get("error"):
message = None
error = data.get("error")
Expand All @@ -81,9 +91,6 @@ def __stream__(self) -> Iterator[_T]:
body=data["error"],
)

yield process_data(data={"data": data, "event": sse.event}, cast_to=cast_to, response=response)
else:
data = sse.json()
if is_mapping(data) and data.get("error"):
message = None
error = data.get("error")
Expand Down Expand Up @@ -173,10 +180,20 @@ async def __stream__(self) -> AsyncIterator[_T]:
if sse.data.startswith("[DONE]"):
break

# Skip SSE meta-only events that carry no data (e.g. standalone
# `retry:` or `id:` directives). Per the SSE spec these are valid
# but contain an empty data field; calling sse.json() on them
# raises JSONDecodeError.
if not sse.data or not sse.data.strip():
continue

# we have to special case the Assistants `thread.` events since we won't have an "event" key in the data
if sse.event and sse.event.startswith("thread."):
data = sse.json()

yield process_data(data={"data": data, "event": sse.event}, cast_to=cast_to, response=response)
else:
data = sse.json()
# Handle error events that carry an "error" event type (outside thread.* scope)
if sse.event == "error" and is_mapping(data) and data.get("error"):
message = None
error = data.get("error")
Expand All @@ -191,9 +208,6 @@ async def __stream__(self) -> AsyncIterator[_T]:
body=data["error"],
)

yield process_data(data={"data": data, "event": sse.event}, cast_to=cast_to, response=response)
else:
data = sse.json()
if is_mapping(data) and data.get("error"):
message = None
error = data.get("error")
Expand Down Expand Up @@ -238,6 +252,17 @@ async def close(self) -> None:
"""
await self.response.aclose()

async def aclose(self) -> None:
"""Async-convention alias for :meth:`close`.

Follows the standard Python async cleanup protocol used by
``asyncio.StreamWriter``, ``httpx.AsyncByteStream``, and async
generators (PEP 525), allowing callers and instrumentation libraries
to call ``await stream.aclose()`` uniformly without special-casing
this class.
"""
await self.close()


class ServerSentEvent:
def __init__(
Expand Down