fix: update timeout type hints to use TimeoutTypes for consistency #2821
+131
−28
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.
Description
This PR adds type hints for passing tuple timeouts (indirectly already supported by httpx clients) to the client and request methods, allowing for more granular control over connect, read, write, and pool timeouts without having to manually import httpx.Timeout dependency. These type hints are already present in frameworks like LangChain in their openai-langchain Python package.
Changes
TimeoutTypesinsrc/openai/_types.pyto includeTuple[Optional[float], ...].BaseClient,OpenAI,AsyncOpenAI,AzureOpenAI, andAsyncAzureOpenAIto acceptTimeoutTypesfor thetimeoutparameter.FinalRequestOptionsandmake_request_optionsto supportTimeoutTypes.tests/test_client.pyto verify tuple timeout behavior for both sync and async clients.Tests
test_request_timeout_tupleandtest_client_timeout_tupletoTestOpenAI.test_request_timeout_tupleandtest_client_timeout_tupletoTestAsyncOpenAI.