fix(python): improve type annotation of the retries config key#23590
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom Apr 20, 2026
Merged
fix(python): improve type annotation of the retries config key#23590wing328 merged 1 commit intoOpenAPITools:masterfrom
retries config key#23590wing328 merged 1 commit intoOpenAPITools:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
1 issue found across 7 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="samples/openapi3/client/petstore/python-httpx/petstore_api/configuration.py">
<violation number="1" location="samples/openapi3/client/petstore/python-httpx/petstore_api/configuration.py:280">
P2: `retries` parameter docs are stale and now contradict the updated `Optional[int]` constructor type, incorrectly referencing `aiohttp_retry` in the httpx client.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Contributor
Author
Contributor
|
@Gungy2 I have started the AI code review. It will take a few minutes to complete. |
Member
|
thanks for the contribution. lgtm. let's give it a try |
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.
The
retriesparameter in the Python client'sConfiguration.__init__was typed asOptional[Union[int, Any]], which collapses toOptional[Any]and provides no useful type information to IDEs or type checkers.The actual accepted types differ by HTTP library:
intorurllib3.util.retry.Retryintoraiohttp_retry.RetryOptionsBaseintonly (retries not supported)This change updates
configuration.mustacheto emit the correct type per library variant, and addsimport aiohttp_retryfor the asyncio case. All generated sample files are updated to match.Since this is a Python change, I will tag the technical committee:
@cbornet @tomplus @krjakbrjak @fa0311 @multani
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Fixes the Python client’s
retriesconfig typing to be transport-specific instead ofOptional[Any], improving IDE hints and type checking forurllib3,aiohttp, andhttpx.Configuration.__init__:urllib3→Optional[Union[int, urllib3.util.retry.Retry]],aiohttp→Optional[Union[int, aiohttp_retry.RetryOptionsBase]],httpx→Optional[int].import aiohttp_retryand update param docs to match each transport.configuration.mustacheand regenerate affected samples.Written for commit 2edabf0. Summary will update on new commits.