back to 100% coverage

Author: forman

tests/cli/test_main.py

@@ -194,12 +194,18 @@ def test_files_but_config_file_missing(self):
         self.assertIn("Error: file not found: pippo.py", result.output)
         self.assertEqual(1, result.exit_code)
 
-    def test_files_with_format_option(self):
+    def test_files_with_format_json(self):
         with text_file(DEFAULT_CONFIG_FILE_YAML, self.ok_config_yaml):
             result = self.xrlint("-f", "json", *self.files)
             self.assertIn('"results": [\n', result.output)
             self.assertEqual(0, result.exit_code)
 
+    def test_files_with_format_html(self):
+        with text_file(DEFAULT_CONFIG_FILE_YAML, self.ok_config_yaml):
+            result = self.xrlint("-f", "html", *self.files)
+            self.assertIn("<h3>Results</h3>", result.output)
+            self.assertEqual(0, result.exit_code)
+
     def test_file_does_not_match(self):
         with text_file(DEFAULT_CONFIG_FILE_YAML, no_match_config_yaml):
             result = self.xrlint("test.zarr")

tests/formatters/test_html.py

@@ -1,6 +1,6 @@
 from unittest import TestCase
 
-from xrlint.formatters.html import Html
+from xrlint.formatters.html import Html, HtmlText
 
 from .helpers import get_context, get_test_results
 
@@ -13,7 +13,8 @@ def test_html(self):
             context=get_context(),
             results=results,
         )
-        self.assertIsInstance(text, str)
+        self.assertIsInstance(text, HtmlText)
+        self.assertIs(text, text._repr_html_())
         self.assertIn("</p>", text)
 
     def test_html_with_meta(self):
@@ -23,5 +24,6 @@ def test_html_with_meta(self):
             context=get_context(),
             results=results,
         )
-        self.assertIsInstance(text, str)
+        self.assertIsInstance(text, HtmlText)
+        self.assertIs(text, text._repr_html_())
         self.assertIn("</p>", text)

xrlint/cli/engine.py

@@ -1,7 +1,6 @@
 import json
 import os
 from collections.abc import Iterable, Iterator
-from types import MethodType
 
 import click
 import fsspec
@@ -244,8 +243,7 @@ def format_results(self, results: Iterable[Result]) -> str:
             formatter_kwargs = {}
         # noinspection PyArgumentList
         formatter_op = formatter.op_class(**formatter_kwargs)
-        text = formatter_op.format(self, self._result_stats.collect(results))
-        return _bind_repr_html(text) if output_format == "html" else text
+        return formatter_op.format(self, self._result_stats.collect(results))
 
     def write_report(self, report: str) -> None:
         """Write the validation report provided as plain text."""
@@ -267,14 +265,3 @@ def init_config_file(cls) -> None:
         with open(file_path, "w") as f:
             f.write(INIT_CONFIG_YAML)
         click.echo(f"Configuration template written to {file_path}")
-
-
-def _bind_repr_html(text: str) -> str:
-    """Allow displaying `text` as HTML in Jupyter notebooks."""
-    text._repr_html_ = MethodType(_repr_html_, text)
-    return text
-
-
-def _repr_html_(self: str) -> str:
-    """Method to be bound to `self` for texts that represent HTML."""
-    return self

xrlint/formatters/html.py

@@ -57,7 +57,7 @@ def format(
                     )
             lines.append("</div>")
 
-        return "\n".join(lines)
+        return HtmlText("\n".join(lines))
 
 
 def format_result(result: Result) -> list[str]:
@@ -130,3 +130,11 @@ def _format_result_data(data: list[list[str]]) -> list[str]:
         lines.append("  </tr>")
     lines.append("</table>")
     return lines
+
+
+class HtmlText(str):
+    """Allow displaying `text` as HTML in Jupyter notebooks."""
+
+    def _repr_html_(self: str) -> str:
+        """Represent HTML text as HTML."""
+        return self

xrlint/formatters/simple.py

@@ -107,7 +107,8 @@ def _format_rule_id(self, m: Message, r: Result) -> str:
         rule_text = m.rule_id or ""
         if self.styled and rule_text:
             rule_url = r.get_docs_url_for_rule(m.rule_id)
-            rule_text = format_styled(rule_text, fg="blue", href=rule_url)
+            if rule_url:
+                rule_text = format_styled(rule_text, fg="blue", href=rule_url)
         return rule_text
 
     def _format_summary(self, error_count, warning_count) -> str:

xrlint/result.py

@@ -156,7 +156,7 @@ def get_docs_url_for_rule(self, rule_id: str) -> str | None:
             return f"{CORE_DOCS_URL}#{rule_name}"
         try:
             plugin = self.config_object.get_plugin(plugin_name)
-            rule = self.config_object.get_rule(rule_name)
+            rule = self.config_object.get_rule(rule_id)
             return rule.meta.docs_url or plugin.meta.docs_url
         except ValueError:
             return None