Merge pull request #49 from bcdev/forman-improved_jl_support

Improved jupyter support

Author: forman

CHANGES.md

@@ -2,7 +2,10 @@
 
 ## Version 0.5.0 (in development)
 
-### Changes
+### Adjustments and Enhancements
+
+- Added HTML styling for both CLI output (`--format html`) and rendering
+  of `Result` objects in Jupyter notebooks.
 
 - Rule `no-empty-chunks` has taken off the `"recommended"` settings 
   as there is no easy/efficient way to tell whether a dataset has 
@@ -41,6 +44,7 @@
 ### Other changes
 
 - Added more tests so we finally reached 100% coverage.
+- New `PluginMeta.docs_url` property.
 
 ## Version 0.4.1 (from 2025-01-31)
 

docs/todo.md

@@ -2,25 +2,30 @@
 
 ## Required
 
-- populate `core` plugin by more rules, see CF site and `cf-check` tool
-- populate `xcube` plugin by more rules
+- support zarr >= 3 which we do not only because test 
+  `tests/plugins/xcube/processors/test_mldataset.py` fails
+  (see code TODO)
+- validate `RuleConfig.args/kwargs` against `RuleMeta.schema`
+  (see code TODO)
 - enhance docs
   - complete configuration page
   - provide guide page
   - use mkdocstrings ref syntax in docstrings
   - provide configuration examples (use as tests?)
   - add `docs_url` to all existing rules 
+  - rule ref should cover rule parameters
 
 ## Desired
 
 - project logo
+- add `core` rule checks recommended use of fill value
+- add `xcube` rule that helps to identify chunking issues 
 - apply rule op args/kwargs validation schema 
-- provide core rule that checks for configurable list of std attributes
 - measure time it takes to open a dataset and pass time into rule context 
   so we can write a configurable rule that checks the opening time
 - allow outputting suggestions, if any, that are emitted by some rules
-- enhance styling of `Result` representation in Jupyter notebooks
-  (check if we can expand/collapse messages with suggestions)
+  - add CLI option
+  - expand/collapse messages with suggestions in Jupyter notebooks
 
 ## Nice to have
 
@@ -69,4 +74,3 @@ types that can read the data from a file path.
    - call the root element `accept(validator)` that validates the 
      root element `validate.root()` and starts traversal of 
      child elements.
-

notebooks/xrlint-cli.ipynb

@@ -194,17 +194,24 @@ 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")
-            # TODO: make this assertion work
-            # self.assertIn("No configuration matches this file.", result.output)
+            self.assertIn(
+                "No configuration given or matches 'test.zarr'.", result.output
+            )
             self.assertEqual(1, result.exit_code)
 
     def test_print_config_option(self):

notebooks/xrlint-linter.ipynb

@@ -45,8 +45,18 @@ class Rule2(RuleOp):
             config_object=config_obj,
             file_path="test.nc",
             messages=[
-                Message(message="message-1", rule_id="test/rule-1", severity=2),
-                Message(message="message-2", rule_id="test/rule-2", severity=1),
+                Message(
+                    message="message-1",
+                    rule_id="test/rule-1",
+                    severity=2,
+                    node_path="dataset",
+                ),
+                Message(
+                    message="message-2",
+                    rule_id="test/rule-2",
+                    severity=1,
+                    node_path="dataset",
+                ),
                 Message(message="message-3", fatal=True),
             ],
         ),

tests/cli/test_main.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)

tests/formatters/helpers.py

@@ -6,7 +6,7 @@
 from xrlint.config import Config, ConfigObject
 from xrlint.constants import CORE_PLUGIN_NAME, NODE_ROOT_NAME
 from xrlint.linter import Linter, new_linter
-from xrlint.node import AttrNode, AttrsNode, VariableNode, DatasetNode
+from xrlint.node import AttrNode, AttrsNode, DatasetNode, VariableNode
 from xrlint.plugin import new_plugin
 from xrlint.processor import ProcessorOp
 from xrlint.result import Message, Result

tests/formatters/test_html.py

@@ -69,7 +69,8 @@ def test_repr_html(self):
         )
         html = result._repr_html_()
         self.assertIsInstance(html, str)
-        self.assertEqual('<p role="file">test.zarr - ok</p>\n', html)
+        self.assertIn("ok", html)
+        self.assertIn("<div", html)
 
         result = Result.new(
             config_object=ConfigObject(),

tests/test_linter.py

@@ -1,4 +1,4 @@
-from xrlint.node import AttrNode, AttrsNode, VariableNode, DatasetNode
+from xrlint.node import AttrNode, AttrsNode, DatasetNode, VariableNode
 from xrlint.rule import RuleConfig, RuleExit, RuleOp
 
 from ..constants import NODE_ROOT_NAME