[flake8-pyi] Implement PYI062 (duplicate-literal-member) (#11269)

crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.py

@@ -0,0 +1,21 @@
+from typing import Literal
+import typing as t
+import typing_extensions
+
+x: Literal[True, False, True, False]  # PYI062 twice here
+
+y: Literal[1, print("hello"), 3, Literal[4, 1]]  # PYI062 on the last 1
+
+z: Literal[{1, 3, 5}, "foobar", {1,3,5}]  # PYI062 on the set literal
+
+Literal[1, Literal[1]]  # once
+Literal[1, 2, Literal[1, 2]]  # twice
+Literal[1, Literal[1], Literal[1]]  # twice
+Literal[1, Literal[2], Literal[2]]  # once
+t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+typing_extensions.Literal[1, 1, 1]  # twice
+
+# Ensure issue is only raised once, even on nested literals
+MyType = Literal["foo", Literal[True, False, True], "bar"]  # PYI062
+
+n: Literal["No", "duplicates", "here", 1, "1"]

crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI062.pyi

@@ -0,0 +1,21 @@
+from typing import Literal
+import typing as t
+import typing_extensions
+
+x: Literal[True, False, True, False]  # PY062 twice here
+
+y: Literal[1, print("hello"), 3, Literal[4, 1]]  # PY062 on the last 1
+
+z: Literal[{1, 3, 5}, "foobar", {1,3,5}]  # PY062 on the set literal
+
+Literal[1, Literal[1]]  # once
+Literal[1, 2, Literal[1, 2]]  # twice
+Literal[1, Literal[1], Literal[1]]  # twice
+Literal[1, Literal[2], Literal[2]]  # once
+t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+typing_extensions.Literal[1, 1, 1]  # twice
+
+# Ensure issue is only raised once, even on nested literals
+MyType = Literal["foo", Literal[True, False, True], "bar"]  # PYI062
+
+n: Literal["No", "duplicates", "here", 1, "1"]

crates/ruff_linter/src/checkers/ast/analyze/expression.rs

@@ -97,6 +97,13 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) {
                 }
             }
 
+            // Ex) Literal[...]
+            if checker.enabled(Rule::DuplicateLiteralMember) {
+                if !checker.semantic.in_nested_literal() {
+                    flake8_pyi::rules::duplicate_literal_member(checker, expr);
+                }
+            }
+
             if checker.enabled(Rule::NeverUnion) {
                 ruff::rules::never_union(checker, expr);
             }

crates/ruff_linter/src/codes.rs

