Update applicability messages for clarity in tests (#8541)

These names are only ever displayed internally right now and we could be clearer in our test snapshots. The diff is kind of scary because all of the tests fixtures are updated.
astral-sh · Nov 7, 2023 · 7873ca3 · 7873ca3
1 parent 7dabc45
commit 7873ca3
Show file tree

Hide file tree

Showing 523 changed files with 3,085 additions and 3,086 deletions.
diff --git a/crates/ruff_diagnostics/src/fix.rs b/crates/ruff_diagnostics/src/fix.rs
@@ -12,7 +12,7 @@ use crate::edit::Edit;
 pub enum Applicability {
     /// The fix is unsafe and should only be displayed for manual application by the user.
     /// The fix is likely to be incorrect or the resulting code may have invalid syntax.
-    Display,
+    DisplayOnly,
 
     /// The fix is unsafe and should only be applied with user opt-in.
     /// The fix may be what the user intended, but it is uncertain; the resulting code will have valid syntax.
@@ -87,22 +87,22 @@ impl Fix {
         }
     }
 
-    /// Create a new [`Fix`] that should only [display](Applicability::Display) and not apply from an [`Edit`] element .
-    pub fn display_edit(edit: Edit) -> Self {
+    /// Create a new [`Fix`] that should only [display](Applicability::DisplayOnly) and not apply from an [`Edit`] element .
+    pub fn display_only_edit(edit: Edit) -> Self {
         Self {
             edits: vec![edit],
-            applicability: Applicability::Display,
+            applicability: Applicability::DisplayOnly,
             isolation_level: IsolationLevel::default(),
         }
     }
 
-    /// Create a new [`Fix`] that should only [display](Applicability::Display) and not apply from multiple [`Edit`] elements.
-    pub fn display_edits(edit: Edit, rest: impl IntoIterator<Item = Edit>) -> Self {
+    /// Create a new [`Fix`] that should only [display](Applicability::DisplayOnly) and not apply from multiple [`Edit`] elements.
+    pub fn display_only_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::Display,
+            applicability: Applicability::DisplayOnly,
             isolation_level: IsolationLevel::default(),
         }
     }

diff --git a/crates/ruff_linter/src/message/diff.rs b/crates/ruff_linter/src/message/diff.rs
@@ -54,9 +54,9 @@ impl Display for Diff<'_> {
 
         let message = match self.fix.applicability() {
             // TODO(zanieb): Adjust this messaging once it's user-facing
-            Applicability::Safe => "Fix",
-            Applicability::Unsafe => "Suggested fix",
-            Applicability::Display => "Possible fix",
+            Applicability::Safe => "Safe fix",
+            Applicability::Unsafe => "Unsafe fix",
+            Applicability::DisplayOnly => "Display-only fix",
         };
         writeln!(f, "ℹ {}", message.blue())?;
 

diff --git a/crates/ruff_linter/src/rules/eradicate/rules/commented_out_code.rs b/crates/ruff_linter/src/rules/eradicate/rules/commented_out_code.rs
@@ -66,7 +66,7 @@ pub(crate) fn commented_out_code(
         if is_standalone_comment(line) && comment_contains_code(line, &settings.task_tags[..]) {
             let mut diagnostic = Diagnostic::new(CommentedOutCode, *range);
 
-            diagnostic.set_fix(Fix::display_edit(Edit::range_deletion(
+            diagnostic.set_fix(Fix::display_only_edit(Edit::range_deletion(
                 locator.full_lines_range(*range),
             )));
             diagnostics.push(diagnostic);

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
+ℹ Display-only 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
+ℹ Display-only 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
+ℹ Display-only 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
+ℹ Display-only 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
+ℹ Display-only 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
+ℹ Display-only 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
+ℹ Display-only 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
+ℹ Display-only fix
 24 24 | dictionary = {
 25 25 |     # "key1": 123,  # noqa: ERA001
 26 26 |     # "key2": 456,

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:

diff --git a/...nnotations/snapshots/ruff_linter__rules__flake8_annotations__tests__mypy_init_return.snap b/...nnotations/snapshots/ruff_linter__rules__flake8_annotations__tests__mypy_init_return.snap
@@ -11,7 +11,7 @@ mypy_init_return.py:5:9: ANN204 [*] Missing return type annotation for special m
   |
   = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 2 2 | 
 3 3 | # Error
 4 4 | class Foo:
@@ -31,7 +31,7 @@ mypy_init_return.py:11:9: ANN204 [*] Missing return type annotation for special
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 8  8  | 
 9  9  | # Error
 10 10 | class Foo:
@@ -59,7 +59,7 @@ mypy_init_return.py:47:9: ANN204 [*] Missing return type annotation for special
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 44 44 | # Error – used to be ok for a moment since the mere presence
 45 45 | # of a vararg falsely indicated that the function has a typed argument.
 46 46 | class Foo:

diff --git a/...ations/snapshots/ruff_linter__rules__flake8_annotations__tests__simple_magic_methods.snap b/...ations/snapshots/ruff_linter__rules__flake8_annotations__tests__simple_magic_methods.snap
@@ -10,7 +10,7 @@ simple_magic_methods.py:2:9: ANN204 [*] Missing return type annotation for speci
   |
   = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 1 1 | class Foo:
 2   |-    def __str__(self):
   2 |+    def __str__(self) -> str:
@@ -28,7 +28,7 @@ simple_magic_methods.py:5:9: ANN204 [*] Missing return type annotation for speci
   |
   = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 2 2 |     def __str__(self):
 3 3 |         ...
 4 4 | 
@@ -48,7 +48,7 @@ simple_magic_methods.py:8:9: ANN204 [*] Missing return type annotation for speci
   |
   = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 5 5 |     def __repr__(self):
 6 6 |         ...
 7 7 | 
@@ -68,7 +68,7 @@ simple_magic_methods.py:11:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 8  8  |     def __len__(self):
 9  9  |         ...
 10 10 | 
@@ -88,7 +88,7 @@ simple_magic_methods.py:14:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 11 11 |     def __length_hint__(self):
 12 12 |         ...
 13 13 | 
@@ -108,7 +108,7 @@ simple_magic_methods.py:17:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 14 14 |     def __init__(self):
 15 15 |         ...
 16 16 | 
@@ -128,7 +128,7 @@ simple_magic_methods.py:20:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 17 17 |     def __del__(self):
 18 18 |         ...
 19 19 | 
@@ -148,7 +148,7 @@ simple_magic_methods.py:23:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 20 20 |     def __bool__(self):
 21 21 |         ...
 22 22 | 
@@ -168,7 +168,7 @@ simple_magic_methods.py:26:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 23 23 |     def __bytes__(self):
 24 24 |         ...
 25 25 | 
@@ -188,7 +188,7 @@ simple_magic_methods.py:29:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 26 26 |     def __format__(self, format_spec):
 27 27 |         ...
 28 28 | 
@@ -208,7 +208,7 @@ simple_magic_methods.py:32:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 29 29 |     def __contains__(self, item):
 30 30 |         ...
 31 31 | 
@@ -228,7 +228,7 @@ simple_magic_methods.py:35:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 32 32 |     def __complex__(self):
 33 33 |         ...
 34 34 | 
@@ -248,7 +248,7 @@ simple_magic_methods.py:38:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 35 35 |     def __int__(self):
 36 36 |         ...
 37 37 | 
@@ -268,7 +268,7 @@ simple_magic_methods.py:41:9: ANN204 [*] Missing return type annotation for spec
    |
    = help: Add `None` return type
 
-ℹ Suggested fix
+ℹ Unsafe fix
 38 38 |     def __float__(self):
 39 39 |         ...
 40 40 | 

diff --git a/...les/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B004_B004.py.snap b/...les/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B004_B004.py.snap
@@ -12,7 +12,7 @@ B004.py:3:8: B004 [*] Using `hasattr(x, "__call__")` to test if x is callable is
   |
   = help: Replace with `callable()`
 
-ℹ Fix
+ℹ Safe fix
 1 1 | def this_is_a_bug():
 2 2 |     o = object()
 3   |-    if hasattr(o, "__call__"):

diff --git a/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.py.snap b/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_1.py.snap
@@ -12,7 +12,7 @@ B006_1.py:3:22: B006 [*] Do not use mutable data structures for argument default
   |
   = help: Replace with `None`; initialize within function
 
-ℹ Suggested fix
+ℹ Unsafe fix
 1 1 | # Docstring followed by a newline
 2 2 | 
 3   |-def foobar(foor, bar={}):    

diff --git a/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_2.py.snap b/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_2.py.snap
@@ -12,7 +12,7 @@ B006_2.py:4:22: B006 [*] Do not use mutable data structures for argument default
   |
   = help: Replace with `None`; initialize within function
 
-ℹ Suggested fix
+ℹ Unsafe fix
 1 1 | # Docstring followed by whitespace with no newline
 2 2 | # Regression test for https://github.com/astral-sh/ruff/issues/7155
 3 3 | 

diff --git a/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_3.py.snap b/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_3.py.snap
@@ -10,7 +10,7 @@ B006_3.py:4:22: B006 [*] Do not use mutable data structures for argument default
   |
   = help: Replace with `None`; initialize within function
 
-ℹ Suggested fix
+ℹ Unsafe fix
 1 1 | # Docstring with no newline
 2 2 | 
 3 3 | 

diff --git a/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_4.py.snap b/...s/flake8_bugbear/snapshots/ruff_linter__rules__flake8_bugbear__tests__B006_B006_4.py.snap
@@ -10,7 +10,7 @@ B006_4.py:7:26: B006 [*] Do not use mutable data structures for argument default
   |
   = help: Replace with `None`; initialize within function
 
-ℹ Suggested fix
+ℹ Unsafe fix
 4  4  | 
 5  5  | 
 6  6  | class FormFeedIndent: