Added use of @functools.wraps() in our decorators#283
Merged
tleonhardt merged 1 commit intomasterfrom Feb 27, 2018
Merged
Conversation
This updates a wrapper function to look like the wrapped function. This partially addresses Issue #271 where using multiple decorators can break help on subcommands, depending on the order in which the decorators are applied. This PR doesn't actually fix anything in and of itself. But it encourages the usage of @functools.wraps(). If other decorators use this, then there shouldn't be any problem. Of course, we can't control how 3rd-party libraries implement decorators. But we can at least be part of the solution instead of part of the problem.
Codecov Report
@@ Coverage Diff @@
## master #283 +/- ##
==========================================
+ Coverage 91.56% 91.57% +<.01%
==========================================
Files 1 1
Lines 1423 1424 +1
==========================================
+ Hits 1303 1304 +1
Misses 120 120
Continue to review full report at Codecov.
|
Member
Author
kotfu
approved these changes
Feb 27, 2018
Contributor
kotfu
left a comment
kotfu
left a comment
There was a problem hiding this comment.
This looks good. I guess we'll just have to hope everyone else is a good citizen.
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.
This updates our decorator wrapper functions to look like the wrapped function.
This partially addresses Issue #271 where using multiple decorators can break help on subcommands, depending on the order in which the decorators are applied.
This PR doesn't actually fix anything in and of itself. But it encourages the usage of @functools.wraps(). If other decorators use this, then there shouldn't be any problem. Of course, we can't control how 3rd-party libraries implement decorators. But we can at least be part of the solution instead of part of the problem.