astral-sh · zanieb · Oct 4, 2023
diff --git a/crates/ruff_cli/tests/format.rs b/crates/ruff_cli/tests/format.rs
@@ -175,7 +175,9 @@ import os
         },
         "filename": "-",
         "fix": {
-          "applicability": "Automatic",
+          "applicability": {
+            "automatic": "safe"
+          },
           "edits": [
             {
               "content": "",

diff --git a/crates/ruff_cli/tests/snapshots/integration_test__stdin_json.snap b/crates/ruff_cli/tests/snapshots/integration_test__stdin_json.snap
@@ -24,7 +24,9 @@ exit_code: 1
     },
     "filename": "/path/to/F401.py",
     "fix": {
-      "applicability": "Automatic",
+      "applicability": {
+        "automatic": "safe"
+      },
       "edits": [
         {
           "content": "",

diff --git a/crates/ruff_diagnostics/src/fix.rs b/crates/ruff_diagnostics/src/fix.rs
@@ -5,27 +5,31 @@ use ruff_text_size::{Ranged, TextSize};
 
 use crate::edit::Edit;
 
-/// Indicates confidence in the correctness of a suggested fix.
-#[derive(Default, Copy, Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
+/// Indicates if a fix can be applied.
+#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))]
 pub enum Applicability {
-    /// The fix is definitely what the user intended, or maintains the exact meaning of the code.
-    /// This fix should be automatically applied.
-    Automatic,
+    /// The fix can be applied programmatically.
+    /// The fix is likely to be correct and the resulting code will have valid syntax.
+    Automatic(Safety),
 
-    /// The fix may be what the user intended, but it is uncertain.
-    /// The fix should result in valid code if it is applied.
-    /// The fix can be applied with user opt-in.
-    Suggested,
-
-    /// The fix has a good chance of being incorrect or the code be incomplete.
-    /// The fix may result in invalid code if it is applied.
     /// The fix should only be manually applied by the user.
+    /// The fix is likely to be incorrect or the resulting code may have invalid syntax.
     Manual,
+}
 
-    /// The applicability of the fix is unknown.
-    #[default]
-    Unspecified,
+/// Indicates the safety of applying a fix.
+#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[serde(rename_all = "lowercase")]
+pub enum Safety {
+    /// The fix is definitely what the user intended, or it maintains the exact meaning of the code.
+    /// This fix can be automatically applied.
+    Safe,
+    /// The fix may be what the user intended, but it is uncertain.
+    /// The fix can be applied with user opt-in.
+    Unsafe,
 }
 
 /// Indicates the level of isolation required to apply a fix.
@@ -52,66 +56,42 @@ pub struct Fix {
 }
 
 impl Fix {
-    /// Create a new [`Fix`] with an unspecified applicability from an [`Edit`] element.
-    #[deprecated(
-        note = "Use `Fix::automatic`, `Fix::suggested`, or `Fix::manual` instead to specify an applicability."
-    )]
-    pub fn unspecified(edit: Edit) -> Self {
-        Self {
-            edits: vec![edit],
-            applicability: Applicability::Unspecified,
-            isolation_level: IsolationLevel::default(),
-        }
-    }
-
-    /// Create a new [`Fix`] with an unspecified applicability from multiple [`Edit`] elements.
-    #[deprecated(
-        note = "Use `Fix::automatic_edits`, `Fix::suggested_edits`, or `Fix::manual_edits` instead to specify an applicability."
-    )]
-    pub fn unspecified_edits(edit: Edit, rest: impl IntoIterator<Item = Edit>) -> Self {
-        Self {
-            edits: std::iter::once(edit).chain(rest).collect(),
-            applicability: Applicability::Unspecified,
-            isolation_level: IsolationLevel::default(),
-        }
-    }
-
-    /// Create a new [`Fix`] with [automatic applicability](Applicability::Automatic) from an [`Edit`] element.
-    pub fn automatic(edit: Edit) -> Self {
+    /// Create a new [`Fix`] with [safe applicability](Applicability::Automatic(Safety::Safe)) from an [`Edit`] element.
+    pub fn automatic_safe(edit: Edit) -> Self {
         Self {
             edits: vec![edit],
-            applicability: Applicability::Automatic,
+            applicability: Applicability::Automatic(Safety::Safe),
             isolation_level: IsolationLevel::default(),
         }
     }
 
-    /// Create a new [`Fix`] with [automatic applicability](Applicability::Automatic) from multiple [`Edit`] elements.
-    pub fn automatic_edits(edit: Edit, rest: impl IntoIterator<Item = Edit>) -> Self {
+    /// Create a new [`Fix`] with [safe applicability](Applicability::Automatic(Safety::Safe)) from multiple [`Edit`] elements.
+    pub fn automatic_safe_edits(edit: Edit, rest: impl IntoIterator<Item = Edit>) -> Self {
         let mut edits: Vec<Edit> = std::iter::once(edit).chain(rest).collect();
         edits.sort_by_key(|edit| (edit.start(), edit.end()));
         Self {
             edits,
-            applicability: Applicability::Automatic,
+            applicability: Applicability::Automatic(Safety::Safe),
             isolation_level: IsolationLevel::default(),
         }
     }
 
-    /// Create a new [`Fix`] with [suggested applicability](Applicability::Suggested) from an [`Edit`] element.
-    pub fn suggested(edit: Edit) -> Self {
+    /// Create a new [`Fix`] with [unsafe applicability](Applicable::Automatic(Safety::Unsafe)) from an [`Edit`] element.
+    pub fn automatic_unsafe(edit: Edit) -> Self {
         Self {
             edits: vec![edit],
-            applicability: Applicability::Suggested,
+            applicability: Applicability::Automatic(Safety::Unsafe),
             isolation_level: IsolationLevel::default(),
         }
     }
 
-    /// Create a new [`Fix`] with [suggested applicability](Applicability::Suggested) from multiple [`Edit`] elements.
-    pub fn suggested_edits(edit: Edit, rest: impl IntoIterator<Item = Edit>) -> Self {
+    /// Create a new [`Fix`] with [unsafe applicability](Applicability::Automatic(Safety::Unsafe)) from multiple [`Edit`] elements.
+    pub fn automatic_unsafe_edits(edit: Edit, rest: impl IntoIterator<Item = Edit>) -> Self {
         let mut edits: Vec<Edit> = std::iter::once(edit).chain(rest).collect();
         edits.sort_by_key(|edit| (edit.start(), edit.end()));
         Self {
             edits,
-            applicability: Applicability::Suggested,
+            applicability: Applicability::Automatic(Safety::Unsafe),
             isolation_level: IsolationLevel::default(),
         }
     }

diff --git a/crates/ruff_diagnostics/src/lib.rs b/crates/ruff_diagnostics/src/lib.rs
@@ -1,6 +1,6 @@
 pub use diagnostic::{Diagnostic, DiagnosticKind};
 pub use edit::Edit;
-pub use fix::{Applicability, Fix, IsolationLevel};
+pub use fix::{Applicability, Fix, IsolationLevel, Safety};
 pub use source_map::{SourceMap, SourceMarker};
 pub use violation::{AlwaysFixableViolation, FixAvailability, Violation};
 

diff --git a/crates/ruff_linter/src/checkers/ast/analyze/bindings.rs b/crates/ruff_linter/src/checkers/ast/analyze/bindings.rs
@@ -38,7 +38,7 @@ pub(crate) fn bindings(checker: &mut Checker) {
                             binding,
                             checker.locator,
                         )
-                        .map(Fix::automatic)
+                        .map(Fix::automatic_safe)
                     });
                 }
                 checker.diagnostics.push(diagnostic);

diff --git a/crates/ruff_linter/src/checkers/noqa.rs b/crates/ruff_linter/src/checkers/noqa.rs
@@ -110,8 +110,10 @@ pub(crate) fn check_noqa(
                         let mut diagnostic =
                             Diagnostic::new(UnusedNOQA { codes: None }, directive.range());
                         if settings.rules.should_fix(diagnostic.kind.rule()) {
-                            diagnostic
-                                .set_fix(Fix::suggested(delete_noqa(directive.range(), locator)));
+                            diagnostic.set_fix(Fix::automatic_unsafe(delete_noqa(
+                                directive.range(),
+                                locator,
+                            )));
                         }
                         diagnostics.push(diagnostic);
                     }
@@ -175,12 +177,12 @@ pub(crate) fn check_noqa(
                         );
                         if settings.rules.should_fix(diagnostic.kind.rule()) {
                             if valid_codes.is_empty() {
-                                diagnostic.set_fix(Fix::suggested(delete_noqa(
+                                diagnostic.set_fix(Fix::automatic_unsafe(delete_noqa(
                                     directive.range(),
                                     locator,
                                 )));
                             } else {
-                                diagnostic.set_fix(Fix::suggested(Edit::range_replacement(
+                                diagnostic.set_fix(Fix::automatic_unsafe(Edit::range_replacement(
                                     format!("# noqa: {}", valid_codes.join(", ")),
                                     directive.range(),
                                 )));

diff --git a/crates/ruff_linter/src/fix/mod.rs b/crates/ruff_linter/src/fix/mod.rs
@@ -151,7 +151,7 @@ mod tests {
                 // The choice of rule here is arbitrary.
                 kind: MissingNewlineAtEndOfFile.into(),
                 range: edit.range(),
-                fix: Some(Fix::unspecified(edit)),
+                fix: Some(Fix::automatic_safe(edit)),
                 parent: None,
             })
             .collect()

diff --git a/crates/ruff_linter/src/message/diff.rs b/crates/ruff_linter/src/message/diff.rs
@@ -6,7 +6,7 @@ use colored::{Color, ColoredString, Colorize, Styles};
 use ruff_text_size::{Ranged, TextRange, TextSize};
 use similar::{ChangeTag, TextDiff};
 
-use ruff_diagnostics::{Applicability, Fix};
+use ruff_diagnostics::{Applicability, Fix, Safety};
 use ruff_source_file::{OneIndexed, SourceFile};
 
 use crate::message::Message;
@@ -52,10 +52,12 @@ impl Display for Diff<'_> {
         let diff = TextDiff::from_lines(self.source_code.source_text(), &output);
 
         let message = match self.fix.applicability() {
-            Applicability::Automatic => "Fix",
-            Applicability::Suggested => "Suggested fix",
-            Applicability::Manual => "Possible fix",
-            Applicability::Unspecified => "Suggested fix", /* For backwards compatibility, unspecified fixes are 'suggested' */
+            // TODO(zanieb): Adjust this messaging once it's user-facing
+            Applicability::Automatic(safety) => match safety {
+                Safety::Safe => "Fix",
+                Safety::Unsafe => "Unsafe fix",
+            },
+            Applicability::Manual => "Manual fix",
         };
         writeln!(f, "ℹ {}", message.blue())?;
 

diff --git a/crates/ruff_linter/src/message/mod.rs b/crates/ruff_linter/src/message/mod.rs
@@ -178,7 +178,7 @@ def fibonacci(n):
             },
             TextRange::new(TextSize::from(7), TextSize::from(9)),
         )
-        .with_fix(Fix::suggested(Edit::range_deletion(TextRange::new(
+        .with_fix(Fix::automatic_unsafe(Edit::range_deletion(TextRange::new(
             TextSize::from(0),
             TextSize::from(10),
         ))));
@@ -193,7 +193,7 @@ def fibonacci(n):
             },
             TextRange::new(TextSize::from(94), TextSize::from(95)),
         )
-        .with_fix(Fix::suggested(Edit::deletion(
+        .with_fix(Fix::automatic_unsafe(Edit::deletion(
             TextSize::from(94),
             TextSize::from(99),
         )));

diff --git a/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__output.snap b/crates/ruff_linter/src/message/snapshots/ruff_linter__message__json__tests__output.snap
@@ -11,7 +11,9 @@ expression: content
     },
     "filename": "fib.py",
     "fix": {
-      "applicability": "Suggested",
+      "applicability": {
+        "automatic": "unsafe"
+      },
       "edits": [
         {
           "content": "",
@@ -43,7 +45,9 @@ expression: content
     },
     "filename": "fib.py",
     "fix": {
-      "applicability": "Suggested",
+      "applicability": {
+        "automatic": "unsafe"
+      },
       "edits": [
         {
           "content": "",

diff --git a/...es/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__output.snap b/...es/ruff_linter/src/message/snapshots/ruff_linter__message__json_lines__tests__output.snap
@@ -2,7 +2,7 @@
 source: crates/ruff_linter/src/message/json_lines.rs
 expression: content
 ---
-{"code":"F401","end_location":{"column":10,"row":1},"filename":"fib.py","fix":{"applicability":"Suggested","edits":[{"content":"","end_location":{"column":1,"row":2},"location":{"column":1,"row":1}}],"message":"Remove unused import: `os`"},"location":{"column":8,"row":1},"message":"`os` imported but unused","noqa_row":1,"url":"https://docs.astral.sh/ruff/rules/unused-import"}
-{"code":"F841","end_location":{"column":6,"row":6},"filename":"fib.py","fix":{"applicability":"Suggested","edits":[{"content":"","end_location":{"column":10,"row":6},"location":{"column":5,"row":6}}],"message":"Remove assignment to unused variable `x`"},"location":{"column":5,"row":6},"message":"Local variable `x` is assigned to but never used","noqa_row":6,"url":"https://docs.astral.sh/ruff/rules/unused-variable"}
+{"code":"F401","end_location":{"column":10,"row":1},"filename":"fib.py","fix":{"applicability":{"automatic":"unsafe"},"edits":[{"content":"","end_location":{"column":1,"row":2},"location":{"column":1,"row":1}}],"message":"Remove unused import: `os`"},"location":{"column":8,"row":1},"message":"`os` imported but unused","noqa_row":1,"url":"https://docs.astral.sh/ruff/rules/unused-import"}
+{"code":"F841","end_location":{"column":6,"row":6},"filename":"fib.py","fix":{"applicability":{"automatic":"unsafe"},"edits":[{"content":"","end_location":{"column":10,"row":6},"location":{"column":5,"row":6}}],"message":"Remove assignment to unused variable `x`"},"location":{"column":5,"row":6},"message":"Local variable `x` is assigned to but never used","noqa_row":6,"url":"https://docs.astral.sh/ruff/rules/unused-variable"}
 {"code":"F821","end_location":{"column":5,"row":1},"filename":"undef.py","fix":null,"location":{"column":4,"row":1},"message":"Undefined name `a`","noqa_row":1,"url":"https://docs.astral.sh/ruff/rules/undefined-name"}
 
diff --git a/...src/rules/eradicate/snapshots/ruff_linter__rules__eradicate__tests__ERA001_ERA001.py.snap b/...src/rules/eradicate/snapshots/ruff_linter__rules__eradicate__tests__ERA001_ERA001.py.snap
@@ -10,7 +10,7 @@ ERA001.py:1:1: ERA001 [*] Found commented-out code
   |
   = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 1   |-#import os
 2 1 | # from foo import junk
 3 2 | #a = 3
@@ -26,7 +26,7 @@ ERA001.py:2:1: ERA001 [*] Found commented-out code
   |
   = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 1 1 | #import os
 2   |-# from foo import junk
 3 2 | #a = 3
@@ -44,7 +44,7 @@ ERA001.py:3:1: ERA001 [*] Found commented-out code
   |
   = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 1 1 | #import os
 2 2 | # from foo import junk
 3   |-#a = 3
@@ -63,7 +63,7 @@ ERA001.py:5:1: ERA001 [*] Found commented-out code
   |
   = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 2 2 | # from foo import junk
 3 3 | #a = 3
 4 4 | a = 4
@@ -82,7 +82,7 @@ ERA001.py:13:5: ERA001 [*] Found commented-out code
    |
    = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 10 10 | 
 11 11 |     # This is a real comment.
 12 12 |     # # This is a (nested) comment.
@@ -100,7 +100,7 @@ ERA001.py:21:5: ERA001 [*] Found commented-out code
    |
    = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 18 18 | 
 19 19 | class A():
 20 20 |     pass
@@ -120,7 +120,7 @@ ERA001.py:26:5: ERA001 [*] Found commented-out code
    |
    = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 23 23 | 
 24 24 | dictionary = {
 25 25 |     # "key1": 123,  # noqa: ERA001
@@ -139,7 +139,7 @@ ERA001.py:27:5: ERA001 [*] Found commented-out code
    |
    = help: Remove commented-out code
 
-ℹ Possible fix
+ℹ Manual fix
 24 24 | dictionary = {
 25 25 |     # "key1": 123,  # noqa: ERA001
 26 26 |     # "key2": 456,

diff --git a/crates/ruff_linter/src/rules/flake8_annotations/rules/definition.rs b/crates/ruff_linter/src/rules/flake8_annotations/rules/definition.rs
@@ -703,7 +703,7 @@ pub(crate) fn definition(
                         function.identifier(),
                     );
                     if checker.patch(diagnostic.kind.rule()) {
-                        diagnostic.set_fix(Fix::suggested(Edit::insertion(
+                        diagnostic.set_fix(Fix::automatic_unsafe(Edit::insertion(
                             " -> None".to_string(),
                             function.parameters.range().end(),
                         )));
@@ -721,7 +721,7 @@ pub(crate) fn definition(
                 );
                 if checker.patch(diagnostic.kind.rule()) {
                     if let Some(return_type) = simple_magic_return_type(name) {
-                        diagnostic.set_fix(Fix::suggested(Edit::insertion(
+                        diagnostic.set_fix(Fix::automatic_unsafe(Edit::insertion(
                             format!(" -> {return_type}"),
                             function.parameters.range().end(),
                         )));

diff --git a/...flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__defaults.snap b/...flake8_annotations/snapshots/ruff_linter__rules__flake8_annotations__tests__defaults.snap
@@ -252,7 +252,7 @@ annotation_presence.py:159:9: ANN204 [*] Missing return type annotation for spec
     |
     = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 156 156 | 
 157 157 | class Foo:
 158 158 |     @decorator()
@@ -272,7 +272,7 @@ annotation_presence.py:165:9: ANN204 [*] Missing return type annotation for spec
     |
     = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 162 162 | 
 163 163 | # Regression test for: https://github.com/astral-sh/ruff/issues/7711
 164 164 | class Class: