fix(streaming): Move error event handling outside thread.* condition#2804
Open
jay-dhamale wants to merge 1 commit intoopenai:mainfrom
Open
fix(streaming): Move error event handling outside thread.* condition#2804jay-dhamale wants to merge 1 commit intoopenai:mainfrom
jay-dhamale wants to merge 1 commit intoopenai:mainfrom
Conversation
Fixes openai#2796 The error handling logic for `sse.event == "error"` was incorrectly nested inside the `if sse.event.startswith("thread.")` condition, making it logically unreachable (dead code). A string cannot both equal "error" AND start with "thread." simultaneously. This was a regression introduced in commit abc2596 which attempted to fix indentation but accidentally moved the error handler into the wrong conditional block. The fix restructures the logic to: 1. Check for error events first (before any event type routing) 2. Handle thread.* events with their special data structure 3. Handle all other events in the else block This ensures error events are properly caught and raise APIError with the appropriate error message.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #2796 - Removes dead code in streaming error handling
Problem
The error handling logic for
sse.event == "error"was incorrectly nested inside theif sse.event.startswith("thread.")condition at:Stream.__stream__methodAsyncStream.__stream__methodThis made the error handling code logically unreachable (dead code) because a string cannot simultaneously:
Root Cause
Regression introduced in commit
abc25966which fixed indentation but accidentally moved the error handler from an else branch into the thread.* condition block.Solution
Restructured the conditional logic to:
sse.event == "error"FIRST (before any event type routing)thread.*events with their special data structure formatThis ensures error events are properly caught and raise
APIErrorwith the appropriate error message.Changes
src/openai/_streaming.py:StreamandAsyncStreamclassesTesting
ruff check .)ruff format)Test Plan