FURB180: add list of base class exceptions

Author: robsdedude

crates/ruff_linter/resources/test/fixtures/refurb/FURB180.py

@@ -1,5 +1,9 @@
 import abc
+import typing
+import typing_extensions
 from abc import abstractmethod, ABCMeta
+from typing import Protocol as TProtocol
+from typing_extensions import Protocol as TEProtocol
 
 
 # Errors
@@ -32,6 +36,14 @@ class A3(B0, before_metaclass=1, metaclass=abc.ABCMeta):
     pass
 
 
+class Protocol:
+    pass
+
+
+class C1(Protocol, metaclass=ABCMeta):
+    pass
+
+
 # OK
 
 class Meta(type):
@@ -56,3 +68,23 @@ def foo(self): pass
 class A7(B0, abc.ABC, B1):
     @abstractmethod
     def foo(self): pass
+
+
+class A8(typing.Protocol, metaclass=ABCMeta):
+    @abstractmethod
+    def foo(self): pass
+
+
+class A9(typing_extensions.Protocol, metaclass=ABCMeta):
+    @abstractmethod
+    def foo(self): pass
+
+
+class A10(TProtocol, metaclass=ABCMeta):
+    @abstractmethod
+    def foo(self): pass
+
+
+class A11(TEProtocol, metaclass=ABCMeta):
+    @abstractmethod
+    def foo(self): pass

crates/ruff_linter/src/rules/refurb/mod.rs

@@ -2,6 +2,7 @@
 
 mod helpers;
 pub(crate) mod rules;
+pub mod settings;
 
 #[cfg(test)]
 mod tests {

crates/ruff_linter/src/rules/refurb/rules/metaclass_abcmeta.rs

@@ -1,4 +1,5 @@
 use itertools::Itertools;
+use rustc_hash::FxHashSet;
 
 use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix};
 use ruff_macros::{ViolationMetadata, derive_message_formats};
@@ -31,6 +32,9 @@ use crate::importer::ImportRequest;
 ///     pass
 /// ```
 ///
+/// ## Options
+/// - `lint.refurb.allow-abc-meta-bases`
+///
 /// ## References
 /// - [Python documentation: `abc.ABC`](https://docs.python.org/3/library/abc.html#abc.ABC)
 /// - [Python documentation: `abc.ABCMeta`](https://docs.python.org/3/library/abc.html#abc.ABCMeta)
@@ -69,6 +73,23 @@ pub(crate) fn metaclass_abcmeta(checker: &Checker, class_def: &StmtClassDef) {
         return;
     }
 
