[flake8-pyi] Implement PYI025

crates/ruff/resources/test/fixtures/flake8_pyi/PYI025.py

@@ -0,0 +1,19 @@
+from collections.abc import Set as AbstractSet  # Ok
+
+
+from collections.abc import Set  # Ok
+
+
+from collections.abc import (
+    Container,
+    Sized,
+    Set,  # Ok
+    ValuesView
+)
+
+from collections.abc import (
+    Container,
+    Sized,
+    Set as AbstractSet,  # Ok
+    ValuesView
+)

crates/ruff/resources/test/fixtures/flake8_pyi/PYI025.pyi

@@ -0,0 +1,19 @@
+from collections.abc import Set as AbstractSet  # Ok
+
+
+from collections.abc import Set  # PYI025
+
+
+from collections.abc import (
+    Container,
+    Sized,
+    Set,  # PYI025
+    ValuesView
+)
+
+from collections.abc import (
+    Container,
+    Sized,
+    Set as AbstractSet,
+    ValuesView # Ok
+)

crates/ruff/src/checkers/ast/mod.rs

@@ -1021,12 +1021,14 @@ where
                     }
                 }
             }
-            Stmt::ImportFrom(ast::StmtImportFrom {
-                names,
-                module,
-                level,
-                range: _,
-            }) => {
+            Stmt::ImportFrom(
+                imp_from @ ast::StmtImportFrom {
+                    names,
+                    module,
+                    level,
+                    range: _,
+                },
+            ) => {
                 let module = module.as_deref();
                 let level = level.map(|level| level.to_u32());
                 if self.enabled(Rule::ModuleImportNotAtTopOfFile) {
@@ -1091,6 +1093,11 @@ where
                     }
                 }
 
+                if self.is_stub {
+                    if self.enabled(Rule::UnaliasedSetImport) {
+                        flake8_pyi::rules::unaliased_set_import(self, imp_from);
+                    }
+                }
                 for alias in names {
                     if let Some("__future__") = module {
                         let name = alias.asname.as_ref().unwrap_or(&alias.name);

crates/ruff/src/codes.rs

@@ -592,6 +592,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> {
         (Flake8Pyi, "020") => (RuleGroup::Unspecified, Rule::QuotedAnnotationInStub),
         (Flake8Pyi, "021") => (RuleGroup::Unspecified, Rule::DocstringInStub),
         (Flake8Pyi, "024") => (RuleGroup::Unspecified, Rule::CollectionsNamedTuple),
+        (Flake8Pyi, "025") => (RuleGroup::Unspecified, Rule::UnaliasedSetImport),
         (Flake8Pyi, "032") => (RuleGroup::Unspecified, Rule::AnyEqNeAnnotation),
         (Flake8Pyi, "033") => (RuleGroup::Unspecified, Rule::TypeCommentInStub),
         (Flake8Pyi, "042") => (RuleGroup::Unspecified, Rule::SnakeCaseTypeAlias),

crates/ruff/src/registry.rs

@@ -528,6 +528,7 @@ ruff_macros::register_rules!(
     rules::flake8_pyi::rules::TSuffixedTypeAlias,
     rules::flake8_pyi::rules::TypeCommentInStub,
     rules::flake8_pyi::rules::TypedArgumentDefaultInStub,
+    rules::flake8_pyi::rules::UnaliasedSetImport,
     rules::flake8_pyi::rules::UnannotatedAssignmentInStub,
     rules::flake8_pyi::rules::UnprefixedTypeParam,
     rules::flake8_pyi::rules::UnrecognizedPlatformCheck,

crates/ruff/src/rules/flake8_pyi/mod.rs

@@ -48,6 +48,8 @@ mod tests {
     #[test_case(Rule::TypeCommentInStub, Path::new("PYI033.pyi"))]
     #[test_case(Rule::TypedArgumentDefaultInStub, Path::new("PYI011.py"))]
     #[test_case(Rule::TypedArgumentDefaultInStub, Path::new("PYI011.pyi"))]
+    #[test_case(Rule::UnaliasedSetImport, Path::new("PYI025.py"))]
+    #[test_case(Rule::UnaliasedSetImport, Path::new("PYI025.pyi"))]
     #[test_case(Rule::UnannotatedAssignmentInStub, Path::new("PYI052.py"))]
     #[test_case(Rule::UnannotatedAssignmentInStub, Path::new("PYI052.pyi"))]
     #[test_case(Rule::UnprefixedTypeParam, Path::new("PYI001.py"))]

crates/ruff/src/rules/flake8_pyi/rules/mod.rs

@@ -28,6 +28,7 @@ pub(crate) use type_alias_naming::{
     snake_case_type_alias, t_suffixed_type_alias, SnakeCaseTypeAlias, TSuffixedTypeAlias,
 };
 pub(crate) use type_comment_in_stub::{type_comment_in_stub, TypeCommentInStub};
+pub(crate) use unaliased_set_import::{unaliased_set_import, UnaliasedSetImport};
 pub(crate) use unrecognized_platform::{
     unrecognized_platform, UnrecognizedPlatformCheck, UnrecognizedPlatformName,
 };
@@ -48,4 +49,5 @@ mod simple_defaults;
 mod stub_body_multiple_statements;
 mod type_alias_naming;
 mod type_comment_in_stub;
+mod unaliased_set_import;
 mod unrecognized_platform;

crates/ruff/src/rules/flake8_pyi/rules/unaliased_set_import.rs

@@ -0,0 +1,57 @@
+use crate::checkers::ast::Checker;
+use crate::registry::AsRule;
+use ruff_diagnostics::{AlwaysAutofixableViolation, Diagnostic, Edit, Fix};
+use ruff_macros::{derive_message_formats, violation};
+use rustpython_parser::ast::StmtImportFrom;
+
+/// ## What it does
+/// Checks if collections.abc.Set is imported without being aliased
+///
+/// ## Why is this bad?
+/// It is easily confused with `builtins.set`. In order to avoid this confusion it is best to alias
+/// collections.abc.Set to AbstractSet
+///
+/// ## Example
+/// ```python
+/// from collections.abc import Set
+/// ```
+///
+/// Use instead:
+/// ```python
+/// from collections.abc import Set as AbstractSet
+/// ```
+#[violation]
+pub struct UnaliasedSetImport;
+
+impl AlwaysAutofixableViolation for UnaliasedSetImport {
+    #[derive_message_formats]
+    fn message(&self) -> String {
+        format!("Always alias collections.abc.Set when importing it, so as to avoid confusion with builtins.set")
+    }
+
+    fn autofix_title(&self) -> String {
+        format!("Alias `Set` to `AbstractSet`")
+    }
+}
+
+///PYI025
+pub(crate) fn unaliased_set_import(checker: &mut Checker, stmt: &StmtImportFrom) {
+    if let Some(module_id) = &stmt.module {
+        if module_id.as_str() != "collections.abc" {
+            return;
+        }
+    }
+
+    for name in &stmt.names {
+        if name.name.as_str() == "Set" && name.asname.is_none() {
+            let mut diagnostic = Diagnostic::new(UnaliasedSetImport, name.range);
+            if checker.patch(diagnostic.kind.rule()) {
+                diagnostic.set_fix(Fix::automatic(Edit::insertion(
+                    " as AbstractSet".to_string(),
+                    name.range.end(),
+                )));
+            }
+            checker.diagnostics.push(diagnostic);
+        }
+    }
+}

crates/ruff/src/rules/flake8_pyi/snapshots/ruff__rules__flake8_pyi__tests__PYI025_PYI025.py.snap.new

@@ -0,0 +1,5 @@
+---
+source: crates/ruff/src/rules/flake8_pyi/mod.rs
+assertion_line: 67
+---
+

crates/ruff/src/rules/flake8_pyi/snapshots/ruff__rules__flake8_pyi__tests__PYI025_PYI025.pyi.snap.new

@@ -0,0 +1,43 @@
+---
+source: crates/ruff/src/rules/flake8_pyi/mod.rs
+assertion_line: 67
+---
+PYI025.pyi:4:29: PYI025 [*] Always alias collections.abc.Set when importing it, so as to avoid confusion with builtins.set
+  |
+4 | from collections.abc import Set  # PYI025
+  |                             ^^^ PYI025
+  |
+  = help: Replace `Set` with `Set as AbstractSet`
+
+ℹ Fix
+1 1 | from collections.abc import Set as AbstractSet  # Ok
+2 2 | 
+3 3 | 
+4   |-from collections.abc import Set  # PYI025
+  4 |+from collections.abc import Set as AbstractSet  # PYI025
+5 5 | 
+6 6 | 
+7 7 | from collections.abc import (
+
+PYI025.pyi:10:5: PYI025 [*] Always alias collections.abc.Set when importing it, so as to avoid confusion with builtins.set
+   |
+10 |     Container,
+11 |     Sized,
+12 |     Set,  # PYI025
+   |     ^^^ PYI025
+13 |     ValuesView
+14 | )
+   |
+   = help: Replace `Set` with `Set as AbstractSet`
+
+ℹ Fix
+7  7  | from collections.abc import (
+8  8  |     Container,
+9  9  |     Sized,
+10    |-    Set,  # PYI025
+   10 |+    Set as AbstractSet,  # PYI025
+11 11 |     ValuesView
+12 12 | )
+13 13 | 
+
+