Skip to content

fix(responses): initialize null streaming output before accumulating items #3881

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
Chirag-Bhardwaj wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −3
Open

fix(responses): initialize null streaming output before accumulating items #3881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion src/openai/lib/streaming/responses/_responses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,8 @@ def _create_initial_response(self, event: RawResponseStreamEvent) -> ParsedRespo
raise RuntimeError(f"Expected to have received `response.created` before `{event.type}`")

snapshot = construct_type_unchecked(type_=ParsedResponseSnapshot, value=event.response.to_dict())
if getattr(snapshot, "output", None) is None:
snapshot.output = []
# Stream indexes can have gaps when a provider emits an empty added event.
self._output_items = dict(enumerate(snapshot.output or []))
self._output_items = dict(enumerate(snapshot.output))
return snapshot
9 changes: 7 additions & 2 deletions tests/lib/responses/test_null_output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@ class Answer(BaseModel):


@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"])
@pytest.mark.parametrize("initial_output", ["null", "missing", "empty"])
@pytest.mark.parametrize("terminal_output", ["null", "missing", "empty", "present"])
@pytest.mark.parametrize("has_items", [True, False], ids=["with-items", "without-items"])
async def test_stream_recovers_finalized_output(sync: bool, terminal_output: str, has_items: bool) -> None:
async def test_stream_recovers_finalized_output(
sync: bool, initial_output: str, terminal_output: str, has_items: bool
) -> None:
items: list[dict[str, object]] = (
[
{
Expand Down Expand Up @@ -54,7 +57,9 @@ async def test_stream_recovers_finalized_output(sync: bool, terminal_output: str
if has_items
else []
)
response: dict[str, object] = {"id": "resp_test", "status": "in_progress", "output": []}
response: dict[str, object] = {"id": "resp_test", "status": "in_progress"}
if initial_output != "missing":
response["output"] = None if initial_output == "null" else []
events: list[dict[str, object]] = [{"type": "response.created", "response": response}]
for index, item in enumerate(items):
added = {**item, "status": "in_progress"}
Expand Down