DOC/API: set __qualname__ when using class factory #17525
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
In patheffects.py we have a helper function to reduce the
boiler plate in defining the path effect sub-classes. We are setting
the `__name__` and `__doc__` to (templated) values, but were not
setting the `__qualname__` which was leaving the string '<locals>' in
the `__qualname__`. This string is then used by sphinx-gallery to
generate an index of examples that use a given class with files named
like `f'{obj.__qualname__}.examples'` which works correctly (but not
in the way we want) on liunx but fails on windows as `<>` are
forbidden in file names.-
This sets the `__qualname__` to match the `__name__` and fully
simulate defining these classes in the module.
|
#15515 is not in 3.2... |
|
Fair! I must have miss-read the follows / precedes information in the git logs. |
story645
approved these changes
May 28, 2020
anntzer
approved these changes
May 28, 2020
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.
PR Summary
In patheffects.py we have a helper function to reduce the
boiler plate in defining the path effect sub-classes. We are setting
the
__name__and__doc__to (templated) values, but were notsetting the
__qualname__which was leaving the string '' inthe
__qualname__. This string is then used by sphinx-gallery togenerate an index of examples that use a given class with files named
like
f'{obj.__qualname__}.examples'which works correctly (but notin the way we want) on liunx but fails on windows as
<>areforbidden in file names.-
This sets the
__qualname__to match the__name__and fullysimulate defining these classes in the module.
The changes that broke this came in via #15515