Communicate error objects, not strings

In order to improve error reporting we first need to communicate typed
error objects from the checking functions instead of error messages,
where we can't (easily and reliably) recover the error details anymore.

Error objects know how to format themselves, so we print them directly,
and let them do their internal formatting.

Signed-off-by: Rodrigo Tobar <[email protected]>

Author: rtobar

sphinxlint/__main__.py

@@ -122,8 +122,8 @@ def print_results(results):
     """Print results (or a message if nothing is to be printed)."""
     qty = 0
     for result in results:
-        for line in result:
-            print(line)
+        for error in result:
+            print(error)
             qty += 1
     if qty == 0:
         print("No problems found.")

sphinxlint/sphinxlint.py

@@ -1,9 +1,23 @@
 from collections import Counter
+from dataclasses import dataclass
 from os.path import splitext
 
 from sphinxlint.utils import hide_non_rst_blocks, po2rst
 
 
+@dataclass(frozen=True)
+class LintError:
+    """A linting error found by one of the checkers"""
+
+    filename: str
+    line_no: int
+    msg: str
+    checker_name: str
+
+    def __str__(self):
+        return f"{self.filename}:{self.line_no}: {self.msg} ({self.checker_name})"
+
+
 class CheckersOptions:
     """Configuration options for checkers."""
 
@@ -31,7 +45,7 @@ def check_text(filename, text, checkers, options=None):
         for lno, msg in check(
             filename, lines_with_rst_only if check.rst_only else lines, options
         ):
-            errors.append(f"{filename}:{lno}: {msg} ({check.name})")
+            errors.append(LintError(filename, lno, msg, check.name))
     return errors