Use functools.wraps with decorators #52599
Merged
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
Otherwise, we're not fully wrapping the function so expected attributes (at least __opts__ anyway) go missing. Fixes saltstack#44639
s0undt3ch
approved these changes
Apr 18, 2019
During testing I also discovered that `_ignores_kwargs` was also missing the @wraps decorator. Now it has it.
dwoz
approved these changes
Apr 18, 2019
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.
What does this PR do?
Otherwise, we're not fully wrapping the function so expected attributes
(at least opts anyway) go missing.
What issues does this PR fix or reference?
Fixes #44639
Previous Behavior
See #44639, but basically, any function that was
_decoratedwithwith_deprecatedoris_deprecatedwill 🔥 💥 when set as a prereq, because we're introspecting the function to get__opts__, but because we're hitting the decorator instead of the original function it goes down like a lead zeppelin.New Behavior
Now that the
_decoratedfunction usesfunctools.wraps, proper introspection is proper and leads to the original function instead of_decorated🙌Tests written?
No(t yet?) - I'm not exactly sure what (if any) the best test would be here
Commits signed with GPG?
Yes