[flake8-return] - Add fixes for (RET505, RET506, RET507, RET508)
#9595
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
CodSpeed Performance ReportMerging #9595 will degrade performances by 22.56%Comparing Summary
Benchmarks breakdown
|
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| RET505 | 1434 | 0 | 0 | 1434 | 0 |
| RET506 | 372 | 0 | 0 | 372 | 0 |
| RET508 | 50 | 0 | 0 | 50 | 0 |
| RET507 | 28 | 0 | 0 | 28 | 0 |
diceroll123
changed the title
flake8-return] - add fix for RET505, RET506, RET507, RET508flake8-return] - Add fixes for (RET505, RET506, RET507, RET508)
MichaReiser
approved these changes
Jan 24, 2024
There was a problem hiding this comment.
Thanks, that's a very useful fix.
I looked at the performance regression and it's caused by adjust_indentation calling into libCST. The regression is fine because it only applies to files with that specific violation. It's not that it introduces a slow down for projects that have no violations.
There's one edge case that the code isn't handling correctly but I don't think it's worth addressing. But feel free to give it a try if you want.
Would you mind adding a few more tests that demonstrate how the rule handles comments? We should then be good to merge this.
| elif_else.start() + TextSize::from(2), | ||
| ))) | ||
| } else { | ||
| let else_line_range = checker.locator().full_line_range(elif_else.start()); |
There was a problem hiding this comment.
I don't expect this to exist in practice but assuming that the else header ends on the same line as the else keyword is not always true. For example if you have.
if True:
return
else\
:\
# comment
passit then keeps :\\n # comment where it should not. We could use SimpleTokenizer to detect this but I don't think it's worth doing.
However, I think it would be good to add a few more tests that demonstrate how the fix deals with comments in different positions.
if True:
return
else:
# comment
passif True:
return
else: # comment
passThere was a problem hiding this comment.
I've tweaked it to work with that line continuation that I didn't account for, and the code now keeps all comments after the else's : 😄
MichaReiser
added
fixes
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.
Summary
add fix for RET505, RET506, RET507, RET508
Test Plan
cargo test