Rename rule

Author: wilt00

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

@@ -199,8 +199,8 @@ pub(crate) fn expression(expr: &Expr, checker: &Checker) {
             if checker.is_rule_enabled(Rule::AccessAnnotationsFromClassDict) {
                 ruff::rules::access_annotations_from_class_dict_by_key(checker, subscript);
             }
-            if checker.is_rule_enabled(Rule::NestedAnnotatedType) {
-                ruff::rules::nested_annotated_type(checker, subscript);
+            if checker.is_rule_enabled(Rule::UnionWithAnnotatedType) {
+                ruff::rules::union_with_annotated_type(checker, subscript);
             }
             pandas_vet::rules::subscript(checker, value, expr);
         }

crates/ruff_linter/src/codes.rs

@@ -1058,7 +1058,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> {
         (Ruff, "063") => rules::ruff::rules::AccessAnnotationsFromClassDict,
         (Ruff, "064") => rules::ruff::rules::NonOctalPermissions,
         (Ruff, "065") => rules::ruff::rules::LoggingEagerConversion,
-        (Ruff, "066") => rules::ruff::rules::NestedAnnotatedType,
+        (Ruff, "066") => rules::ruff::rules::UnionWithAnnotatedType,
 
         (Ruff, "100") => rules::ruff::rules::UnusedNOQA,
         (Ruff, "101") => rules::ruff::rules::RedirectedNOQA,

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

@@ -113,7 +113,7 @@ mod tests {
     #[test_case(Rule::LegacyFormPytestRaises, Path::new("RUF061_deprecated_call.py"))]
     #[test_case(Rule::NonOctalPermissions, Path::new("RUF064.py"))]
     #[test_case(Rule::LoggingEagerConversion, Path::new("RUF065.py"))]
-    #[test_case(Rule::NestedAnnotatedType, Path::new("RUF066.py"))]
+    #[test_case(Rule::UnionWithAnnotatedType, Path::new("RUF066.py"))]
     #[test_case(Rule::RedirectedNOQA, Path::new("RUF101_0.py"))]
     #[test_case(Rule::RedirectedNOQA, Path::new("RUF101_1.py"))]
     #[test_case(Rule::InvalidRuleCode, Path::new("RUF102.py"))]

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

@@ -30,7 +30,7 @@ pub(crate) use mutable_class_default::*;
 pub(crate) use mutable_dataclass_default::*;
 pub(crate) use mutable_fromkeys_value::*;
 pub(crate) use needless_else::*;
-pub(crate) use nested_annotated_type::*;
+pub(crate) use union_with_annotated_type::*;
 pub(crate) use never_union::*;
 pub(crate) use non_octal_permissions::*;
 pub(crate) use none_not_at_end_of_union::*;
@@ -95,7 +95,7 @@ mod mutable_class_default;
 mod mutable_dataclass_default;
 mod mutable_fromkeys_value;
 mod needless_else;
-mod nested_annotated_type;
+mod union_with_annotated_type;
 mod never_union;
 mod non_octal_permissions;
 mod none_not_at_end_of_union;

crates/ruff_linter/src/rules/ruff/rules/nested_annotated_type.rs renamed to crates/ruff_linter/src/rules/ruff/rules/union_with_annotated_type.rs

@@ -6,7 +6,7 @@ use crate::Violation;
 use crate::checkers::ast::Checker;
 
 /// ## What it does
-/// Checks for `Annotated[]` types nested within other subscript types or union types.
+/// Checks for `Annotated[]` types within a `Union` or `Optional` type.
 ///
 /// ## Why is this bad?
 /// Consumers of `Annotated` types often only check the top-level type for annotations,
@@ -27,28 +27,46 @@ use crate::checkers::ast::Checker;
 /// # {'a': typing.Annotated[str | None, 'test data']}
 /// ```
 ///
+/// ## Example
+/// ```python
+/// from typing import Annotated, Optional
+/// from fastapi import FastAPI, Query
+///
+/// app = FastAPI()
+///
+/// @app.get('/route')
+/// def route(param: Annotated[str, Query()] | None = None):
+///    ...
+/// ```
+/// This fails to parse `param` as a query parameter. Use instead:
+/// ```python
+/// @app.get('/route')
+/// def route(param: Annotated[str | None, Query()] = None):
+///   ...
+/// ```
+///
 #[derive(ViolationMetadata)]
-#[violation_metadata(preview_since = "0.14.3")]
-pub(crate) struct NestedAnnotatedType {
+#[violation_metadata(preview_since = "0.14.4")]
+pub(crate) struct UnionWithAnnotatedType {
     parent_type: ParentType,
 }
 
-impl Violation for NestedAnnotatedType {
+impl Violation for UnionWithAnnotatedType {
     #[derive_message_formats]
     fn message(&self) -> String {
         match self.parent_type {
             ParentType::Subscript => {
-                "`Annotated[]` type must not be nested within another type".to_string()
+                "`Annotated[]` type must not be part of a Union or Optional type".to_string()
             }
             ParentType::BinOp => {
-                "`Annotated[]` type must not be nested within a PEP604 type union (|)".to_string()
+                "`Annotated[]` type must not be part of a PEP604 type union (|)".to_string()
             }
         }
     }
 }
 
 /// RUF066
-pub(crate) fn nested_annotated_type(checker: &Checker, subscript: &ExprSubscript) {
+pub(crate) fn union_with_annotated_type(checker: &Checker, subscript: &ExprSubscript) {
     let semantic = checker.semantic();
 
     if !semantic.match_typing_expr(&subscript.value, "Annotated") {
@@ -66,7 +84,7 @@ pub(crate) fn nested_annotated_type(checker: &Checker, subscript: &ExprSubscript
         .last();
 
     if let Some((parent, parent_type)) = result {
-        checker.report_diagnostic(NestedAnnotatedType { parent_type }, parent.range());
+        checker.report_diagnostic(UnionWithAnnotatedType { parent_type }, parent.range());
     }
 }
 

crates/ruff_linter/src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__RUF066_RUF066.py.snap

@@ -1,7 +1,7 @@
 ---
 source: crates/ruff_linter/src/rules/ruff/mod.rs
 ---
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
  --> RUF066.py:4:4
   |
 3 | # Errors
@@ -11,7 +11,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 6 | c: Optional[Annotated[float, "A float"]] = 2.71
   |
 
-RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
+RUF066 `Annotated[]` type must not be part of a PEP604 type union (|)
  --> RUF066.py:5:4
   |
 3 | # Errors
@@ -22,7 +22,7 @@ RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
 7 | d: Union[Annotated[int, "An integer"], Annotated[str, "A string"]]
   |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
  --> RUF066.py:6:4
   |
 4 | a: Union[Annotated[int, "An integer"], None] = 5
@@ -32,7 +32,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 7 | d: Union[Annotated[int, "An integer"], Annotated[str, "A string"]]
   |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
  --> RUF066.py:7:4
   |
 5 | b: Annotated[Union[int, str], "An integer or string"] | None = "World"
@@ -43,7 +43,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 9 | def f1(x: Union[Annotated[int, "An integer"], None]) -> None:
   |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
  --> RUF066.py:7:4
   |
 5 | b: Annotated[Union[int, str], "An integer or string"] | None = "World"
@@ -54,7 +54,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 9 | def f1(x: Union[Annotated[int, "An integer"], None]) -> None:
   |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
   --> RUF066.py:9:11
    |
  7 | d: Union[Annotated[int, "An integer"], Annotated[str, "A string"]]
@@ -64,7 +64,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 10 |     pass
    |
 
-RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
+RUF066 `Annotated[]` type must not be part of a PEP604 type union (|)
   --> RUF066.py:12:11
    |
 10 |     pass
@@ -74,7 +74,7 @@ RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
 13 |     pass
    |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
   --> RUF066.py:15:11
    |
 13 |     pass
@@ -84,7 +84,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 16 |     pass
    |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
   --> RUF066.py:18:4
    |
 16 |     pass
@@ -95,7 +95,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 20 | l: TypeAlias = Annotated[int, "An integer"] | None
    |
 
-RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
+RUF066 `Annotated[]` type must not be part of a PEP604 type union (|)
   --> RUF066.py:20:16
    |
 18 | e: Annotated[Annotated[int, "An integer"], "Another annotation"]
@@ -106,7 +106,7 @@ RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
 22 | n: TypeAlias = Optional[Annotated[float, "A float"]]
    |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
   --> RUF066.py:21:16
    |
 20 | l: TypeAlias = Annotated[int, "An integer"] | None
@@ -116,7 +116,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 23 | o: TypeAlias = "Annotated[str, 'A string'] | None"
    |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
   --> RUF066.py:22:16
    |
 20 | l: TypeAlias = Annotated[int, "An integer"] | None
@@ -126,7 +126,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 23 | o: TypeAlias = "Annotated[str, 'A string'] | None"
    |
 
-RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
+RUF066 `Annotated[]` type must not be part of a PEP604 type union (|)
   --> RUF066.py:23:17
    |
 21 | m: TypeAlias = Union[Annotated[int, "An integer"], str]
@@ -137,7 +137,7 @@ RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
 25 | p: None | Annotated[int, "An integer"]
    |
 
-RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
+RUF066 `Annotated[]` type must not be part of a PEP604 type union (|)
   --> RUF066.py:25:4
    |
 23 | o: TypeAlias = "Annotated[str, 'A string'] | None"
@@ -148,7 +148,7 @@ RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
 27 | q = Annotated[int | str, "An integer or string"] | None
    |
 
-RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
+RUF066 `Annotated[]` type must not be part of a PEP604 type union (|)
   --> RUF066.py:27:5
    |
 25 | p: None | Annotated[int, "An integer"]
@@ -158,7 +158,7 @@ RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
 28 | r = Optional[Annotated[float | None, "A float or None"]]
    |
 
-RUF066 `Annotated[]` type must not be nested within another type
+RUF066 `Annotated[]` type must not be part of a Union or Optional type
   --> RUF066.py:28:5
    |
 27 | q = Annotated[int | str, "An integer or string"] | None
@@ -168,7 +168,7 @@ RUF066 `Annotated[]` type must not be nested within another type
 30 | @some_decorator()
    |
 
-RUF066 `Annotated[]` type must not be nested within a PEP604 type union (|)
+RUF066 `Annotated[]` type must not be part of a PEP604 type union (|)
   --> RUF066.py:31:13
    |
 30 | @some_decorator()