Skip to content

fix(openai): Avoid consuming iterables passed to the Completions API #5489

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
alexander-alderman-webb wants to merge 4 commits into
base: master
Choose a base branch
from
+77 −8
Open

fix(openai): Avoid consuming iterables passed to the Completions API #5489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6eb991
fix(openai): Avoid consuming iterables passed to Completions API
alexander-alderman-webb Feb 20, 2026
6484710
unused type ignore
alexander-alderman-webb Feb 20, 2026
2b58e65
add dict edge case
alexander-alderman-webb Feb 20, 2026
ec29f16
.
alexander-alderman-webb Feb 20, 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
25 changes: 17 additions & 8 deletions sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,13 +371,6 @@ def _set_completions_api_input_data(
_commmon_set_input_data(span, kwargs)
return

system_instructions = _get_system_instructions_completions(messages)
if len(system_instructions) > 0:
span.set_data(
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS,
json.dumps(_transform_system_instructions(system_instructions)),
)

if isinstance(messages, str):
normalized_messages = normalize_message_roles([messages]) # type: ignore
scope = sentry_sdk.get_current_scope()
Expand All @@ -390,13 +383,29 @@ def _set_completions_api_input_data(
_commmon_set_input_data(span, kwargs)
return

# dict special case following https://github.com/openai/openai-python/blob/3e0c05b84a2056870abf3bd6a5e7849020209cc3/src/openai/_utils/_transform.py#L194-L197
if not isinstance(messages, Iterable) or isinstance(messages, dict):
set_data_normalized(span, SPANDATA.GEN_AI_OPERATION_NAME, "chat")
_commmon_set_input_data(span, kwargs)
Copy link
Member

@ericapisani ericapisani Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Typo on the function name (can be cleaned up in a follow up change)

Suggested change
_commmon_set_input_data(span, kwargs)
_common_set_input_data(span, kwargs)

return

messages = list(messages)
kwargs["messages"] = messages

system_instructions = _get_system_instructions_completions(messages)
if len(system_instructions) > 0:
span.set_data(
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS,
json.dumps(_transform_system_instructions(system_instructions)),
)

non_system_messages = [
message
for message in messages
if not _is_system_instruction_completions(message)
]
if len(non_system_messages) > 0:
normalized_messages = normalize_message_roles(non_system_messages) # type: ignore
normalized_messages = normalize_message_roles(non_system_messages)
scope = sentry_sdk.get_current_scope()
messages_data = truncate_and_annotate_messages(normalized_messages, span, scope)
if messages_data is not None:
Expand Down
60 changes: 60 additions & 0 deletions tests/integrations/openai/test_openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,21 @@ def test_nonstreaming_chat_completion_no_prompts(
],
id="parts",
),
pytest.param(
iter(
[
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
],
},
{"role": "user", "content": "hello"},
]
),
id="iterator",
),
],
)
def test_nonstreaming_chat_completion(sentry_init, capture_events, messages, request):
Expand Down Expand Up @@ -335,6 +350,21 @@ async def test_nonstreaming_chat_completion_async_no_prompts(
],
id="parts",
),
pytest.param(
iter(
[
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
],
},
{"role": "user", "content": "hello"},
]
),
id="iterator",
),
],
)
async def test_nonstreaming_chat_completion_async(
Expand Down Expand Up @@ -521,6 +551,21 @@ def test_streaming_chat_completion_no_prompts(
],
id="parts",
),
pytest.param(
iter(
[
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
],
},
{"role": "user", "content": "hello"},
]
),
id="iterator",
),
],
)
def test_streaming_chat_completion(sentry_init, capture_events, messages, request):
Expand Down Expand Up @@ -757,6 +802,21 @@ async def test_streaming_chat_completion_async_no_prompts(
],
id="parts",
),
pytest.param(
iter(
[
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
],
},
{"role": "user", "content": "hello"},
]
),
id="iterator",
),
],
)
async def test_streaming_chat_completion_async(
Expand Down
Loading