[pylint] - add fix for unary expressions in PLC2801
#9587
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
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
38ee7ae
to
5a85f1d
Compare
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| PLC2801 | 96 | 48 | 0 | 0 | 48 |
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
5a85f1d
to
c1782ce
Compare
|
I see now that the |
|
@diceroll123 - Feel free to change, I won't get to this until tomorrow. |
CodSpeed Performance ReportMerging #9587 will not alter performanceComparing Summary
|
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
a825cc4
to
c49171c
Compare
MichaReiser
reviewed
Jan 26, 2024
| if let Some(fixed) = fixed { | ||
| diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement(fixed, call.range()))); | ||
| if let Some(mut fixed) = fixed { | ||
| let is_in_unary = checker |
There was a problem hiding this comment.
The section here could use a comment explaining on why we're doing what we're doing below because it's not immediately obvious what it is about.
Comment on lines
168
to
173
| let rparen = | ||
| SimpleTokenizer::starts_at(value.as_ref().end(), checker.locator().contents()) | ||
| .find(|token| { | ||
| token.kind == SimpleTokenKind::RParen && token.start() < call.end() | ||
| }); | ||
|
|
There was a problem hiding this comment.
What happens if we have a.__sub__(((((b)))))?
You can use call.arguments.start (or end) to get the parentheses offsets of the call expression and retain those.
| @@ -156,8 +157,45 @@ pub(crate) fn unnecessary_dunder_call(checker: &mut Checker, call: &ast::ExprCal | |||
| call.range(), | |||
| ); | |||
|
|
|||
| if let Some(fixed) = fixed { | |||
| diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement(fixed, call.range()))); | |||
| if let Some(mut fixed) = fixed { | |||
There was a problem hiding this comment.
I wonder if the fix produces invalid code if you have
4.__sub__(
3
+
4
)What i understand is that we fix this to
a -
3
+
4which Python doesn't like very much
| if is_in_unary { | ||
| // find the first ")" before our dunder method | ||
| let rparen = | ||
| SimpleTokenizer::starts_at(value.as_ref().end(), checker.locator().contents()) |
There was a problem hiding this comment.
Can we start after the attribute to reduce the text that need to be searched?
There was a problem hiding this comment.
Can't start after the value in this case.
We're looking for this,
(-a).__sub__(1)
###^
and the difference between
(-a).__sub__(1) and -a.__sub__(1)
It could possibly be optimized another way though, perhaps by checking the tokens between value and the first Dot 🤔
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
874ef9b
to
7f3f81d
Compare
|
Made some tweaks! First and foremost: the fix is marked as unsafe. This could be conditional with more type logic in a future iteration, for sure. The arguments within the dunder method call will now stay in parentheses if it's anything more complex than a literal/name/attribute. I'm sure that logic may be fine to expand into other expression types. So, this example: print(a.__sub__(
3
+
4
))now turns into print(a - (3
+
4
))And since you explicitly asked, print(a.__sub__(((((2 - 1))))))is now reduced to print(a - (2 - 1)) # PLC2801Semantically it's the same, regardless of extra parens. Looking forward to opinions on improving it further! 😄 |
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
9875f6a
to
525ea07
Compare
MichaReiser
reviewed
Feb 22, 2024
| let value_slice = checker.locator().slice(value.as_ref()); | ||
| let arg_slice = checker.locator().slice(arg); | ||
|
|
||
| if arg.is_attribute_expr() || arg.is_name_expr() || arg.is_literal_expr() { |
There was a problem hiding this comment.
I think we can exclude some more expressions here
- Calls
- Unary expressions
- Lambda
- If expressions (I think)?
- Dict / Set / List / Tuple and all comprehension variants (everything with parentheses)
- Generators
- Subscripts
- Starred (I think)
- Slices?
There was a problem hiding this comment.
Reworked it, added all of the above except Unary (because that's what got us this PR in the first place hah)
MichaReiser
approved these changes
Feb 22, 2024
There was a problem hiding this comment.
Sorry for the late review. The uv release took a lot of attention recently.
This is an excellent improvement. I think there are a few more situations where adding the parentheses isn't strictly necessary. You might want to move the logic into its own function to avoid coding it twice.
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
c73f701
to
c1ffe3f
Compare
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
c1ffe3f
to
b223783
Compare
diceroll123
force-pushed
the
tweak-PLC2801
branch
from
b223783
to
1a14221
Compare
nkxxll
pushed a commit
to nkxxll/ruff
that referenced
this pull request
Mar 10, 2024
## Summary Closes astral-sh#9572 Don't go easy on this review! ## Test Plan `cargo test`
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
Closes #9572
Don't go easy on this review!
Test Plan
cargo test