[pylint] Implement rule to prefer augmented assignment (PLR6104)#9932
Merged
charliermarsh merged 5 commits intoastral-sh:mainfrom Apr 12, 2024
Merged
Conversation
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| PLR6104 | 506 | 506 | 0 | 0 | 0 |
| PLR0914 | 2 | 1 | 1 | 0 | 0 |
c3255c5 to
2241be2
Compare
CodSpeed Performance ReportMerging #9932 will not alter performanceComparing Summary
|
0bc73ac to
6fbedf6
Compare
Contributor
|
Not a rust dev, so I won't comment on your implementation, but I think the tests should also check for proper handling of order of operation: >>> test = 2
>>> test = test * test + 10 # OK
>>> test
14
>>> test = 2
>>> test *= test + 10
>>> test
24
>>> test = 2
>>> test = test * (test + 10) # RUF028
>>> test
24 |
Contributor
Author
|
Thanks for the quick reply. I added the suggested test cases. I had these two test cases in my earlier draft, but wasn’t sure and removed them. It is nice that you brought them up and have them back. |
Contributor
|
Related pylint rule: Related issue: #970 @lshi18 instead of assigning it to RUF028, this rule should be placed under PyLint R6104. |
8bd617a to
6e57b2c
Compare
Contributor
Author
|
The new rule has been moved under PLR6104 instead of RUF028. |
Contributor
Author
|
The |
sbrugman
reviewed
Feb 18, 2024
| checker: &mut Checker, | ||
| assign @ ast::StmtAssign { value, targets, .. }: &ast::StmtAssign, | ||
| ) { | ||
| if targets.len() != 1 { |
Contributor
There was a problem hiding this comment.
Using let-else here to make this check a bit nicer:
let target = Some(targets.first()) else {
return;
}
Contributor
Author
There was a problem hiding this comment.
Please correct me if I am wrong, but do you mean
let Some(target) = target.first() else {
return;
}I agree that this looks nicer if it could be changed to it.
I don't think, in this case, that they are semantically equal. In particular, the following test case which is marked as OK fails after the suggested change.
a_number = index = a_number + 1 # OKI think a further question would be whether we should detect the above case and, in the same gist, the one below.
index = a_number = a_number + 1 # OK
Contributor
There was a problem hiding this comment.
My bad, I hadn't tested. Since targets is a vector, this should work:
let targets = vec![1];
// let targets = vec![1, 2];
// let targets: Vec<i32> = vec![];
let &[target] = targets.as_slice() else{
return;
};
Contributor
Author
There was a problem hiding this comment.
I had a quick test with pylint 3.0.3, whose R6104 rule detects this
a_number = index = a_number + 1 # OKbut not this,
index = a_number = a_number + 1 # OKDo you think we should implement to reproduce this effect?
BTW, the test cases for this rule in the pylint project include neither of the above cases, so I think the current behaviour is a side-effect of implementation.
Meanwhile, my current implementation is incorrect regarding handling more complex subsript / attribute expressions. I'll reimplement it while also taking into consideration of your other suggestions .
sbrugman
reviewed
Feb 18, 2024
| } | ||
| let target = targets.first().unwrap(); | ||
|
|
||
| let rhs_expr = value |
Contributor
There was a problem hiding this comment.
let (left_operand, operator, right_operand) = Some(
value
.as_bin_op_expr()
.map(|e| (e.left.as_ref(), e.op, e.right.as_ref()))
) else {
return;
}See let
sbrugman
reviewed
Feb 18, 2024
| } | ||
| let (left_operand, operator, right_operand) = rhs_expr.unwrap(); | ||
|
|
||
| if name_expr(target, left_operand) |
Contributor
There was a problem hiding this comment.
Instead of testing these conditions, you could match the target/left_operand type with match.
There may be some other rules to serve as inspiration e.g.
pylint] Implement rule to prefer augmented assignment (PLR6104)
charliermarsh
approved these changes
Apr 12, 2024
840ef33 to
5afd7de
Compare
Glyphack
pushed a commit
to Glyphack/ruff
that referenced
this pull request
Apr 12, 2024
…stral-sh#9932) ## Summary Implement new rule: Prefer augmented assignment (astral-sh#8877). It checks for the assignment statement with the form of `<expr> = <expr> <binary-operator> …` with a unsafe fix to use augmented assignment instead. ## Test Plan 1. Snapshot test is included in the PR. 2. Manually test with playground.
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
4 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.
Summary
Implement new rule: Prefer augmented assignment (#8877). It checks for the assignment statement with the form of
<expr> = <expr> <binary-operator> …with a unsafe fix to use augmented assignment instead.Test Plan