Improve the error message for PLW0642 (#12866)

AlexWaygood · MichaReiser · commit d8ebb035911a · 2024-08-14T18:15:45.000+02:00
diff --git a/crates/ruff_linter/src/rules/pylint/rules/self_or_cls_assignment.rs b/crates/ruff_linter/src/rules/pylint/rules/self_or_cls_assignment.rs
@@ -53,7 +53,7 @@ impl Violation for SelfOrClsAssignment {
         let SelfOrClsAssignment { method_type } = self;
 
         format!(
-            "Confusing assignment to `{}` argument in {method_type} method",
+            "Reassigned `{}` variable in {method_type} method",
             method_type.arg_name(),
         )
     }
diff --git a/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0642_self_or_cls_assignment.py.snap b/crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0642_self_or_cls_assignment.py.snap
@@ -1,7 +1,7 @@
 ---
 source: crates/ruff_linter/src/rules/pylint/mod.rs
 ---
-self_or_cls_assignment.py:4:9: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:4:9: PLW0642 Reassigned `cls` variable in class method
   |
 2 |     @classmethod
 3 |     def list_fruits(cls) -> None:
@@ -12,7 +12,7 @@ self_or_cls_assignment.py:4:9: PLW0642 Confusing assignment to `cls` argument in
   |
   = help: Consider using a different variable name
 
-self_or_cls_assignment.py:5:9: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:5:9: PLW0642 Reassigned `cls` variable in class method
   |
 3 |     def list_fruits(cls) -> None:
 4 |         cls = "apple"  # PLW0642
@@ -23,7 +23,7 @@ self_or_cls_assignment.py:5:9: PLW0642 Confusing assignment to `cls` argument in
   |
   = help: Consider using a different variable name
 
-self_or_cls_assignment.py:6:9: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:6:9: PLW0642 Reassigned `cls` variable in class method
   |
 4 |         cls = "apple"  # PLW0642
 5 |         cls: Fruit = "apple"  # PLW0642
@@ -34,7 +34,7 @@ self_or_cls_assignment.py:6:9: PLW0642 Confusing assignment to `cls` argument in
   |
   = help: Consider using a different variable name
 
-self_or_cls_assignment.py:7:10: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:7:10: PLW0642 Reassigned `cls` variable in class method
   |
 5 |         cls: Fruit = "apple"  # PLW0642
 6 |         cls += "orange"  # PLW0642
@@ -45,7 +45,7 @@ self_or_cls_assignment.py:7:10: PLW0642 Confusing assignment to `cls` argument i
   |
   = help: Consider using a different variable name
 
-self_or_cls_assignment.py:8:9: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:8:9: PLW0642 Reassigned `cls` variable in class method
    |
  6 |         cls += "orange"  # PLW0642
  7 |         *cls = "banana"  # PLW0642
@@ -56,7 +56,7 @@ self_or_cls_assignment.py:8:9: PLW0642 Confusing assignment to `cls` argument in
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:9:16: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:9:16: PLW0642 Reassigned `cls` variable in class method
    |
  7 |         *cls = "banana"  # PLW0642
  8 |         cls, blah = "apple", "orange"  # PLW0642
@@ -66,7 +66,7 @@ self_or_cls_assignment.py:9:16: PLW0642 Confusing assignment to `cls` argument i
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:10:16: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:10:16: PLW0642 Reassigned `cls` variable in class method
    |
  8 |         cls, blah = "apple", "orange"  # PLW0642
  9 |         blah, (cls, blah2) = "apple", ("orange", "banana")  # PLW0642
@@ -77,7 +77,7 @@ self_or_cls_assignment.py:10:16: PLW0642 Confusing assignment to `cls` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:14:9: PLW0642 Confusing assignment to `cls` argument in class method
+self_or_cls_assignment.py:14:9: PLW0642 Reassigned `cls` variable in class method
    |
 12 |     @classmethod
 13 |     def add_fruits(cls, fruits, /) -> None:
@@ -88,7 +88,7 @@ self_or_cls_assignment.py:14:9: PLW0642 Confusing assignment to `cls` argument i
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:17:9: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:17:9: PLW0642 Reassigned `self` variable in instance method
    |
 16 |     def print_color(self) -> None:
 17 |         self = "red"  # PLW0642
@@ -98,7 +98,7 @@ self_or_cls_assignment.py:17:9: PLW0642 Confusing assignment to `self` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:18:9: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:18:9: PLW0642 Reassigned `self` variable in instance method
    |
 16 |     def print_color(self) -> None:
 17 |         self = "red"  # PLW0642
@@ -109,7 +109,7 @@ self_or_cls_assignment.py:18:9: PLW0642 Confusing assignment to `self` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:19:9: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:19:9: PLW0642 Reassigned `self` variable in instance method
    |
 17 |         self = "red"  # PLW0642
 18 |         self: Self = "red"  # PLW0642
@@ -120,7 +120,7 @@ self_or_cls_assignment.py:19:9: PLW0642 Confusing assignment to `self` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:20:10: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:20:10: PLW0642 Reassigned `self` variable in instance method
    |
 18 |         self: Self = "red"  # PLW0642
 19 |         self += "blue"  # PLW0642
@@ -131,7 +131,7 @@ self_or_cls_assignment.py:20:10: PLW0642 Confusing assignment to `self` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:21:9: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:21:9: PLW0642 Reassigned `self` variable in instance method
    |
 19 |         self += "blue"  # PLW0642
 20 |         *self = "blue"  # PLW0642
@@ -142,7 +142,7 @@ self_or_cls_assignment.py:21:9: PLW0642 Confusing assignment to `self` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:22:16: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:22:16: PLW0642 Reassigned `self` variable in instance method
    |
 20 |         *self = "blue"  # PLW0642
 21 |         self, blah = "red", "blue"  # PLW0642
@@ -152,7 +152,7 @@ self_or_cls_assignment.py:22:16: PLW0642 Confusing assignment to `self` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:23:16: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:23:16: PLW0642 Reassigned `self` variable in instance method
    |
 21 |         self, blah = "red", "blue"  # PLW0642
 22 |         blah, (self, blah2) = "apple", ("orange", "banana")  # PLW0642
@@ -163,7 +163,7 @@ self_or_cls_assignment.py:23:16: PLW0642 Confusing assignment to `self` argument
    |
    = help: Consider using a different variable name
 
-self_or_cls_assignment.py:26:9: PLW0642 Confusing assignment to `self` argument in instance method
+self_or_cls_assignment.py:26:9: PLW0642 Reassigned `self` variable in instance method
    |
 25 |     def print_color(self, color, /) -> None:
 26 |         self = color

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ impl Violation for SelfOrClsAssignment {`
`53`	`53`	`let SelfOrClsAssignment { method_type } = self;`
`54`	`54`
`55`	`55`	`format!(`
`56`		- "Confusing assignment to `{}` argument in {method_type} method",
	`56`	+ "Reassigned `{}` variable in {method_type} method",
`57`	`57`	`method_type.arg_name(),`
`58`	`58`	`)`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`---`
`2`	`2`	`source: crates/ruff_linter/src/rules/pylint/mod.rs`
`3`	`3`	`---`
`4`		-self_or_cls_assignment.py:4:9: PLW0642 Confusing assignment to `cls` argument in class method
	`4`	+self_or_cls_assignment.py:4:9: PLW0642 Reassigned `cls` variable in class method
`5`	`5`	`\|`
`6`	`6`	`2 \| @classmethod`
`7`	`7`	`3 \| def list_fruits(cls) -> None:`
@@ -12,7 +12,7 @@ self_or_cls_assignment.py:4:9: PLW0642 Confusing assignment to `cls` argument in
`12`	`12`	`\|`
`13`	`13`	`= help: Consider using a different variable name`
`14`	`14`
`15`		-self_or_cls_assignment.py:5:9: PLW0642 Confusing assignment to `cls` argument in class method
	`15`	+self_or_cls_assignment.py:5:9: PLW0642 Reassigned `cls` variable in class method
`16`	`16`	`\|`
`17`	`17`	`3 \| def list_fruits(cls) -> None:`
`18`	`18`	`4 \| cls = "apple" # PLW0642`
@@ -23,7 +23,7 @@ self_or_cls_assignment.py:5:9: PLW0642 Confusing assignment to `cls` argument in
`23`	`23`	`\|`
`24`	`24`	`= help: Consider using a different variable name`
`25`	`25`
`26`		-self_or_cls_assignment.py:6:9: PLW0642 Confusing assignment to `cls` argument in class method
	`26`	+self_or_cls_assignment.py:6:9: PLW0642 Reassigned `cls` variable in class method
`27`	`27`	`\|`
`28`	`28`	`4 \| cls = "apple" # PLW0642`
`29`	`29`	`5 \| cls: Fruit = "apple" # PLW0642`
@@ -34,7 +34,7 @@ self_or_cls_assignment.py:6:9: PLW0642 Confusing assignment to `cls` argument in
`34`	`34`	`\|`
`35`	`35`	`= help: Consider using a different variable name`
`36`	`36`
`37`		-self_or_cls_assignment.py:7:10: PLW0642 Confusing assignment to `cls` argument in class method
	`37`	+self_or_cls_assignment.py:7:10: PLW0642 Reassigned `cls` variable in class method
`38`	`38`	`\|`
`39`	`39`	`5 \| cls: Fruit = "apple" # PLW0642`
`40`	`40`	`6 \| cls += "orange" # PLW0642`
@@ -45,7 +45,7 @@ self_or_cls_assignment.py:7:10: PLW0642 Confusing assignment to `cls` argument i
`45`	`45`	`\|`
`46`	`46`	`= help: Consider using a different variable name`
`47`	`47`
`48`		-self_or_cls_assignment.py:8:9: PLW0642 Confusing assignment to `cls` argument in class method
	`48`	+self_or_cls_assignment.py:8:9: PLW0642 Reassigned `cls` variable in class method
`49`	`49`	`\|`
`50`	`50`	`6 \| cls += "orange" # PLW0642`
`51`	`51`	`7 \| *cls = "banana" # PLW0642`
@@ -56,7 +56,7 @@ self_or_cls_assignment.py:8:9: PLW0642 Confusing assignment to `cls` argument in
`56`	`56`	`\|`
`57`	`57`	`= help: Consider using a different variable name`
`58`	`58`
`59`		-self_or_cls_assignment.py:9:16: PLW0642 Confusing assignment to `cls` argument in class method
	`59`	+self_or_cls_assignment.py:9:16: PLW0642 Reassigned `cls` variable in class method
`60`	`60`	`\|`
`61`	`61`	`7 \| *cls = "banana" # PLW0642`
`62`	`62`	`8 \| cls, blah = "apple", "orange" # PLW0642`
@@ -66,7 +66,7 @@ self_or_cls_assignment.py:9:16: PLW0642 Confusing assignment to `cls` argument i
`66`	`66`	`\|`
`67`	`67`	`= help: Consider using a different variable name`
`68`	`68`
`69`		-self_or_cls_assignment.py:10:16: PLW0642 Confusing assignment to `cls` argument in class method
	`69`	+self_or_cls_assignment.py:10:16: PLW0642 Reassigned `cls` variable in class method
`70`	`70`	`\|`
`71`	`71`	`8 \| cls, blah = "apple", "orange" # PLW0642`
`72`	`72`	`9 \| blah, (cls, blah2) = "apple", ("orange", "banana") # PLW0642`
@@ -77,7 +77,7 @@ self_or_cls_assignment.py:10:16: PLW0642 Confusing assignment to `cls` argument
`77`	`77`	`\|`
`78`	`78`	`= help: Consider using a different variable name`
`79`	`79`
`80`		-self_or_cls_assignment.py:14:9: PLW0642 Confusing assignment to `cls` argument in class method
	`80`	+self_or_cls_assignment.py:14:9: PLW0642 Reassigned `cls` variable in class method
`81`	`81`	`\|`
`82`	`82`	`12 \| @classmethod`
`83`	`83`	`13 \| def add_fruits(cls, fruits, /) -> None:`
@@ -88,7 +88,7 @@ self_or_cls_assignment.py:14:9: PLW0642 Confusing assignment to `cls` argument i
`88`	`88`	`\|`
`89`	`89`	`= help: Consider using a different variable name`
`90`	`90`
`91`		-self_or_cls_assignment.py:17:9: PLW0642 Confusing assignment to `self` argument in instance method
	`91`	+self_or_cls_assignment.py:17:9: PLW0642 Reassigned `self` variable in instance method
`92`	`92`	`\|`
`93`	`93`	`16 \| def print_color(self) -> None:`
`94`	`94`	`17 \| self = "red" # PLW0642`
@@ -98,7 +98,7 @@ self_or_cls_assignment.py:17:9: PLW0642 Confusing assignment to `self` argument
`98`	`98`	`\|`
`99`	`99`	`= help: Consider using a different variable name`
`100`	`100`
`101`		-self_or_cls_assignment.py:18:9: PLW0642 Confusing assignment to `self` argument in instance method
	`101`	+self_or_cls_assignment.py:18:9: PLW0642 Reassigned `self` variable in instance method
`102`	`102`	`\|`
`103`	`103`	`16 \| def print_color(self) -> None:`
`104`	`104`	`17 \| self = "red" # PLW0642`
@@ -109,7 +109,7 @@ self_or_cls_assignment.py:18:9: PLW0642 Confusing assignment to `self` argument
`109`	`109`	`\|`
`110`	`110`	`= help: Consider using a different variable name`
`111`	`111`
`112`		-self_or_cls_assignment.py:19:9: PLW0642 Confusing assignment to `self` argument in instance method
	`112`	+self_or_cls_assignment.py:19:9: PLW0642 Reassigned `self` variable in instance method
`113`	`113`	`\|`
`114`	`114`	`17 \| self = "red" # PLW0642`
`115`	`115`	`18 \| self: Self = "red" # PLW0642`
@@ -120,7 +120,7 @@ self_or_cls_assignment.py:19:9: PLW0642 Confusing assignment to `self` argument
`120`	`120`	`\|`
`121`	`121`	`= help: Consider using a different variable name`
`122`	`122`
`123`		-self_or_cls_assignment.py:20:10: PLW0642 Confusing assignment to `self` argument in instance method
	`123`	+self_or_cls_assignment.py:20:10: PLW0642 Reassigned `self` variable in instance method
`124`	`124`	`\|`
`125`	`125`	`18 \| self: Self = "red" # PLW0642`
`126`	`126`	`19 \| self += "blue" # PLW0642`
@@ -131,7 +131,7 @@ self_or_cls_assignment.py:20:10: PLW0642 Confusing assignment to `self` argument
`131`	`131`	`\|`
`132`	`132`	`= help: Consider using a different variable name`
`133`	`133`
`134`		-self_or_cls_assignment.py:21:9: PLW0642 Confusing assignment to `self` argument in instance method
	`134`	+self_or_cls_assignment.py:21:9: PLW0642 Reassigned `self` variable in instance method
`135`	`135`	`\|`
`136`	`136`	`19 \| self += "blue" # PLW0642`
`137`	`137`	`20 \| *self = "blue" # PLW0642`
@@ -142,7 +142,7 @@ self_or_cls_assignment.py:21:9: PLW0642 Confusing assignment to `self` argument
`142`	`142`	`\|`
`143`	`143`	`= help: Consider using a different variable name`
`144`	`144`
`145`		-self_or_cls_assignment.py:22:16: PLW0642 Confusing assignment to `self` argument in instance method
	`145`	+self_or_cls_assignment.py:22:16: PLW0642 Reassigned `self` variable in instance method
`146`	`146`	`\|`
`147`	`147`	`20 \| *self = "blue" # PLW0642`
`148`	`148`	`21 \| self, blah = "red", "blue" # PLW0642`
@@ -152,7 +152,7 @@ self_or_cls_assignment.py:22:16: PLW0642 Confusing assignment to `self` argument
`152`	`152`	`\|`
`153`	`153`	`= help: Consider using a different variable name`
`154`	`154`
`155`		-self_or_cls_assignment.py:23:16: PLW0642 Confusing assignment to `self` argument in instance method
	`155`	+self_or_cls_assignment.py:23:16: PLW0642 Reassigned `self` variable in instance method
`156`	`156`	`\|`
`157`	`157`	`21 \| self, blah = "red", "blue" # PLW0642`
`158`	`158`	`22 \| blah, (self, blah2) = "apple", ("orange", "banana") # PLW0642`
@@ -163,7 +163,7 @@ self_or_cls_assignment.py:23:16: PLW0642 Confusing assignment to `self` argument
`163`	`163`	`\|`
`164`	`164`	`= help: Consider using a different variable name`
`165`	`165`
`166`		-self_or_cls_assignment.py:26:9: PLW0642 Confusing assignment to `self` argument in instance method
	`166`	+self_or_cls_assignment.py:26:9: PLW0642 Reassigned `self` variable in instance method
`167`	`167`	`\|`
`168`	`168`	`25 \| def print_color(self, color, /) -> None:`
`169`	`169`	`26 \| self = color`