[Python] Add __all__ variable in the package __init__.py file for Python APIs#21185
Merged
wing328 merged 3 commits intoOpenAPITools:masterfrom May 7, 2025
Merged
[Python] Add __all__ variable in the package __init__.py file for Python APIs#21185wing328 merged 3 commits intoOpenAPITools:masterfrom
wing328 merged 3 commits intoOpenAPITools:masterfrom
Conversation
Member
|
please follow step 3 to fix https://github.com/OpenAPITools/openapi-generator/actions/runs/14741549462/job/41394125780?pr=21185 |
Contributor
Author
Sorry I missed to add those after the latest update to remove the blank line! Should be fixed now. Thanks for reviewing! |
Contributor
Author
|
@wing328 is there anything else needed to merge this? Let me know and I can take a look. |
Member
|
python 3.8 test failure can be ignored as these tests have been removed in the latest master |
Member
|
thanks for the PR 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.
Hi team!
This PR is to address #17152. The way the package
__init__.pyfile is done works at runtime but type checkers break because with the package being marked withpy.typedall those imports are considered private.The pyright type checker (behind the pylance language server for python in VSCode) has a good explanation about this in their docs. This makes that packages using API clients build with
openapi-generatoreither need to have very verbose imports to import from the module the classes are defined in (turning the__init__.pyimport not usable) or have to disable the checker rules which can be undesired in some cases.In order to fix it I have added the generation of the
__all__variable in the package__init__.pyfile that specifies the packages being exported explicitely. Type checkers now understand this and would not complaint about these imports.The PR is against master because this has no impact in runtime so any API generate with this included or not will behave the same with the difference that type checks now would understand imports like
Thanks!
CC: @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)