Add rst backticks rule to pygrep-hooks

README.md

@@ -1039,6 +1039,7 @@ For more, see [pygrep-hooks](https://github.com/pre-commit/pygrep-hooks) on GitH
 | PGH002 | DeprecatedLogWarn | `warn` is deprecated in favor of `warning` |  |
 | PGH003 | BlanketTypeIgnore | Use specific error codes when ignoring type issues |  |
 | PGH004 | BlanketNOQA | Use specific error codes when using `noqa` |  |
+| PGH005 | RstBackticks | Use two backticks when writing RST |  |
 
 ### Pylint (PLC, PLE, PLR, PLW)
 

resources/test/fixtures/pygrep-hooks/PGH005_0.py

@@ -0,0 +1,10 @@
+def fn() -> None:
+    """
+     ``[code]``
+    i like _`kitty`
+    i like `kitty`_
+    ``b``
+    ``ef``
+        indented `literal` blocks
+    """
+    return None

resources/test/fixtures/pygrep-hooks/PGH005_1.py

@@ -0,0 +1,11 @@
+def fn() -> None:
+    """
+    `[code]`
+    i like `_kitty`
+    i like `_`
+    `a`
+    `cd`
+     `indented` literal block
+    > quoted `literal` block
+    """
+    return None

ruff.schema.json

@@ -762,6 +762,7 @@
         "PGH002",
         "PGH003",
         "PGH004",
+        "PGH005",
         "PIE",
         "PIE7",
         "PIE79",

src/checkers/lines.rs

@@ -1,7 +1,7 @@
 //! Lint rules based on checking raw physical lines.
 
 use crate::pycodestyle::checks::{line_too_long, no_newline_at_end_of_file};
-use crate::pygrep_hooks::plugins::{blanket_noqa, blanket_type_ignore};
+use crate::pygrep_hooks::plugins::{blanket_noqa, blanket_type_ignore, rst_backticks};
 use crate::pyupgrade::checks::unnecessary_coding_comment;
 use crate::registry::{Check, CheckCode};
 use crate::settings::{flags, Settings};
@@ -19,6 +19,7 @@ pub fn check_lines(
     let enforce_no_newline_at_end_of_file = settings.enabled.contains(&CheckCode::W292);
     let enforce_blanket_type_ignore = settings.enabled.contains(&CheckCode::PGH003);
     let enforce_blanket_noqa = settings.enabled.contains(&CheckCode::PGH004);
+    let enforce_rst_backticks = settings.enabled.contains(&CheckCode::PGH005);
 
     let mut commented_lines_iter = commented_lines.iter().peekable();
     for (index, line) in contents.lines().enumerate() {
@@ -54,6 +55,14 @@ pub fn check_lines(
                     }
                 }
             }
+
+            if enforce_rst_backticks {
+                if commented_lines.contains(&(index + 1)) {
+                    if let Some(check) = rst_backticks(index, line) {
+                        checks.push(check);
+                    }
+                }
+            }
         }
 
         if enforce_line_too_long {

src/pygrep_hooks/mod.rs

@@ -18,6 +18,8 @@ mod tests {
     #[test_case(CheckCode::PGH002, Path::new("PGH002_1.py"); "PGH002_1")]
     #[test_case(CheckCode::PGH003, Path::new("PGH003_0.py"); "PGH003_0")]
     #[test_case(CheckCode::PGH004, Path::new("PGH004_0.py"); "PGH004_0")]
+    #[test_case(CheckCode::PGH005, Path::new("PGH005_0.py"); "PGH005_0")]
+    #[test_case(CheckCode::PGH005, Path::new("PGH005_1.py"); "PGH005_1")]
     fn checks(check_code: CheckCode, path: &Path) -> Result<()> {
         let snapshot = format!("{}_{}", check_code.as_ref(), path.to_string_lossy());
         let checks = test_path(

src/pygrep_hooks/plugins/mod.rs

@@ -2,8 +2,10 @@ pub use blanket_noqa::blanket_noqa;
 pub use blanket_type_ignore::blanket_type_ignore;
 pub use deprecated_log_warn::deprecated_log_warn;
 pub use no_eval::no_eval;
+pub use rst_backticks::rst_backticks;
 
 mod blanket_noqa;
 mod blanket_type_ignore;
 mod deprecated_log_warn;
 mod no_eval;
+mod rst_backticks;

src/pygrep_hooks/plugins/rst_backticks.rs

@@ -0,0 +1,22 @@
+use once_cell::sync::Lazy;
+use regex::Regex;
+use rustpython_ast::Location;
+
+use crate::ast::types::Range;
+use crate::registry::{Check, CheckKind};
+
+static RST_BACKTICKS_REGEX: Lazy<Regex> =
+    Lazy::new(|| Regex::new(r"^(?!    ).*(^| )`[^`]+`([^_]|$)").unwrap());
+
+/// PGH005 - Use two backticks when writing RST
+pub fn rst_backticks(lineno: usize, line: &str) -> Option<Check> {
+    RST_BACKTICKS_REGEX.find(line).map(|m| {
+        Check::new(
+            CheckKind::RstBackticks,
+            Range::new(
+                Location::new(lineno + 1, m.start()),
+                Location::new(lineno + 1, m.end()),
+            ),
+        )
+    })
+}

src/pygrep_hooks/snapshots/ruff__pygrep_hooks__tests__PGH005_PGH005_0.py.snap

@@ -0,0 +1,6 @@
+---
+source: src/pygrep_hooks/mod.rs
+expression: checks
+---
+[]
+

src/pygrep_hooks/snapshots/ruff__pygrep_hooks__tests__PGH005_PGH005_1.py.snap

@@ -0,0 +1,6 @@
+---
+source: src/pygrep_hooks/mod.rs
+expression: checks
+---
+[]
+

src/registry.rs

@@ -349,6 +349,7 @@ pub enum CheckCode {
     PGH002,
     PGH003,
     PGH004,
+    PGH005,
     // pandas-vet
     PD002,
     PD003,
@@ -1061,6 +1062,7 @@ pub enum CheckKind {
     DeprecatedLogWarn,
     BlanketTypeIgnore,
     BlanketNOQA,
+    RstBackticks,
     // flake8-unused-arguments
     UnusedFunctionArgument(String),
     UnusedMethodArgument(String),
@@ -1144,7 +1146,8 @@ impl CheckCode {
             | CheckCode::W292
             | CheckCode::UP009
             | CheckCode::PGH003
-            | CheckCode::PGH004 => &LintSource::Lines,
+            | CheckCode::PGH004
+            | CheckCode::PGH005 => &LintSource::Lines,
             CheckCode::ERA001
             | CheckCode::ISC001
             | CheckCode::ISC002
@@ -1507,6 +1510,7 @@ impl CheckCode {
             CheckCode::PGH002 => CheckKind::DeprecatedLogWarn,
             CheckCode::PGH003 => CheckKind::BlanketTypeIgnore,
             CheckCode::PGH004 => CheckKind::BlanketNOQA,
+            CheckCode::PGH005 => CheckKind::RstBackticks,
             // flake8-unused-arguments
             CheckCode::ARG001 => CheckKind::UnusedFunctionArgument("...".to_string()),
             CheckCode::ARG002 => CheckKind::UnusedMethodArgument("...".to_string()),
@@ -1836,6 +1840,7 @@ impl CheckCode {
             CheckCode::PGH002 => CheckCategory::PygrepHooks,
             CheckCode::PGH003 => CheckCategory::PygrepHooks,
             CheckCode::PGH004 => CheckCategory::PygrepHooks,
+            CheckCode::PGH005 => CheckCategory::PygrepHooks,
             // pylint
             CheckCode::PLC0414 => CheckCategory::Pylint,
             CheckCode::PLC2201 => CheckCategory::Pylint,
@@ -2262,6 +2267,7 @@ impl CheckKind {
             CheckKind::DeprecatedLogWarn => &CheckCode::PGH002,
             CheckKind::BlanketTypeIgnore => &CheckCode::PGH003,
             CheckKind::BlanketNOQA => &CheckCode::PGH004,
+            CheckKind::RstBackticks => &CheckCode::PGH005,
             // flake8-unused-arguments
             CheckKind::UnusedFunctionArgument(..) => &CheckCode::ARG001,
             CheckKind::UnusedMethodArgument(..) => &CheckCode::ARG002,
@@ -3184,6 +3190,7 @@ impl CheckKind {
                 "Boolean positional value in function call".to_string()
             }
             // pygrep-hooks
+            CheckKind::RstBackticks => "Use two backticks when writing RST".to_string(),
             CheckKind::BlanketNOQA => "Use specific error codes when using `noqa`".to_string(),
             CheckKind::BlanketTypeIgnore => {
                 "Use specific error codes when ignoring type issues".to_string()

src/registry_gen.rs

@@ -382,6 +382,7 @@ pub enum CheckCodePrefix {
     PGH002,
     PGH003,
     PGH004,
+    PGH005,
     PIE,
     PIE7,
     PIE79,
@@ -920,6 +921,7 @@ impl CheckCodePrefix {
                 CheckCode::PGH002,
                 CheckCode::PGH003,
                 CheckCode::PGH004,
+                CheckCode::PGH005,
                 CheckCode::PD002,
                 CheckCode::PD003,
                 CheckCode::PD004,
@@ -2176,23 +2178,27 @@ impl CheckCodePrefix {
                 CheckCode::PGH002,
                 CheckCode::PGH003,
                 CheckCode::PGH004,
+                CheckCode::PGH005,
             ],
             CheckCodePrefix::PGH0 => vec![
                 CheckCode::PGH001,
                 CheckCode::PGH002,
                 CheckCode::PGH003,
                 CheckCode::PGH004,
+                CheckCode::PGH005,
             ],
             CheckCodePrefix::PGH00 => vec![
                 CheckCode::PGH001,
                 CheckCode::PGH002,
                 CheckCode::PGH003,
                 CheckCode::PGH004,
+                CheckCode::PGH005,
             ],
             CheckCodePrefix::PGH001 => vec![CheckCode::PGH001],
             CheckCodePrefix::PGH002 => vec![CheckCode::PGH002],
             CheckCodePrefix::PGH003 => vec![CheckCode::PGH003],
             CheckCodePrefix::PGH004 => vec![CheckCode::PGH004],
+            CheckCodePrefix::PGH005 => vec![CheckCode::PGH005],
             CheckCodePrefix::PIE => vec![CheckCode::PIE790, CheckCode::PIE794, CheckCode::PIE807],
             CheckCodePrefix::PIE7 => vec![CheckCode::PIE790, CheckCode::PIE794],
             CheckCodePrefix::PIE79 => vec![CheckCode::PIE790, CheckCode::PIE794],
@@ -3432,6 +3438,7 @@ impl CheckCodePrefix {
             CheckCodePrefix::PGH002 => SuffixLength::Three,
             CheckCodePrefix::PGH003 => SuffixLength::Three,
             CheckCodePrefix::PGH004 => SuffixLength::Three,
+            CheckCodePrefix::PGH005 => SuffixLength::Three,
             CheckCodePrefix::PIE => SuffixLength::Zero,
             CheckCodePrefix::PIE7 => SuffixLength::One,
             CheckCodePrefix::PIE79 => SuffixLength::Two,