fix: validate http_client type in AsyncAPIClient#3110
Open
EaCognitive wants to merge 2 commits intoopenai:mainfrom
Open
fix: validate http_client type in AsyncAPIClient#3110EaCognitive wants to merge 2 commits intoopenai:mainfrom
EaCognitive wants to merge 2 commits intoopenai:mainfrom
Conversation
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.
Fixes #1095
Problem
When a user passes a synchronous
httpx.ClienttoAsyncOpenAIvia thehttp_clientparameter, the library crashes during a request with a crypticTypeError: object Response can't be used in 'await' expression. This happens because the SDK expects an asynchronous client and tries toawaitthe result of.send(), which in a sync client returns aResponseobject instead of a coroutine.Solution
Added a type validation check in
AsyncAPIClient.__init__. If anhttp_clientis provided, we now explicitly verify that it is an instance ofhttpx.AsyncClient. If not, we raise a clearTypeErrorduring initialization.Changes
src/openai/_base_client.py: Addedisinstancecheck forhttp_clientinAsyncAPIClient.__init__.Verification
TypeErrorinstead of crashing later with a cryptic one.