fix: async client timeout in streaming requests#2986
Open
BillionClaw wants to merge 1 commit intoopenai:mainfrom
Open
fix: async client timeout in streaming requests#2986BillionClaw wants to merge 1 commit intoopenai:mainfrom
BillionClaw wants to merge 1 commit intoopenai:mainfrom
Conversation
Add proper timeout exception handling to Stream and AsyncStream classes. When a timeout occurs during streaming iteration, it is now properly converted to APITimeoutError instead of leaking the underlying httpx.TimeoutException or asyncio.TimeoutError. Fixes openai#2373
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
1 participant
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.
Fixes #2373
Problem
When a timeout occurs during streaming iteration (not just during the initial request), the underlying
httpx.TimeoutExceptionorasyncio.TimeoutErrorwas not being properly converted toAPITimeoutError. This meant that users catchingAPITimeoutErrorwould not catch timeouts that occur while iterating over a stream.Solution
Add try-except blocks in both
Stream.__stream__()andAsyncStream.__stream__()to catch timeout exceptions and convert them toAPITimeoutError, consistent with how timeouts are handled in the base client.Changes
asyncioandAPITimeoutErrorin_streaming.pyhttpx.TimeoutExceptionhandling inStream.__stream__()httpx.TimeoutExceptionandasyncio.TimeoutErrorhandling inAsyncStream.__stream__()Testing
All existing tests pass, including the timeout-related tests in
test_client.py.