Unwrap decorated objects for YD01 validation check #541
Conversation
This file contains 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
jarrodmillman
approved these changes
Apr 21, 2024
rossbar
force-pushed
the
unwrap-for-validation
branch
from
2248251 to
23aaa45
Compare
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
YD01validation checks that Python generators have aYieldssection in the docstring. Currently, this check breaks down for generators that have been decorated, as outer wrapper is a function rather than a generator.This can at least be improved by traversing an objects
__wrapped__attribute until the original, unwrapped object is found, and then running theis_generator_functioncheck on that.Note that this unwrapping may be useful in other cases of docstring introspection as well, but I'm limiting it to a known, testable issue here. The added test fails on
mainfor thebarandbazcases. Other improvements related to decorator unwrapping may follow in other PRs!Additional context
networkx/networkx#7258