renamed rule

Author: forman

CHANGES.md

@@ -4,7 +4,7 @@
 
 ### Adjustments and Enhancements
 
-- Added a new core rule `opening-time` that can be used to check the
+- Added a new core rule `access-latency` that can be used to check the
   time it takes to open datasets.
 
 - Added HTML styling for both CLI output (`--format html`) and rendering

docs/rule-ref.md

@@ -5,6 +5,12 @@ New rules will be added by upcoming XRLint releases.
 
 ## Core Rules
 
+### :material-bug: `access-latency`
+
+Ensure that the time it takes to open a dataset from its source does a exceed a given `threshold` in seconds. The default threshold is `2.5`.
+
+Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
+
 ### :material-lightbulb: `content-desc`
 
 A dataset should provide information about where the data came from and what has been done to it. This information is mainly for the benefit of human readers. The rule accepts the following configuration parameters:
@@ -65,12 +71,6 @@ Empty chunks should not be encoded and written. The rule currently applies to Za
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-circle-off-outline:
 
-### :material-bug: `opening-time`
-
-Ensure that the time it takes to open a dataset from its source does a exceed a given `threshold` in seconds. The default threshold is `2.5`.
-
-Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
-
 ### :material-bug: `time-coordinate`
 
 Time coordinates should have valid and unambiguous time units encoding.

tests/_linter/test_rulectx.py

@@ -19,7 +19,7 @@ def test_defaults(self):
         self.assertEqual({}, context.settings)
         self.assertEqual("./ds.zarr", context.file_path)
         self.assertEqual(None, context.file_index)
