Expand override logic for pre-commit hook to any check.

Author: stefmolin

numpydoc/hooks/validate_docstrings.py

@@ -182,10 +182,12 @@ def _ignore_issue(self, node: ast.AST, check: str) -> bool:
             return True
 
         if self.config["overrides"]:
-            if check == "SS05":
-                pattern = self.config["overrides"].get("SS05")
-                if pattern and re.match(pattern, ast.get_docstring(node)) is not None:
+            try:
+                pattern = self.config["overrides"][check]
+                if re.search(pattern, ast.get_docstring(node)) is not None:
                     return True
+            except KeyError:
+                pass
 
         try:
             if check in self.numpydoc_ignore_comments[getattr(node, "lineno", 1)]:
@@ -265,6 +267,20 @@ def parse_config(dir_path: os.PathLike = None) -> dict:
     toml_path = dir_path / "pyproject.toml"
     cfg_path = dir_path / "setup.cfg"
 
+    def compile_regex(expressions):
+        return (
+            re.compile(r"|".join(exp for exp in expressions if exp))
+            if expressions
+            else None
+        )
+
+    def extract_check_overrides(options, config_items):
+        for option, value in config_items:
+            if option.startswith("override_"):
+                _, check = option.split("_")
+                if value:
+                    options["overrides"][check.upper()] = compile_regex(value)
+
     if toml_path.is_file():
         with open(toml_path, "rb") as toml_file:
             pyproject_toml = tomllib.load(toml_file)
@@ -278,10 +294,8 @@ def parse_config(dir_path: os.PathLike = None) -> dict:
                 else [global_exclusions]
             )
 
-            for check in ["SS05"]:
-                regex = config.get(f"override_{check}")
-                if regex:
-                    options["overrides"][check] = re.compile(regex)
+            extract_check_overrides(options, config.items())
+
     elif cfg_path.is_file():
         config = configparser.ConfigParser()
         config.read(cfg_path)
@@ -305,21 +319,16 @@ def parse_config(dir_path: os.PathLike = None) -> dict:
                 )
             except configparser.NoOptionError:
                 pass
-            try:
-                options["overrides"]["SS05"] = re.compile(
-                    config.get(numpydoc_validation_config_section, "override_SS05")
-                )
-            except configparser.NoOptionError:
-                pass
+
+            extract_check_overrides(
+                options, config.items(numpydoc_validation_config_section)
+            )
+
         except configparser.NoSectionError:
             pass
 
     options["checks"] = get_validation_checks(options["checks"])
-    options["exclude"] = (
-        re.compile(r"|".join(exp for exp in options["exclude"]))
-        if options["exclude"]
-        else None
-    )
+    options["exclude"] = compile_regex(options["exclude"])
     return options
 
 

numpydoc/tests/hooks/test_validate_hook.py

@@ -131,8 +131,12 @@ def test_validate_hook_with_toml_config(example_module, tmp_path, capsys):
                     "SA01",
                     "ES01",
                 ]
-                override_SS05 = '^((Process|Assess|Access) )'
                 exclude = '\\.__init__$'
+                override_SS05 = [
+                    '^Process',
+                    '^Assess',
+                    '^Access',
+                ]
                 """
             )
         )
@@ -171,7 +175,7 @@ def test_validate_hook_with_setup_cfg(example_module, tmp_path, capsys):
                 [tool:numpydoc_validation]
                 checks = all,EX01,SA01,ES01
                 exclude = \\.__init__$
-                override_SS05 = ^((Process|Assess|Access) )
+                override_SS05 = ^Process,^Assess,^Access
                 """
             )
         )
@@ -226,11 +230,15 @@ def test_validate_hook_exclude_option_pyproject(example_module, tmp_path, capsys
                     "SA01",
                     "ES01",
                 ]
-                override_SS05 = '^((Process|Assess|Access) )'
                 exclude = [
                     '\.do_something$',
                     '\.__init__$',
                 ]
+                override_SS05 = [
+                    '^Process',
+                    '^Assess',
+                    '^Access',
+                ]
                 """
             )
         )
@@ -264,8 +272,8 @@ def test_validate_hook_exclude_option_setup_cfg(example_module, tmp_path, capsys
                 """
                 [tool:numpydoc_validation]
                 checks = all,EX01,SA01,ES01
-                override_SS05 = ^((Process|Assess|Access) )
                 exclude = \\.NewClass$,\\.__init__$
+                override_SS05 = ^Process,^Assess,^Access
                 """
             )
         )