+    // Determine if all base classes are in the configured list of exceptions.
+    let bases: Option<FxHashSet<String>> = class_def
+        .bases()
+        .iter()
+        .map(|base| {
+            checker
+                .semantic()
+                .resolve_qualified_name(base)
+                .map(|qualified_name| qualified_name.to_string())
+        })
+        .collect();
+    if let Some(bases) = &bases {
+        if !bases.is_empty() && bases.is_subset(&checker.settings.refurb.allow_abc_meta_bases) {
+            return;
+        }
+    }
+
     let mut diagnostic = Diagnostic::new(MetaClassABCMeta, keyword.range);
 
     diagnostic.try_set_fix(|| {

crates/ruff_linter/src/rules/refurb/settings.rs

@@ -0,0 +1,41 @@
+//! Settings for the `refurb` plugin.
+
+use std::fmt;
+
+use ruff_macros::CacheKey;
+use rustc_hash::FxHashSet;
+
+use crate::display_settings;
+
+pub fn default_allow_abc_meta_bases() -> FxHashSet<String> {
+    ["typing.Protocol", "typing_extensions.Protocol"]
+        .into_iter()
+        .map(ToString::to_string)
+        .collect()
+}
+
+#[derive(Debug, Clone, CacheKey)]
+pub struct Settings {
+    pub allow_abc_meta_bases: FxHashSet<String>,
+}
+
+impl Default for Settings {
+    fn default() -> Self {
+        Self {
+            allow_abc_meta_bases: default_allow_abc_meta_bases(),
+        }
+    }
+}
+
+impl fmt::Display for Settings {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        display_settings! {
+            formatter = f,
+            namespace = "linter.refurb",
+            fields = [
+                self.allow_abc_meta_bases | set
+            ]
+        }
+        Ok(())
+    }
+}

crates/ruff_linter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB180_FURB180.py.snap

@@ -1,79 +1,97 @@
 ---
 source: crates/ruff_linter/src/rules/refurb/mod.rs
 ---
-FURB180.py:7:10: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
-  |
-5 | # Errors
-6 |
-7 | class A0(metaclass=abc.ABCMeta):
-  |          ^^^^^^^^^^^^^^^^^^^^^ FURB180
-8 |     @abstractmethod
-9 |     def foo(self): pass
-  |
-  = help: Replace with `abc.ABC`
+FURB180.py:11:10: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
+   |
+ 9 | # Errors
+10 |
+11 | class A0(metaclass=abc.ABCMeta):
+   |          ^^^^^^^^^^^^^^^^^^^^^ FURB180
+12 |     @abstractmethod
+13 |     def foo(self): pass
+   |
+   = help: Replace with `abc.ABC`
 
 ℹ Safe fix
-4 4 | 
-5 5 | # Errors
-6 6 | 
-7   |-class A0(metaclass=abc.ABCMeta):
-  7 |+class A0(abc.ABC):
-8 8 |     @abstractmethod
-9 9 |     def foo(self): pass
+8  8  | 
+9  9  | # Errors
 10 10 | 
+11    |-class A0(metaclass=abc.ABCMeta):
+   11 |+class A0(abc.ABC):
+12 12 |     @abstractmethod
+13 13 |     def foo(self): pass
+14 14 | 
 
-FURB180.py:12:10: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
+FURB180.py:16:10: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
    |
-12 | class A1(metaclass=ABCMeta):
+16 | class A1(metaclass=ABCMeta):
    |          ^^^^^^^^^^^^^^^^^ FURB180
-13 |     @abstractmethod
-14 |     def foo(self): pass
+17 |     @abstractmethod
+18 |     def foo(self): pass
    |
    = help: Replace with `abc.ABC`
 
 ℹ Safe fix
-9  9  |     def foo(self): pass
-10 10 | 
-11 11 | 
-12    |-class A1(metaclass=ABCMeta):
-   12 |+class A1(abc.ABC):
-13 13 |     @abstractmethod
-14 14 |     def foo(self): pass
+13 13 |     def foo(self): pass
+14 14 | 
 15 15 | 
+16    |-class A1(metaclass=ABCMeta):
+   16 |+class A1(abc.ABC):
+17 17 |     @abstractmethod
+18 18 |     def foo(self): pass
+19 19 | 
 
-FURB180.py:26:18: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
+FURB180.py:30:18: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
    |
-26 | class A2(B0, B1, metaclass=ABCMeta):
+30 | class A2(B0, B1, metaclass=ABCMeta):
    |                  ^^^^^^^^^^^^^^^^^ FURB180
-27 |     @abstractmethod
-28 |     def foo(self): pass
+31 |     @abstractmethod
+32 |     def foo(self): pass
    |
    = help: Replace with `abc.ABC`
 
 ℹ Safe fix
-23 23 |     pass
-24 24 | 
-25 25 | 
-26    |-class A2(B0, B1, metaclass=ABCMeta):
-   26 |+class A2(B0, B1, abc.ABC):
-27 27 |     @abstractmethod
-28 28 |     def foo(self): pass
+27 27 |     pass
+28 28 | 
 29 29 | 
+30    |-class A2(B0, B1, metaclass=ABCMeta):
+   30 |+class A2(B0, B1, abc.ABC):
+31 31 |     @abstractmethod
+32 32 |     def foo(self): pass
+33 33 | 
 
-FURB180.py:31:34: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
+FURB180.py:35:34: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
    |
-31 | class A3(B0, before_metaclass=1, metaclass=abc.ABCMeta):
+35 | class A3(B0, before_metaclass=1, metaclass=abc.ABCMeta):
    |                                  ^^^^^^^^^^^^^^^^^^^^^ FURB180
-32 |     pass
+36 |     pass
    |
    = help: Replace with `abc.ABC`
 
 ℹ Safe fix
-28 28 |     def foo(self): pass
-29 29 | 
-30 30 | 
-31    |-class A3(B0, before_metaclass=1, metaclass=abc.ABCMeta):
-   31 |+class A3(B0, abc.ABC, before_metaclass=1):
-32 32 |     pass
+32 32 |     def foo(self): pass
 33 33 | 
-34 34 |
+34 34 | 
+35    |-class A3(B0, before_metaclass=1, metaclass=abc.ABCMeta):
+   35 |+class A3(B0, abc.ABC, before_metaclass=1):
+36 36 |     pass
+37 37 | 
+38 38 | 
+
+FURB180.py:43:20: FURB180 [*] Use of `metaclass=abc.ABCMeta` to define abstract base class
+   |
+43 | class C1(Protocol, metaclass=ABCMeta):
+   |                    ^^^^^^^^^^^^^^^^^ FURB180
+44 |     pass
+   |
+   = help: Replace with `abc.ABC`
+
+ℹ Safe fix
+40 40 |     pass
+41 41 | 
+42 42 | 
+43    |-class C1(Protocol, metaclass=ABCMeta):
+   43 |+class C1(Protocol, abc.ABC):
+44 44 |     pass
+45 45 | 
+46 46 |

crates/ruff_linter/src/settings/mod.rs

@@ -20,7 +20,7 @@ use crate::rules::{
     flake8_comprehensions, flake8_copyright, flake8_errmsg, flake8_gettext,
     flake8_implicit_str_concat, flake8_import_conventions, flake8_pytest_style, flake8_quotes,
     flake8_self, flake8_tidy_imports, flake8_type_checking, flake8_unused_arguments, isort, mccabe,
-    pep8_naming, pycodestyle, pydoclint, pydocstyle, pyflakes, pylint, pyupgrade, ruff,
+    pep8_naming, pycodestyle, pydoclint, pydocstyle, pyflakes, pylint, pyupgrade, refurb, ruff,
 };
 use crate::settings::types::{CompiledPerFileIgnoreList, ExtensionMapping, FilePatternSet};
 use crate::{RuleSelector, codes, fs};
@@ -279,6 +279,7 @@ pub struct LinterSettings {
     pub pyflakes: pyflakes::settings::Settings,
     pub pylint: pylint::settings::Settings,
     pub pyupgrade: pyupgrade::settings::Settings,
+    pub refurb: refurb::settings::Settings,
     pub ruff: ruff::settings::Settings,
 }
 
@@ -448,6 +449,7 @@ impl LinterSettings {
             pyflakes: pyflakes::settings::Settings::default(),
             pylint: pylint::settings::Settings::default(),
             pyupgrade: pyupgrade::settings::Settings::default(),
+            refurb: refurb::settings::Settings::default(),
             ruff: ruff::settings::Settings::default(),
             preview: PreviewMode::default(),
             explicit_preview_rules: false,

crates/ruff_workspace/src/configuration.rs

@@ -53,7 +53,8 @@ use crate::options::{
     Flake8QuotesOptions, Flake8SelfOptions, Flake8TidyImportsOptions, Flake8TypeCheckingOptions,
     Flake8UnusedArgumentsOptions, FormatOptions, IsortOptions, LintCommonOptions, LintOptions,
     McCabeOptions, Options, Pep8NamingOptions, PyUpgradeOptions, PycodestyleOptions,
-    PydoclintOptions, PydocstyleOptions, PyflakesOptions, PylintOptions, RuffOptions,
+    PydoclintOptions, PydocstyleOptions, PyflakesOptions, PylintOptions, RefurbOptions,
+    RuffOptions,
 };
 use crate::settings::{
     EXCLUDE, FileResolverSettings, FormatterSettings, INCLUDE, LineEnding, Settings,
@@ -428,6 +429,10 @@ impl Configuration {
                     .pyupgrade
                     .map(PyUpgradeOptions::into_settings)
                     .unwrap_or_default(),
+                refurb: lint
+                    .refurb
+                    .map(RefurbOptions::into_settings)
+                    .unwrap_or_default(),
                 ruff: lint
                     .ruff
                     .map(RuffOptions::into_settings)
@@ -665,6 +670,7 @@ pub struct LintConfiguration {
     pub pyflakes: Option<PyflakesOptions>,
     pub pylint: Option<PylintOptions>,
     pub pyupgrade: Option<PyUpgradeOptions>,
+    pub refurb: Option<RefurbOptions>,
     pub ruff: Option<RuffOptions>,
 }
 
@@ -781,6 +787,7 @@ impl LintConfiguration {
             pyflakes: options.common.pyflakes,
             pylint: options.common.pylint,
             pyupgrade: options.common.pyupgrade,
+            refurb: options.refurb,
             ruff: options.ruff,
         })
     }
@@ -1178,6 +1185,7 @@ impl LintConfiguration {
             pyflakes: self.pyflakes.combine(config.pyflakes),
             pylint: self.pylint.combine(config.pylint),
             pyupgrade: self.pyupgrade.combine(config.pyupgrade),
+            refurb: self.refurb.combine(config.refurb),
             ruff: self.ruff.combine(config.ruff),
             typing_extensions: self.typing_extensions.or(config.typing_extensions),
         }