Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/openai/lib/_parsing/_responses.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def parse_response(
for output in response.output or []:
if output.type == "message":
content_list: List[ParsedContent[TextFormatT]] = []
for item in output.content:
for item in output.content or []:
if item.type != "output_text":
content_list.append(item)
continue
Expand Down
113 changes: 113 additions & 0 deletions tests/lib/responses/test_null_content.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
from __future__ import annotations

import json

import httpx2
import pytest

from openai import OpenAI, AsyncOpenAI


def _null_content_item() -> dict[str, object]:
return {
"id": "msg_test",
"type": "message",
"role": "assistant",
"status": "completed",
"content": None,
}


def _completed_event(output: object) -> dict[str, object]:
return {
"type": "response.completed",
"sequence_number": 1,
"response": {
"id": "resp_test",
"status": "completed",
"model": "test-model",
"output": output,
},
}


def _stream_body(output: object) -> bytes:
events: list[dict[str, object]] = [
{"type": "response.created", "sequence_number": 0, "response": {"id": "resp_test", "status": "in_progress"}},
_completed_event(output),
]
return "".join(f"data: {json.dumps(event)}\n\n" for event in events).encode()


@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"])
async def test_stream_explicit_null_message_content(sync: bool) -> None:
"""An explicit completed output whose message has content:null must parse to empty content, not TypeError."""
transport = httpx2.MockTransport(
lambda _request: httpx2.Response(
200, content=_stream_body([_null_content_item()]), headers={"content-type": "text/event-stream"}
)
)
if sync:
with OpenAI(api_key="fake-test-key", http_client=httpx2.Client(transport=transport)) as client:
with client.responses.stream(model="test-model", input="test") as stream:
emitted = list(stream)
final = stream.get_final_response()
else:
async with AsyncOpenAI(
api_key="fake-test-key", http_client=httpx2.AsyncClient(transport=transport)
) as async_client:
async with async_client.responses.stream(model="test-model", input="test") as async_stream:
emitted = [event async for event in async_stream]
final = await async_stream.get_final_response()

completed = emitted[-1]
assert completed.type == "response.completed"
assert completed.response == final
assert final.output_text == ""
assert final.output_parsed is None
assert len(final.output) == 1
message = final.output[0]
assert message.type == "message"
assert message.id == "msg_test"
assert message.role == "assistant"
assert message.status == "completed"
assert message.content == []


@pytest.mark.parametrize("sync", [True, False], ids=["sync", "async"])
async def test_parse_null_message_content(sync: bool) -> None:
"""Non-streaming responses.parse must not raise TypeError on content:null either."""
body = json.dumps(
{
"id": "resp_test",
"object": "response",
"created_at": 1,
"model": "test-model",
"status": "completed",
"parallel_tool_calls": False,
"tool_choice": "auto",
"tools": [],
"output": [_null_content_item()],
}
)
transport = httpx2.MockTransport(
lambda _request: httpx2.Response(200, content=body, headers={"content-type": "application/json"})
)
if sync:
with OpenAI(api_key="fake-test-key", http_client=httpx2.Client(transport=transport)) as client:
parsed = client.responses.parse(model="test-model", input="test")
else:
async with AsyncOpenAI(
api_key="fake-test-key", http_client=httpx2.AsyncClient(transport=transport)
) as async_client:
parsed = await async_client.responses.parse(model="test-model", input="test")

assert parsed.output_text == ""
assert parsed.output_parsed is None
assert len(parsed.output) == 1
message = parsed.output[0]
assert message.type == "message"
assert message.id == "msg_test"
assert message.role == "assistant"
assert message.status == "completed"
assert message.content == []
31 changes: 30 additions & 1 deletion tests/lib/responses/test_null_output.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
from pydantic import BaseModel

from openai import OpenAI, AsyncOpenAI
from openai.types.responses import ToolParam
from openai._types import omit
from openai._models import construct_type_unchecked
from openai.types.responses import Response, ToolParam
from openai.lib._parsing._responses import parse_response


class Answer(BaseModel):
Expand Down Expand Up @@ -123,3 +126,29 @@ async def test_stream_recovers_finalized_output(sync: bool, terminal_output: str
assert tool.type == "function_call" and tool.status == "completed"
assert tool.id == "fc_test"
assert tool.parsed_arguments == {"answer": 4}


def test_parse_response_with_null_message_content() -> None:
response = construct_type_unchecked(
type_=Response,
value={
"id": "resp_test",
"status": "completed",
"output": [
{
"id": "msg_test",
"type": "message",
"role": "assistant",
"status": "completed",
"content": None,
}
],
},
)

parsed = parse_response(text_format=omit, input_tools=omit, response=response)

assert len(parsed.output) == 1
message = parsed.output[0]
assert message.type == "message"
assert message.content == []
Loading