Make PIE807 dict fix preview only

astral-sh · Nov 13, 2023 · b630dde · b630dde
1 parent d4af4f5
commit b630dde
Show file tree

Hide file tree

Showing 4 changed files with 160 additions and 70 deletions.
diff --git a/crates/ruff_linter/src/rules/flake8_pie/mod.rs b/crates/ruff_linter/src/rules/flake8_pie/mod.rs
@@ -9,6 +9,7 @@ mod tests {
     use test_case::test_case;
 
     use crate::registry::Rule;
+    use crate::settings::types::PreviewMode;
     use crate::test::test_path;
     use crate::{assert_messages, settings};
 
@@ -29,4 +30,22 @@ mod tests {
         assert_messages!(snapshot, diagnostics);
         Ok(())
     }
+
+    #[test_case(Rule::ReimplementedContainerBuiltin, Path::new("PIE807.py"))]
+    fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> {
+        let snapshot = format!(
+            "preview__{}_{}",
+            rule_code.noqa_code(),
+            path.to_string_lossy()
+        );
+        let diagnostics = test_path(
+            Path::new("flake8_pie").join(path).as_path(),
+            &settings::LinterSettings {
+                preview: PreviewMode::Enabled,
+                ..settings::LinterSettings::for_rule(rule_code)
+            },
+        )?;
+        assert_messages!(snapshot, diagnostics);
+        Ok(())
+    }
 }
diff --git a/crates/ruff_linter/src/rules/flake8_pie/rules/reimplemented_container_builtin.rs b/crates/ruff_linter/src/rules/flake8_pie/rules/reimplemented_container_builtin.rs
@@ -9,9 +9,11 @@ use crate::checkers::ast::Checker;
 
 /// ## What it does
 /// Checks for lambdas that can be replaced with the `list` builtin.
+/// If [preview] mode is enabled, then we will also look for lambdas
+/// that can be replaced with the `dict` builtin.
 ///
 /// ## Why is this bad?
-/// Using `list` builtin is more readable.
+/// Using container builtins is more readable.
 ///
 /// ## Example
 /// ```python
@@ -21,7 +23,6 @@ use crate::checkers::ast::Checker;
 /// @dataclass
 /// class Foo:
 ///     bar: list[int] = field(default_factory=lambda: [])
-///     baz: dict[str, int] = field(default_factory=lambda: {})
 /// ```
 ///
 /// Use instead:
@@ -35,21 +36,25 @@ use crate::checkers::ast::Checker;
 ///     baz: dict[str, int] = field(default_factory=dict)
 /// ```
 ///
+///
+/// If [preview]
 /// ## References
 /// - [Python documentation: `list`](https://docs.python.org/3/library/functions.html#func-list)
+///
+/// [preview]: https://docs.astral.sh/ruff/preview/
 #[violation]
