autosummary: Respect empty module __all__
#13187
Merged
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
The check for the absence of `__all__` used the `all or dir(obj)` syntax. Unfortunately, this resolves to the second value not only for `None`, but also for an empty list. This lead to the unintended behavior that setting `__all__ = []` was ignored by autosummary. Checking explicitly for None fixes this.
AA-Turner
changed the title
__all__ is ignored in autosummary__all__
AA-Turner
approved these changes
Jan 16, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: Fix #12463: empty
__all__is ignored inautosummaryFeature or Bugfix
Purpose
The check for the absence of
__all__used theall or dir(obj)syntax. Unfortunately, this resolves to the second value not only forNone, but also for an empty list. This lead to the unintended behavior that setting__all__ = []was ignored by autosummary. Checking explicitly for None fixes this.Detail
Please refer to #12463 for details on the issue and a reproducible example. The test in this PR also reproduces the behavior. It fails for the current
master, but passes with the supplied change.Relates
autosummaryignores__all__when it is empty #12463