-        self.assertEqual(None, context.opening_time)
+        self.assertEqual(None, context.access_latency)
 
     def test_report(self):
         context = RuleContextImpl(

…/plugins/core/rules/test_opening_time.py …lugins/core/rules/test_access_latency.pytests/plugins/core/rules/test_opening_time.py renamed to tests/plugins/core/rules/test_access_latency.py tests/plugins/core/rules/test_opening_time.py renamed to tests/plugins/core/rules/test_access_latency.py

@@ -7,7 +7,7 @@
 from xrlint._linter.rulectx import RuleContextImpl
 from xrlint.config import ConfigObject
 from xrlint.node import DatasetNode
-from xrlint.plugins.core.rules.opening_time import OpeningTime
+from xrlint.plugins.core.rules.access_latency import AccessLatency
 from xrlint.result import Message
 from xrlint.rule import RuleExit
 
@@ -19,22 +19,24 @@
 class OpeningTimeTest(TestCase):
     @classmethod
     def invoke_op(
-        cls, dataset: xr.Dataset, opening_time: float, threshold: float | None = None
+        cls, dataset: xr.Dataset, access_latency: float, threshold: float | None = None
     ):
         ctx = RuleContextImpl(
             config=ConfigObject(),
             dataset=dataset,
             file_path="test.zarr",
             file_index=None,
-            opening_time=opening_time,
+            access_latency=access_latency,
         )
         node = DatasetNode(
             path="dataset",
             parent=None,
             dataset=ctx.dataset,
         )
         rule_op = (
-            OpeningTime(threshold=threshold) if threshold is not None else OpeningTime()
+            AccessLatency(threshold=threshold)
+            if threshold is not None
+            else AccessLatency()
         )
         with pytest.raises(RuleExit):
             rule_op.validate_dataset(ctx, node)
@@ -52,7 +54,7 @@ def test_invalid(self):
         self.assertEqual(
             [
                 Message(
-                    message="Opening time exceeds threshold: 3.2 > 2.5 seconds.",
+                    message="Access latency exceeds threshold: 3.2 > 2.5 seconds.",
                     node_path="dataset",
                     severity=2,
                 )
@@ -64,7 +66,7 @@ def test_invalid(self):
         self.assertEqual(
             [
                 Message(
-                    message="Opening time exceeds threshold: 0.2 > 0.1 seconds.",
+                    message="Access latency exceeds threshold: 0.2 > 0.1 seconds.",
                     node_path="dataset",
                     severity=2,
                 )

tests/plugins/core/test_plugin.py

@@ -8,13 +8,13 @@ def test_rules_complete(self):
         plugin = export_plugin()
         self.assertEqual(
             {
+                "access-latency",
                 "content-desc",
                 "conventions",
                 "coords-for-dims",
                 "grid-mappings",
                 "lat-coordinate",
                 "lon-coordinate",
-                "opening-time",
                 "no-empty-attrs",
                 "no-empty-chunks",
                 "time-coordinate",

xrlint/_linter/rulectx.py

@@ -17,7 +17,7 @@ def __init__(
         dataset: xr.Dataset,
         file_path: str,
         file_index: int | None,
-        opening_time: float | None,
+        access_latency: float | None,
     ):
         assert config is not None
         assert dataset is not None
@@ -27,7 +27,7 @@ def __init__(
         self._dataset = dataset
         self._file_path = file_path
         self._file_index = file_index
-        self._opening_time = opening_time
+        self._access_latency = access_latency
         self.messages: list[Message] = []
         self.rule_id: str | None = None
         self.severity: Literal[1, 2] = SEVERITY_ERROR
@@ -54,8 +54,8 @@ def file_index(self) -> int | None:
         return self._file_index
 
     @property
-    def opening_time(self) -> float | None:
-        return self._opening_time
+    def access_latency(self) -> float | None:
+        return self._access_latency
 
     def report(
         self,

xrlint/_linter/validate.py

@@ -27,13 +27,15 @@ def _validate_dataset(
     dataset: xr.Dataset,
     file_path: str,
     file_index: int | None,
-    opening_time: float | None,
+    access_latency: float | None,
 ) -> list[Message]:
     assert isinstance(config_obj, ConfigObject)
     assert isinstance(dataset, xr.Dataset)
     assert isinstance(file_path, str)
 
-    context = RuleContextImpl(config_obj, dataset, file_path, file_index, opening_time)
+    context = RuleContextImpl(
+        config_obj, dataset, file_path, file_index, access_latency
+    )
     for rule_id, rule_config in config_obj.rules.items():
         with context.use_state(rule_id=rule_id):
             apply_rule(context, rule_id, rule_config)
@@ -55,10 +57,10 @@ def _open_and_validate_dataset(
             ds_path_list = processor_op.preprocess(file_path, opener_options)
         except (OSError, ValueError, TypeError) as e:
             return [new_fatal_message(str(e))]
-        opening_time = time.time() - t0
+        access_latency = time.time() - t0
         return processor_op.postprocess(
             [
-                _validate_dataset(config_obj, ds, path, i, opening_time)
+                _validate_dataset(config_obj, ds, path, i, access_latency)
                 for i, (ds, path) in enumerate(ds_path_list)
             ],
             file_path,
@@ -69,9 +71,11 @@ def _open_and_validate_dataset(
             dataset = _open_dataset(ds_source, opener_options, file_path)
         except (OSError, ValueError, TypeError) as e:
             return [new_fatal_message(str(e))]
-        opening_time = time.time() - t0
+        access_latency = time.time() - t0
         with dataset:
-            return _validate_dataset(config_obj, dataset, file_path, None, opening_time)
+            return _validate_dataset(
+                config_obj, dataset, file_path, None, access_latency
+            )
 
 
 def _open_dataset(

xrlint/plugins/core/__init__.py

@@ -12,6 +12,7 @@ def export_plugin() -> Plugin:
         {
             "name": "recommended",
             "rules": {
+                "access-latency": "warn",
                 "content-desc": "warn",
                 "conventions": "warn",
                 "coords-for-dims": "error",
@@ -20,7 +21,6 @@ def export_plugin() -> Plugin:
                 "lon-coordinate": "error",
                 "no-empty-attrs": "warn",
                 "no-empty-chunks": "off",
-                "opening-time": "warn",
                 "time-coordinate": "error",
                 "var-desc": "warn",
                 "var-flags": "error",

xrlint/plugins/core/rules/opening_time.py …int/plugins/core/rules/access_latency.pyxrlint/plugins/core/rules/opening_time.py renamed to xrlint/plugins/core/rules/access_latency.py xrlint/plugins/core/rules/opening_time.py renamed to xrlint/plugins/core/rules/access_latency.py

@@ -14,7 +14,7 @@
 
 
 @plugin.define_rule(
-    "opening-time",
+    "access-latency",
     version="1.0.0",
     description=(
         "Ensure that the time it takes to open a dataset from its source"
@@ -33,14 +33,14 @@
         },
     ),
 )
-class OpeningTime(RuleOp):
+class AccessLatency(RuleOp):
     def __init__(self, threshold: float = DEFAULT_THRESHOLD):
         self.threshold = threshold
 
     def validate_dataset(self, ctx: RuleContext, node: DatasetNode) -> None:
-        if ctx.opening_time is not None and ctx.opening_time > self.threshold:
+        if ctx.access_latency is not None and ctx.access_latency > self.threshold:
             ctx.report(
-                f"Opening time exceeds threshold: {ctx.opening_time:.1f}"
+                f"Access latency exceeds threshold: {ctx.access_latency:.1f}"
                 f" > {format_count(self.threshold, 'second')}."
             )
         raise RuleExit

xrlint/rule.py

@@ -40,7 +40,7 @@ def dataset(self) -> xr.Dataset:
 
     @property
     @abstractmethod
-    def opening_time(self) -> float | None:
+    def access_latency(self) -> float | None:
         """The time in seconds that it took for opening the dataset.
         `None` if the dataset has not been opened from `file_path`.
         """