fix: Add __all__ in __init__.py files#501
Merged
ValerianRey merged 3 commits intomainfrom Dec 27, 2025
Merged
Conversation
ValerianRey
added
the
cc: fix
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
Contributor
|
LGTM, this deserves a release. |
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
2 participants
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.
When using torchjd in VSCode with PyLance, I had warnings telling me that my imports were incorrect. I think this is because we didn't have the
__all__list of publicly exported things. Technically,__all__is supposed to define what can be imported with wildcard imports (e.g.from torchjd import *), and it shouldn't be necessary for normal imports. I previously didn't want to add the__all__list because it's easy to forget to add one element to such a list. However, if we remove the line'--per-file-ignores=*/__init__.py:F401', # Ignore module imported but unused problems in __init__.py files.from.pre-commit-config.yaml, the linter will warn us whenever we import something in__init__.pyand it's not in the list. So I also removed that line as a safeguard.I think working with PyLance is quite common so this is important IMO. I'll make a release with it if you agree @PierreQuinton.