@@ -809,6 +809,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> {
         (Flake8Pyi, "056") => (RuleGroup::Stable, rules::flake8_pyi::rules::UnsupportedMethodCallOnAll),
         (Flake8Pyi, "058") => (RuleGroup::Stable, rules::flake8_pyi::rules::GeneratorReturnFromIterMethod),
         (Flake8Pyi, "059") => (RuleGroup::Preview, rules::flake8_pyi::rules::GenericNotLastBaseClass),
+        (Flake8Pyi, "062") => (RuleGroup::Preview, rules::flake8_pyi::rules::DuplicateLiteralMember),
 
         // flake8-pytest-style
         (Flake8PytestStyle, "001") => (RuleGroup::Stable, rules::flake8_pytest_style::rules::PytestFixtureIncorrectParenthesesStyle),

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

@@ -33,6 +33,8 @@ mod tests {
     #[test_case(Rule::CustomTypeVarReturnType, Path::new("PYI019.pyi"))]
     #[test_case(Rule::DocstringInStub, Path::new("PYI021.py"))]
     #[test_case(Rule::DocstringInStub, Path::new("PYI021.pyi"))]
+    #[test_case(Rule::DuplicateLiteralMember, Path::new("PYI062.py"))]
+    #[test_case(Rule::DuplicateLiteralMember, Path::new("PYI062.pyi"))]
     #[test_case(Rule::DuplicateUnionMember, Path::new("PYI016.py"))]
     #[test_case(Rule::DuplicateUnionMember, Path::new("PYI016.pyi"))]
     #[test_case(Rule::EllipsisInNonEmptyClassBody, Path::new("PYI013.py"))]

crates/ruff_linter/src/rules/flake8_pyi/rules/duplicate_literal_member.rs

@@ -0,0 +1,67 @@
+use std::collections::HashSet;
+
+use rustc_hash::FxHashSet;
+
+use ruff_diagnostics::{Diagnostic, FixAvailability, Violation};
+use ruff_macros::{derive_message_formats, violation};
+use ruff_python_ast::comparable::ComparableExpr;
+use ruff_python_ast::Expr;
+use ruff_python_semantic::analyze::typing::traverse_literal;
+use ruff_text_size::Ranged;
+
+use crate::checkers::ast::Checker;
+
+/// ## What it does
+/// Checks for duplicate members in a `typing.Literal[]` slice.
+///
+/// ## Why is this bad?
+/// Duplicate literal members are redundant and should be removed.
+///
+/// ## Example
+/// ```python
+/// foo: Literal["a", "b", "a"]
+/// ```
+///
+/// Use instead:
+/// ```python
+/// foo: Literal["a", "b"]
+/// ```
+///
+/// ## References
+/// - [Python documentation: `typing.Literal`](https://docs.python.org/3/library/typing.html#typing.Literal)
+#[violation]
+pub struct DuplicateLiteralMember {
+    duplicate_name: String,
+}
+
+impl Violation for DuplicateLiteralMember {
+    const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes;
+
+    #[derive_message_formats]
+    fn message(&self) -> String {
+        format!("Duplicate literal member `{}`", self.duplicate_name)
+    }
+}
+
+/// PYI062
+pub(crate) fn duplicate_literal_member<'a>(checker: &mut Checker, expr: &'a Expr) {
+    let mut seen_nodes: HashSet<ComparableExpr<'_>, _> = FxHashSet::default();
+    let mut diagnostics: Vec<Diagnostic> = Vec::new();
+
+    // Adds a member to `literal_exprs` if it is a `Literal` annotation
+    let mut check_for_duplicate_members = |expr: &'a Expr, _: &'a Expr| {
+        // If we've already seen this literal member, raise a violation.
+        if !seen_nodes.insert(expr.into()) {
+            diagnostics.push(Diagnostic::new(
+                DuplicateLiteralMember {
+                    duplicate_name: checker.generator().expr(expr),
+                },
+                expr.range(),
+            ));
+        }
+    };
+
+    // Traverse the literal, collect all diagnostic members
+    traverse_literal(&mut check_for_duplicate_members, checker.semantic(), expr);
+    checker.diagnostics.append(&mut diagnostics);
+}

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

@@ -6,6 +6,7 @@ pub(crate) use complex_assignment_in_stub::*;
 pub(crate) use complex_if_statement_in_stub::*;
 pub(crate) use custom_type_var_return_type::*;
 pub(crate) use docstring_in_stubs::*;
+pub(crate) use duplicate_literal_member::*;
 pub(crate) use duplicate_union_member::*;
 pub(crate) use ellipsis_in_non_empty_class_body::*;
 pub(crate) use exit_annotations::*;
@@ -45,6 +46,7 @@ mod complex_assignment_in_stub;
 mod complex_if_statement_in_stub;
 mod custom_type_var_return_type;
 mod docstring_in_stubs;
+mod duplicate_literal_member;
 mod duplicate_union_member;
 mod ellipsis_in_non_empty_class_body;
 mod exit_annotations;

crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI062_PYI062.py.snap

@@ -0,0 +1,138 @@
+---
+source: crates/ruff_linter/src/rules/flake8_pyi/mod.rs
+---
+PYI062.py:5:25: PYI062 Duplicate literal member `True`
+  |
+3 | import typing_extensions
+4 | 
+5 | x: Literal[True, False, True, False]  # PYI062 twice here
+  |                         ^^^^ PYI062
+6 | 
+7 | y: Literal[1, print("hello"), 3, Literal[4, 1]]  # PYI062 on the last 1
+  |
+
+PYI062.py:5:31: PYI062 Duplicate literal member `False`
+  |
+3 | import typing_extensions
+4 | 
+5 | x: Literal[True, False, True, False]  # PYI062 twice here
+  |                               ^^^^^ PYI062
+6 | 
+7 | y: Literal[1, print("hello"), 3, Literal[4, 1]]  # PYI062 on the last 1
+  |
+
+PYI062.py:7:45: PYI062 Duplicate literal member `1`
+  |
+5 | x: Literal[True, False, True, False]  # PYI062 twice here
+6 | 
+7 | y: Literal[1, print("hello"), 3, Literal[4, 1]]  # PYI062 on the last 1
+  |                                             ^ PYI062
+8 | 
+9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}]  # PYI062 on the set literal
+  |
+
+PYI062.py:9:33: PYI062 Duplicate literal member `{1, 3, 5}`
+   |
+ 7 | y: Literal[1, print("hello"), 3, Literal[4, 1]]  # PYI062 on the last 1
+ 8 | 
+ 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}]  # PYI062 on the set literal
+   |                                 ^^^^^^^ PYI062
+10 | 
+11 | Literal[1, Literal[1]]  # once
+   |
+
+PYI062.py:11:20: PYI062 Duplicate literal member `1`
+   |
+ 9 | z: Literal[{1, 3, 5}, "foobar", {1,3,5}]  # PYI062 on the set literal
+10 | 
+11 | Literal[1, Literal[1]]  # once
+   |                    ^ PYI062
+12 | Literal[1, 2, Literal[1, 2]]  # twice
+13 | Literal[1, Literal[1], Literal[1]]  # twice
+   |
+
+PYI062.py:12:23: PYI062 Duplicate literal member `1`
+   |
+11 | Literal[1, Literal[1]]  # once
+12 | Literal[1, 2, Literal[1, 2]]  # twice
+   |                       ^ PYI062
+13 | Literal[1, Literal[1], Literal[1]]  # twice
+14 | Literal[1, Literal[2], Literal[2]]  # once
+   |
+
+PYI062.py:12:26: PYI062 Duplicate literal member `2`
+   |
+11 | Literal[1, Literal[1]]  # once
+12 | Literal[1, 2, Literal[1, 2]]  # twice
+   |                          ^ PYI062
+13 | Literal[1, Literal[1], Literal[1]]  # twice
+14 | Literal[1, Literal[2], Literal[2]]  # once
+   |
+
+PYI062.py:13:20: PYI062 Duplicate literal member `1`
+   |
+11 | Literal[1, Literal[1]]  # once
+12 | Literal[1, 2, Literal[1, 2]]  # twice
+13 | Literal[1, Literal[1], Literal[1]]  # twice
+   |                    ^ PYI062
+14 | Literal[1, Literal[2], Literal[2]]  # once
+15 | t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+   |
+
+PYI062.py:13:32: PYI062 Duplicate literal member `1`
+   |
+11 | Literal[1, Literal[1]]  # once
+12 | Literal[1, 2, Literal[1, 2]]  # twice
+13 | Literal[1, Literal[1], Literal[1]]  # twice
+   |                                ^ PYI062
+14 | Literal[1, Literal[2], Literal[2]]  # once
+15 | t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+   |
+
+PYI062.py:14:32: PYI062 Duplicate literal member `2`
+   |
+12 | Literal[1, 2, Literal[1, 2]]  # twice
+13 | Literal[1, Literal[1], Literal[1]]  # twice
+14 | Literal[1, Literal[2], Literal[2]]  # once
+   |                                ^ PYI062
+15 | t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+16 | typing_extensions.Literal[1, 1, 1]  # twice
+   |
+
+PYI062.py:15:37: PYI062 Duplicate literal member `1`
+   |
+13 | Literal[1, Literal[1], Literal[1]]  # twice
+14 | Literal[1, Literal[2], Literal[2]]  # once
+15 | t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+   |                                     ^ PYI062
+16 | typing_extensions.Literal[1, 1, 1]  # twice
+   |
+
+PYI062.py:16:30: PYI062 Duplicate literal member `1`
+   |
+14 | Literal[1, Literal[2], Literal[2]]  # once
+15 | t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+16 | typing_extensions.Literal[1, 1, 1]  # twice
+   |                              ^ PYI062
+17 | 
+18 | # Ensure issue is only raised once, even on nested literals
+   |
+
+PYI062.py:16:33: PYI062 Duplicate literal member `1`
+   |
+14 | Literal[1, Literal[2], Literal[2]]  # once
+15 | t.Literal[1, t.Literal[2, t.Literal[1]]]  # once
+16 | typing_extensions.Literal[1, 1, 1]  # twice
+   |                                 ^ PYI062
+17 | 
+18 | # Ensure issue is only raised once, even on nested literals
+   |
+
+PYI062.py:19:46: PYI062 Duplicate literal member `True`
+   |
+18 | # Ensure issue is only raised once, even on nested literals
+19 | MyType = Literal["foo", Literal[True, False, True], "bar"]  # PYI062
+   |                                              ^^^^ PYI062
+20 | 
+21 | n: Literal["No", "duplicates", "here", 1, "1"]
+   |