Add autofix for W605 [InvalidEscapeSequence] (#1361)

astral-sh · Dec 24, 2022 · 0dc523b · 0dc523b
1 parent 63772e3
commit 0dc523b
Show file tree

Hide file tree

Showing 6 changed files with 78 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -541,7 +541,7 @@ For more, see [pycodestyle](https://pypi.org/project/pycodestyle/2.9.1/) on PyPI
 | E902 | IOError | IOError: `...` |  |
 | E999 | SyntaxError | SyntaxError: `...` |  |
 | W292 | NoNewLineAtEndOfFile | No newline at end of file | 🛠 |
-| W605 | InvalidEscapeSequence | Invalid escape sequence: '\c' |  |
+| W605 | InvalidEscapeSequence | Invalid escape sequence: '\c' | 🛠 |
 
 ### mccabe (C90)
 

diff --git a/src/checkers/tokens.rs b/src/checkers/tokens.rs
@@ -89,7 +89,11 @@ pub fn check_tokens(
         if enforce_invalid_escape_sequence {
             if matches!(tok, Tok::String { .. }) {
                 checks.extend(pycodestyle::checks::invalid_escape_sequence(
-                    locator, start, end,
+                    locator,
+                    start,
+                    end,
+                    matches!(autofix, flags::Autofix::Enabled)
+                        && settings.fixable.contains(&CheckCode::W605),
                 ));
             }
         }

diff --git a/src/checks.rs b/src/checks.rs
@@ -2972,6 +2972,7 @@ impl CheckKind {
                 | CheckKind::GetAttrWithConstant
                 | CheckKind::ImplicitReturn
                 | CheckKind::ImplicitReturnValue
+                | CheckKind::InvalidEscapeSequence(..)
                 | CheckKind::IsLiteral
                 | CheckKind::KeyInDict(..)
                 | CheckKind::MisplacedComparisonConstant(..)

diff --git a/src/pycodestyle/checks.rs b/src/pycodestyle/checks.rs
@@ -188,6 +188,7 @@ pub fn invalid_escape_sequence(
     locator: &SourceCodeLocator,
     start: Location,
     end: Location,
+    autofix: bool,
 ) -> Vec<Check> {
     let mut checks = vec![];
 
@@ -235,13 +236,17 @@ pub fn invalid_escape_sequence(
                 };
                 let location = Location::new(start.row() + row_offset, col);
                 let end_location = Location::new(location.row(), location.column() + 2);
-                checks.push(Check::new(
+                let mut check = Check::new(
                     CheckKind::InvalidEscapeSequence(next_char),
                     Range {
                         location,
                         end_location,
                     },
-                ));
+                );
+                if autofix {
+                    check.amend(Fix::insertion(r"\".to_string(), location));
+                }
+                checks.push(check);
             }
         }
     }

diff --git a/src/pycodestyle/snapshots/ruff__pycodestyle__tests__W605_W605_0.py.snap b/src/pycodestyle/snapshots/ruff__pycodestyle__tests__W605_W605_0.py.snap
@@ -10,7 +10,14 @@ expression: checks
   end_location:
     row: 2
     column: 11
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 2
+      column: 9
+    end_location:
+      row: 2
+      column: 9
 - kind:
     InvalidEscapeSequence: "."
   location:
@@ -19,7 +26,14 @@ expression: checks
   end_location:
     row: 6
     column: 2
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 6
+      column: 0
+    end_location:
+      row: 6
+      column: 0
 - kind:
     InvalidEscapeSequence: _
   location:
@@ -28,7 +42,14 @@ expression: checks
   end_location:
     row: 11
     column: 7
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 11
+      column: 5
+    end_location:
+      row: 11
+      column: 5
 - kind:
     InvalidEscapeSequence: _
   location:
@@ -37,5 +58,12 @@ expression: checks
   end_location:
     row: 18
     column: 7
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 18
+      column: 5
+    end_location:
+      row: 18
+      column: 5
 
diff --git a/src/pycodestyle/snapshots/ruff__pycodestyle__tests__W605_W605_1.py.snap b/src/pycodestyle/snapshots/ruff__pycodestyle__tests__W605_W605_1.py.snap
@@ -10,7 +10,14 @@ expression: checks
   end_location:
     row: 2
     column: 11
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 2
+      column: 9
+    end_location:
+      row: 2
+      column: 9
 - kind:
     InvalidEscapeSequence: "."
   location:
@@ -19,7 +26,14 @@ expression: checks
   end_location:
     row: 6
     column: 2
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 6
+      column: 0
+    end_location:
+      row: 6
+      column: 0
 - kind:
     InvalidEscapeSequence: _
   location:
@@ -28,7 +42,14 @@ expression: checks
   end_location:
     row: 11
     column: 7
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 11
+      column: 5
+    end_location:
+      row: 11
+      column: 5
 - kind:
     InvalidEscapeSequence: _
   location:
@@ -37,5 +58,12 @@ expression: checks
   end_location:
     row: 18
     column: 7
-  fix: ~
+  fix:
+    content: "\\"
+    location:
+      row: 18
+      column: 5
+    end_location:
+      row: 18
+      column: 5