-pub struct ReimplementedContainerBuiltin;
+pub struct ReimplementedContainerBuiltin(&'static str);
 
 impl Violation for ReimplementedContainerBuiltin {
     const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
 
     #[derive_message_formats]
     fn message(&self) -> String {
-        format!("Prefer `list` or `dict` over useless lambda")
+        format!("Prefer `{}` over useless lambda", self.0)
     }
 
     fn fix_title(&self) -> Option<String> {
-        Some("Replace with `list` or `dict`".to_string())
+        Some(format!("Replace with lambda with `{}`", self.0))
     }
 }
 
@@ -64,11 +69,16 @@ pub(crate) fn reimplemented_container_builtin(checker: &mut Checker, expr: &Expr
     if parameters.is_none() {
         let builtin = match body.as_ref() {
             Expr::List(ast::ExprList { elts, .. }) if elts.is_empty() => Some("list"),
-            Expr::Dict(ast::ExprDict { values, .. }) if values.is_empty() => Some("dict"),
+            Expr::Dict(ast::ExprDict { values, .. })
+                if values.is_empty() & checker.settings.preview.is_enabled() =>
+            {
+                Some("dict")
+            }
             _ => None,
         };
         if let Some(builtin) = builtin {
-            let mut diagnostic = Diagnostic::new(ReimplementedContainerBuiltin, expr.range());
+            let mut diagnostic =
+                Diagnostic::new(ReimplementedContainerBuiltin(builtin), expr.range());
             if checker.semantic().is_builtin(builtin) {
                 diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement(
                     builtin.to_string(),

diff --git a/...c/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE807_PIE807.py.snap b/...c/rules/flake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__PIE807_PIE807.py.snap
@@ -1,15 +1,15 @@
 ---
 source: crates/ruff_linter/src/rules/flake8_pie/mod.rs
 ---
-PIE807.py:3:44: PIE807 [*] Prefer `list` or `dict` over useless lambda
+PIE807.py:3:44: PIE807 [*] Prefer `list` over useless lambda
   |
 1 | @dataclass
 2 | class Foo:
 3 |     foo: List[str] = field(default_factory=lambda: [])  # PIE807
   |                                            ^^^^^^^^^^ PIE807
 4 |     bar: Dict[str, int] = field(default_factory=lambda: {})  # PIE807
   |
-  = help: Replace with `list` or `dict`
+  = help: Replace with lambda with `list`
 
 ℹ Safe fix
 1 1 | @dataclass
@@ -20,33 +20,14 @@ PIE807.py:3:44: PIE807 [*] Prefer `list` or `dict` over useless lambda
 5 5 | 
 6 6 | 
 
-PIE807.py:4:49: PIE807 [*] Prefer `list` or `dict` over useless lambda
-  |
-2 | class Foo:
-3 |     foo: List[str] = field(default_factory=lambda: [])  # PIE807
-4 |     bar: Dict[str, int] = field(default_factory=lambda: {})  # PIE807
-  |                                                 ^^^^^^^^^^ PIE807
-  |
-  = help: Replace with `list` or `dict`
-
-ℹ Safe fix
-1 1 | @dataclass
-2 2 | class Foo:
-3 3 |     foo: List[str] = field(default_factory=lambda: [])  # PIE807
-4   |-    bar: Dict[str, int] = field(default_factory=lambda: {})  # PIE807
-  4 |+    bar: Dict[str, int] = field(default_factory=dict)  # PIE807
-5 5 | 
-6 6 | 
-7 7 | class FooTable(BaseTable):
-
-PIE807.py:8:36: PIE807 [*] Prefer `list` or `dict` over useless lambda
+PIE807.py:8:36: PIE807 [*] Prefer `list` over useless lambda
   |
 7 | class FooTable(BaseTable):
 8 |     foo = fields.ListField(default=lambda: [])  # PIE807
   |                                    ^^^^^^^^^^ PIE807
 9 |     bar = fields.ListField(default=lambda: {})  # PIE807
   |
-  = help: Replace with `list` or `dict`
+  = help: Replace with lambda with `list`
 
 ℹ Safe fix
 5 5 | 
@@ -58,33 +39,14 @@ PIE807.py:8:36: PIE807 [*] Prefer `list` or `dict` over useless lambda
 10 10 | 
 11 11 | 
 
-PIE807.py:9:36: PIE807 [*] Prefer `list` or `dict` over useless lambda
-  |
-7 | class FooTable(BaseTable):
-8 |     foo = fields.ListField(default=lambda: [])  # PIE807
-9 |     bar = fields.ListField(default=lambda: {})  # PIE807
-  |                                    ^^^^^^^^^^ PIE807
-  |
-  = help: Replace with `list` or `dict`
-
-ℹ Safe fix
-6  6  | 
-7  7  | class FooTable(BaseTable):
-8  8  |     foo = fields.ListField(default=lambda: [])  # PIE807
-9     |-    bar = fields.ListField(default=lambda: {})  # PIE807
-   9  |+    bar = fields.ListField(default=dict)  # PIE807
-10 10 | 
-11 11 | 
-12 12 | class FooTable(BaseTable):
-
-PIE807.py:13:28: PIE807 [*] Prefer `list` or `dict` over useless lambda
+PIE807.py:13:28: PIE807 [*] Prefer `list` over useless lambda
    |
 12 | class FooTable(BaseTable):
 13 |     foo = fields.ListField(lambda: [])  # PIE807
    |                            ^^^^^^^^^^ PIE807
 14 |     bar = fields.ListField(default=lambda: {})  # PIE807
    |
-   = help: Replace with `list` or `dict`
+   = help: Replace with lambda with `list`
 
 ℹ Safe fix
 10 10 | 
@@ -96,23 +58,4 @@ PIE807.py:13:28: PIE807 [*] Prefer `list` or `dict` over useless lambda
 15 15 | 
 16 16 | 
 
-PIE807.py:14:36: PIE807 [*] Prefer `list` or `dict` over useless lambda
-   |
-12 | class FooTable(BaseTable):
-13 |     foo = fields.ListField(lambda: [])  # PIE807
-14 |     bar = fields.ListField(default=lambda: {})  # PIE807
-   |                                    ^^^^^^^^^^ PIE807
-   |
-   = help: Replace with `list` or `dict`
-
-ℹ Safe fix
-11 11 | 
-12 12 | class FooTable(BaseTable):
-13 13 |     foo = fields.ListField(lambda: [])  # PIE807
-14    |-    bar = fields.ListField(default=lambda: {})  # PIE807
-   14 |+    bar = fields.ListField(default=dict)  # PIE807
-15 15 | 
-16 16 | 
-17 17 | @dataclass
-
 
diff --git a/...lake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__preview__PIE807_PIE807.py.snap b/...lake8_pie/snapshots/ruff_linter__rules__flake8_pie__tests__preview__PIE807_PIE807.py.snap
@@ -0,0 +1,118 @@
+---
+source: crates/ruff_linter/src/rules/flake8_pie/mod.rs
+---
+PIE807.py:3:44: PIE807 [*] Prefer `list` over useless lambda
+  |
+1 | @dataclass
+2 | class Foo:
+3 |     foo: List[str] = field(default_factory=lambda: [])  # PIE807
+  |                                            ^^^^^^^^^^ PIE807
+4 |     bar: Dict[str, int] = field(default_factory=lambda: {})  # PIE807
+  |
+  = help: Replace with lambda with `list`
+
+ℹ Safe fix
+1 1 | @dataclass
+2 2 | class Foo:
+3   |-    foo: List[str] = field(default_factory=lambda: [])  # PIE807
+  3 |+    foo: List[str] = field(default_factory=list)  # PIE807
+4 4 |     bar: Dict[str, int] = field(default_factory=lambda: {})  # PIE807
+5 5 | 
+6 6 | 
+
+PIE807.py:4:49: PIE807 [*] Prefer `dict` over useless lambda
+  |
+2 | class Foo:
+3 |     foo: List[str] = field(default_factory=lambda: [])  # PIE807
+4 |     bar: Dict[str, int] = field(default_factory=lambda: {})  # PIE807
+  |                                                 ^^^^^^^^^^ PIE807
+  |
+  = help: Replace with lambda with `dict`
+
+ℹ Safe fix
+1 1 | @dataclass
+2 2 | class Foo:
+3 3 |     foo: List[str] = field(default_factory=lambda: [])  # PIE807
+4   |-    bar: Dict[str, int] = field(default_factory=lambda: {})  # PIE807
+  4 |+    bar: Dict[str, int] = field(default_factory=dict)  # PIE807
+5 5 | 
+6 6 | 
+7 7 | class FooTable(BaseTable):
+
+PIE807.py:8:36: PIE807 [*] Prefer `list` over useless lambda
+  |
+7 | class FooTable(BaseTable):
+8 |     foo = fields.ListField(default=lambda: [])  # PIE807
+  |                                    ^^^^^^^^^^ PIE807
+9 |     bar = fields.ListField(default=lambda: {})  # PIE807
+  |
+  = help: Replace with lambda with `list`
+
+ℹ Safe fix
+5 5 | 
+6 6 | 
+7 7 | class FooTable(BaseTable):
+8   |-    foo = fields.ListField(default=lambda: [])  # PIE807
+  8 |+    foo = fields.ListField(default=list)  # PIE807
+9 9 |     bar = fields.ListField(default=lambda: {})  # PIE807
+10 10 | 
+11 11 | 
+
+PIE807.py:9:36: PIE807 [*] Prefer `dict` over useless lambda
+  |
+7 | class FooTable(BaseTable):
+8 |     foo = fields.ListField(default=lambda: [])  # PIE807
+9 |     bar = fields.ListField(default=lambda: {})  # PIE807
+  |                                    ^^^^^^^^^^ PIE807
+  |
+  = help: Replace with lambda with `dict`
+
+ℹ Safe fix
+6  6  | 
+7  7  | class FooTable(BaseTable):
+8  8  |     foo = fields.ListField(default=lambda: [])  # PIE807
+9     |-    bar = fields.ListField(default=lambda: {})  # PIE807
+   9  |+    bar = fields.ListField(default=dict)  # PIE807
+10 10 | 
+11 11 | 
+12 12 | class FooTable(BaseTable):
+
+PIE807.py:13:28: PIE807 [*] Prefer `list` over useless lambda
+   |
+12 | class FooTable(BaseTable):
+13 |     foo = fields.ListField(lambda: [])  # PIE807
+   |                            ^^^^^^^^^^ PIE807
+14 |     bar = fields.ListField(default=lambda: {})  # PIE807
+   |
+   = help: Replace with lambda with `list`
+
+ℹ Safe fix
+10 10 | 
+11 11 | 
+12 12 | class FooTable(BaseTable):
+13    |-    foo = fields.ListField(lambda: [])  # PIE807
+   13 |+    foo = fields.ListField(list)  # PIE807
+14 14 |     bar = fields.ListField(default=lambda: {})  # PIE807
+15 15 | 
+16 16 | 
+
+PIE807.py:14:36: PIE807 [*] Prefer `dict` over useless lambda
+   |
+12 | class FooTable(BaseTable):
+13 |     foo = fields.ListField(lambda: [])  # PIE807
+14 |     bar = fields.ListField(default=lambda: {})  # PIE807
+   |                                    ^^^^^^^^^^ PIE807
+   |
+   = help: Replace with lambda with `dict`
+
+ℹ Safe fix
+11 11 | 
+12 12 | class FooTable(BaseTable):
+13 13 |     foo = fields.ListField(lambda: [])  # PIE807
+14    |-    bar = fields.ListField(default=lambda: {})  # PIE807
+   14 |+    bar = fields.ListField(default=dict)  # PIE807
+15 15 | 
+16 16 | 
+17 17 | @dataclass
+
+