Rework hook output to remove the table (#611)

* Switch from table to printed items

* Remove tabulate dependency

* Adjust format

* Fix test after Sphinx builder change in newer version

Author: stefmolin

.pre-commit-hooks.yaml

@@ -2,6 +2,6 @@
   name: numpydoc-validation
   description: This hook validates that docstrings in committed files adhere to numpydoc standards.
   entry: numpydoc lint
-  require_serial: true
+  require_serial: false
   language: python
   types: [python]

numpydoc/hooks/validate_docstrings.py

@@ -14,8 +14,6 @@
 from pathlib import Path
 from typing import Any, Dict, List, Tuple, Union
 
-from tabulate import tabulate
-
 from .. import docscrape, validate
 from .utils import find_project_root
 
@@ -193,7 +191,7 @@ def _get_numpydoc_issues(self, node: ast.AST) -> None:
         )
         self.findings.extend(
             [
-                [f'{self.filepath}:{report["file_line"]}', name, check, description]
+                [f"{self.filepath}:{report['file_line']}", name, check, description]
                 for check, description in report["errors"]
                 if not self._ignore_issue(node, check)
             ]
@@ -371,19 +369,12 @@ def run_hook(
     config_options = parse_config(config or project_root)
     config_options["checks"] -= set(ignore or [])
 
-    findings = []
+    findings = False
     for file in files:
-        findings.extend(process_file(file, config_options))
-
-    if findings:
-        print(
-            tabulate(
-                findings,
-                headers=["file", "item", "check", "description"],
-                tablefmt="grid",
-                maxcolwidths=50,
-            ),
-            file=sys.stderr,
-        )
-        return 1
-    return 0
+        if file_issues := process_file(file, config_options):
+            findings = True
+
+            for line, obj, check, description in file_issues:
+                print(f"\n{line}: {check} {description}", file=sys.stderr)
+
+    return int(findings)

numpydoc/tests/hooks/test_validate_hook.py

@@ -124,15 +124,7 @@ def test_lint(capsys, args):
         expected = ""
         expected_status = 0
     else:
-        expected = inspect.cleandoc(
-            """
-            +------------------------+----------+---------+------------------------------------+
-            | file                   | item     | check   | description                        |
-            +========================+==========+=========+====================================+
-            | numpydoc/__main__.py:1 | __main__ | SS03    | Summary does not end with a period |
-            +------------------------+----------+---------+------------------------------------+
-        """
-        )
+        expected = "numpydoc/__main__.py:1: SS03 Summary does not end with a period"
         expected_status = 1
 
     return_status = numpydoc.cli.main(argv)

numpydoc/tests/test_main.py

@@ -36,6 +36,7 @@ class MockConfig:
 
 class MockBuilder:
     config = MockConfig()
+    _translator = None
 
 
 class MockApp:

numpydoc/tests/test_numpydoc.py

@@ -29,7 +29,6 @@ classifiers = [
 ]
 dependencies = [
     'sphinx>=6',
-    'tabulate>=0.8.10',
     "tomli>=1.1.0;python_version<'3.11'",
 ]
 

pyproject.toml

@@ -1,5 +1,4 @@
 # Generated via tools/generate_requirements.py and pre-commit hook.
 # Do not edit this file; modify pyproject.toml instead.
 sphinx>=6
-tabulate>=0.8.10
 tomli>=1.1.0;python_version<'3.11'