[flake8-pyi] Add autofix for PYI014 (#3729)

astral-sh · Mar 25, 2023 · 4a1740a · 4a1740a
1 parent 2083134
commit 4a1740a
Show file tree

Hide file tree

Showing 3 changed files with 179 additions and 66 deletions.
diff --git a/crates/ruff/src/rules/flake8_pyi/rules/simple_defaults.rs b/crates/ruff/src/rules/flake8_pyi/rules/simple_defaults.rs
@@ -1,6 +1,6 @@
 use rustpython_parser::ast::{Arguments, Constant, Expr, ExprKind, Operator, Unaryop};
 
-use ruff_diagnostics::{AlwaysAutofixableViolation, Diagnostic, Edit, Violation};
+use ruff_diagnostics::{AlwaysAutofixableViolation, Diagnostic, Edit};
 use ruff_macros::{derive_message_formats, violation};
 use ruff_python_ast::types::Range;
 
@@ -18,19 +18,23 @@ impl AlwaysAutofixableViolation for TypedArgumentDefaultInStub {
     }
 
     fn autofix_title(&self) -> String {
-        "Replace default value by `...`".to_string()
+        "Replace default value with `...`".to_string()
     }
 }
 
 #[violation]
 pub struct ArgumentDefaultInStub;
 
 /// PYI014
-impl Violation for ArgumentDefaultInStub {
+impl AlwaysAutofixableViolation for ArgumentDefaultInStub {
     #[derive_message_formats]
     fn message(&self) -> String {
         format!("Only simple default values allowed for arguments")
     }
+
+    fn autofix_title(&self) -> String {
+        "Replace default value with `...`".to_string()
+    }
 }
 
 const ALLOWED_MATH_ATTRIBUTES_IN_DEFAULTS: &[&[&str]] = &[
@@ -270,9 +274,18 @@ pub fn argument_simple_defaults(checker: &mut Checker, args: &Arguments) {
             {
                 if arg.node.annotation.is_none() {
                     if !is_valid_default_value_with_annotation(default, checker, true) {
-                        checker
-                            .diagnostics
-                            .push(Diagnostic::new(ArgumentDefaultInStub, Range::from(default)));
+                        let mut diagnostic =
+                            Diagnostic::new(ArgumentDefaultInStub, Range::from(default));
+
+                        if checker.patch(diagnostic.kind.rule()) {
+                            diagnostic.amend(Edit::replacement(
+                                "...".to_string(),
+                                default.location,
+                                default.end_location.unwrap(),
+                            ));
+                        }
+
+                        checker.diagnostics.push(diagnostic);
                     }
                 }
             }
@@ -288,9 +301,18 @@ pub fn argument_simple_defaults(checker: &mut Checker, args: &Arguments) {
             {
                 if kwarg.node.annotation.is_none() {
                     if !is_valid_default_value_with_annotation(default, checker, true) {
-                        checker
-                            .diagnostics
-                            .push(Diagnostic::new(ArgumentDefaultInStub, Range::from(default)));
+                        let mut diagnostic =
+                            Diagnostic::new(ArgumentDefaultInStub, Range::from(default));
+
+                        if checker.patch(diagnostic.kind.rule()) {
+                            diagnostic.amend(Edit::replacement(
+                                "...".to_string(),
+                                default.location,
+                                default.end_location.unwrap(),
+                            ));
+                        }
+
+                        checker.diagnostics.push(diagnostic);
                     }
                 }
             }

diff --git a/...uff/src/rules/flake8_pyi/snapshots/ruff__rules__flake8_pyi__tests__PYI011_PYI011.pyi.snap b/...uff/src/rules/flake8_pyi/snapshots/ruff__rules__flake8_pyi__tests__PYI011_PYI011.pyi.snap
@@ -5,7 +5,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 10
@@ -25,7 +25,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 38
@@ -45,7 +45,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 46
@@ -65,7 +65,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 63
@@ -85,7 +85,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 71
@@ -105,7 +105,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 78
@@ -125,7 +125,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 85
@@ -145,7 +145,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 90
@@ -165,7 +165,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 94
@@ -185,7 +185,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 98
@@ -205,7 +205,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 102
@@ -225,7 +225,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 106
@@ -245,7 +245,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 110
@@ -265,7 +265,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 138
@@ -285,7 +285,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 141
@@ -305,7 +305,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 147
@@ -325,7 +325,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 150
@@ -345,7 +345,7 @@ expression: diagnostics
 - kind:
     name: TypedArgumentDefaultInStub
     body: Only simple default values allowed for typed arguments
-    suggestion: "Replace default value by `...`"
+    suggestion: "Replace default value with `...`"
     fixable: true
   location:
     row: 159