prefix RuleOp methods by validate_

forman · forman · commit fa5ec7ec3570 · 2025-01-30T13:42:23.000+01:00
diff --git a/examples/plugin_config.py b/examples/plugin_config.py
@@ -14,7 +14,7 @@
 class GoodTitle(RuleOp):
     """Dataset title should be 'Hello World!'."""
 
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         good_title = "Hello World!"
         if node.dataset.attrs.get("title") != good_title:
             ctx.report(
diff --git a/examples/rule_testing.py b/examples/rule_testing.py
@@ -13,7 +13,7 @@
 class GoodTitle(RuleOp):
     """Dataset title should be 'Hello World!'."""
 
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         good_title = "Hello World!"
         if node.dataset.attrs.get("title") != good_title:
             ctx.report(
diff --git a/examples/virtual_plugin_config.py b/examples/virtual_plugin_config.py
@@ -10,7 +10,7 @@
 
 @define_rule("good-title", description="Dataset title should be 'Hello World!'.")
 class GoodTitle(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         good_title = "Hello World!"
         if node.dataset.attrs.get("title") != good_title:
             ctx.report(
diff --git a/tests/test_linter.py b/tests/test_linter.py
@@ -95,7 +95,7 @@ def setUp(self):
 
         @plugin.define_rule("no-space-in-attr-name")
         class AttrVer(RuleOp):
-            def attr(self, ctx: RuleContext, node: AttrNode):
+            def validate_attr(self, ctx: RuleContext, node: AttrNode):
                 if " " in node.name:
                     ctx.report(f"Attribute name with space: {node.name!r}")
 
@@ -107,7 +107,7 @@ def attrs(self, ctx: RuleContext, node: AttrsNode):
 
         @plugin.define_rule("data-var-dim-must-have-coord")
         class DataArrayVer(RuleOp):
-            def data_array(self, ctx: RuleContext, node: DataArrayNode):
+            def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
                 if node.in_data_vars():
                     for dim_name in node.data_array.dims:
                         if dim_name not in ctx.dataset.coords:
@@ -119,7 +119,7 @@ def data_array(self, ctx: RuleContext, node: DataArrayNode):
 
         @plugin.define_rule("dataset-without-data-vars")
         class DatasetVer(RuleOp):
-            def dataset(self, ctx: RuleContext, node: DatasetNode):
+            def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
                 if len(node.dataset.data_vars) == 0:
                     ctx.report("Dataset does not have data variables")
                     raise RuleExit  # no need to traverse further
diff --git a/tests/test_testing.py b/tests/test_testing.py
@@ -9,7 +9,7 @@
 
 
 class ForceTitle(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         title = node.dataset.attrs.get("title")
         if not title:
             ctx.report("Datasets must have a title")
diff --git a/xrlint/_linter/apply.py b/xrlint/_linter/apply.py
@@ -48,7 +48,7 @@ def apply_rule(
 
 def _visit_dataset_node(rule_op: RuleOp, context: RuleContextImpl, node: DatasetNode):
     with context.use_state(node=node):
-        rule_op.dataset(context, node)
+        rule_op.validate_dataset(context, node)
         _visit_attrs_node(
             rule_op,
             context,
@@ -86,7 +86,7 @@ def _visit_data_array_node(
     rule_op: RuleOp, context: RuleContextImpl, node: DataArrayNode
 ):
     with context.use_state(node=node):
-        rule_op.data_array(context, node)
+        rule_op.validate_data_array(context, node)
         _visit_attrs_node(
             rule_op,
             context,
@@ -116,4 +116,4 @@ def _visit_attrs_node(rule_op: RuleOp, context: RuleContextImpl, node: AttrsNode
 
 def _visit_attr_node(rule_op: RuleOp, context: RuleContextImpl, node: AttrNode):
     with context.use_state(node=node):
-        rule_op.attr(context, node)
+        rule_op.validate_attr(context, node)
diff --git a/xrlint/plugins/core/rules/content_desc.py b/xrlint/plugins/core/rules/content_desc.py
@@ -74,7 +74,7 @@ def __init__(self, **params):
             re.compile(p) for p in params.get("ignored_vars", DEFAULT_IGNORED_VARS)
         ]
 
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         dataset_attrs = node.dataset.attrs
         attr_names = (
             self.global_attrs + self.common_attrs
@@ -85,7 +85,7 @@ def dataset(self, ctx: RuleContext, node: DatasetNode):
             if attr_name not in dataset_attrs:
                 ctx.report(f"Missing attribute {attr_name!r}.")
 
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         if self.skip_vars:
             # Since dataset() has already been processed,
             # no need to check other nodes.
diff --git a/xrlint/plugins/core/rules/conventions.py b/xrlint/plugins/core/rules/conventions.py
@@ -33,7 +33,7 @@ class Conventions(RuleOp):
     def __init__(self, match: str | None = None):
         self.match = re.compile(match) if match else None
 
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         if "Conventions" not in node.dataset.attrs:
             ctx.report("Missing attribute 'Conventions'.")
         else:
diff --git a/xrlint/plugins/core/rules/coords_for_dims.py b/xrlint/plugins/core/rules/coords_for_dims.py
@@ -11,7 +11,7 @@
     description="Dimensions of data variables should have corresponding coordinates.",
 )
 class CoordsForDims(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         dataset = node.dataset
 
         # Get data variable dimensions
diff --git a/xrlint/plugins/core/rules/dataset_title_attr.py b/xrlint/plugins/core/rules/dataset_title_attr.py
@@ -10,7 +10,7 @@
     description="Datasets should be given a non-empty title.",
 )
 class DatasetTitleAttr(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         title = node.dataset.attrs.get("title")
         if not title:
             ctx.report("Missing 'title' attribute in dataset.")
diff --git a/xrlint/plugins/core/rules/grid_mappings.py b/xrlint/plugins/core/rules/grid_mappings.py
@@ -12,7 +12,7 @@
     ),
 )
 class GridMappings(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         dataset = node.dataset
 
         # Get the mapping of grid mapping names to grid-mapped variables
diff --git a/xrlint/plugins/core/rules/lat_lon_coordinate.py b/xrlint/plugins/core/rules/lat_lon_coordinate.py
@@ -30,7 +30,7 @@
     ),
 )
 class LatCoordinate(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         if node.name in ctx.dataset.coords and _is_lat_var(
             str(node.name), node.data_array
         ):
@@ -55,7 +55,7 @@ def data_array(self, ctx: RuleContext, node: DataArrayNode):
     ),
 )
 class LonCoordinate(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         if node.name in ctx.dataset.coords and _is_lon_var(
             str(node.name), node.data_array
         ):
diff --git a/xrlint/plugins/core/rules/no_empty_chunks.py b/xrlint/plugins/core/rules/no_empty_chunks.py
@@ -17,14 +17,14 @@
     ),
 )
 class NoEmptyChunks(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_dataset(self, ctx: RuleContext, node: DataArrayNode):
         source = ctx.dataset.encoding.get("source")
         is_zarr = isinstance(source, str) and source.endswith(".zarr")
         if not is_zarr:
             # if not a Zarr, no need to check further
             raise RuleExit
 
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         if (
             "write_empty_chunks" not in node.data_array.encoding
             and "chunks" in node.data_array.encoding
diff --git a/xrlint/plugins/core/rules/time_coordinate.py b/xrlint/plugins/core/rules/time_coordinate.py
@@ -52,7 +52,7 @@
     ),
 )
 class TimeCoordinate(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         array = node.data_array
         attrs = array.attrs
         encoding = array.encoding
diff --git a/xrlint/plugins/core/rules/var_desc.py b/xrlint/plugins/core/rules/var_desc.py
@@ -37,7 +37,7 @@ class VarDesc(RuleOp):
     def __init__(self, attrs: list[str] | None = None):
         self._attrs = attrs if attrs is not None else DEFAULT_ATTRS
 
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         if node.name not in ctx.dataset.data_vars:
             # This rule applies to data variables only
             return
diff --git a/xrlint/plugins/core/rules/var_flags.py b/xrlint/plugins/core/rules/var_flags.py
@@ -22,7 +22,7 @@
     docs_url="https://cfconventions.org/cf-conventions/cf-conventions.html#flags",
 )
 class VarFlags(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         flag_values = node.data_array.attrs.get(FLAG_VALUES)
         flag_masks = node.data_array.attrs.get(FLAG_MASKS)
         flag_meanings = node.data_array.attrs.get(FLAG_MEANINGS)
diff --git a/xrlint/plugins/core/rules/var_units.py b/xrlint/plugins/core/rules/var_units.py
@@ -11,7 +11,7 @@
     docs_url="https://cfconventions.org/cf-conventions/cf-conventions.html#units",
 )
 class VarUnits(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         data_array = node.data_array
         units = data_array.attrs.get("units")
         if units is None:
diff --git a/xrlint/plugins/xcube/rules/any_spatial_data_var.py b/xrlint/plugins/xcube/rules/any_spatial_data_var.py
@@ -14,6 +14,6 @@
     ),
 )
 class AnySpatialDataVar(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         if not any(map(is_spatial_var, node.dataset.data_vars.values())):
             ctx.report("No spatial data variables found.")
diff --git a/xrlint/plugins/xcube/rules/cube_dims_order.py b/xrlint/plugins/xcube/rules/cube_dims_order.py
@@ -17,7 +17,7 @@
     ),
 )
 class CubeDimsOrder(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         if node.in_data_vars():
             dims = list(node.data_array.dims)
             indexes = {d: i for i, d in enumerate(node.data_array.dims)}
diff --git a/xrlint/plugins/xcube/rules/data_var_colors.py b/xrlint/plugins/xcube/rules/data_var_colors.py
@@ -16,7 +16,7 @@
     ),
 )
 class DataVarColors(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         array = node.data_array
         if not node.in_data_vars() or not is_spatial_var(array):
             return
diff --git a/xrlint/plugins/xcube/rules/grid_mapping_naming.py b/xrlint/plugins/xcube/rules/grid_mapping_naming.py
@@ -15,7 +15,7 @@
     docs_url="https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference",
 )
 class GridMappingNaming(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         for var_name, var in node.dataset.variables.items():
             if "grid_mapping_name" in var.attrs and var_name not in GM_NAMES:
                 ctx.report(
diff --git a/xrlint/plugins/xcube/rules/increasing_time.py b/xrlint/plugins/xcube/rules/increasing_time.py
@@ -16,7 +16,7 @@
     ),
 )
 class IncreasingTime(RuleOp):
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         array = node.data_array
         if node.in_coords() and node.name == "time" and array.dims == ("time",):
             diff_array: np.ndarray = array.diff("time").values
diff --git a/xrlint/plugins/xcube/rules/lat_lon_naming.py b/xrlint/plugins/xcube/rules/lat_lon_naming.py
@@ -18,7 +18,7 @@
     docs_url="https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference",
 )
 class LatLonNaming(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         lon_ok = _check(
             ctx, "variable", node.dataset.variables.keys(), INVALID_LON_NAMES, LON_NAME
         )
diff --git a/xrlint/plugins/xcube/rules/ml_dataset_meta.py b/xrlint/plugins/xcube/rules/ml_dataset_meta.py
@@ -22,7 +22,7 @@
     ),
 )
 class MLDatasetMeta(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         level_info = get_dataset_level_info(node.dataset)
         if level_info is None:
             # ok, this rules applies only to level datasets opened
diff --git a/xrlint/plugins/xcube/rules/ml_dataset_time.py b/xrlint/plugins/xcube/rules/ml_dataset_time.py
@@ -17,7 +17,7 @@
     docs_url="https://xcube.readthedocs.io/en/latest/mldatasets.html#definition",
 )
 class MLDatasetTime(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         level_info = get_dataset_level_info(node.dataset)
         if level_info is None:
             # ok, this rules applies only to level datasets opened
diff --git a/xrlint/plugins/xcube/rules/ml_dataset_xy.py b/xrlint/plugins/xcube/rules/ml_dataset_xy.py
@@ -17,7 +17,7 @@
     docs_url="https://xcube.readthedocs.io/en/latest/mldatasets.html#definition",
 )
 class MLDatasetXY(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         level_info = get_dataset_level_info(node.dataset)
         if level_info is None:
             # ok, this rules applies only to level datasets opened
diff --git a/xrlint/plugins/xcube/rules/no_chunked_coords.py b/xrlint/plugins/xcube/rules/no_chunked_coords.py
@@ -36,7 +36,7 @@ class NoChunkedCoords(RuleOp):
     def __init__(self, limit: int = DEFAULT_LIMIT):
         self.limit = limit
 
-    def data_array(self, ctx: RuleContext, node: DataArrayNode):
+    def validate_data_array(self, ctx: RuleContext, node: DataArrayNode):
         if node.name not in ctx.dataset.coords or node.data_array.ndim != 1:
             return
 
diff --git a/xrlint/plugins/xcube/rules/single_grid_mapping.py b/xrlint/plugins/xcube/rules/single_grid_mapping.py
@@ -16,7 +16,7 @@
     docs_url="https://xcube.readthedocs.io/en/latest/cubespec.html#spatial-reference",
 )
 class SingleGridMapping(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         dataset = node.dataset
 
         if not dataset.data_vars:
diff --git a/xrlint/plugins/xcube/rules/time_naming.py b/xrlint/plugins/xcube/rules/time_naming.py
@@ -17,7 +17,7 @@
     docs_url="https://xcube.readthedocs.io/en/latest/cubespec.html#temporal-reference",
 )
 class TimeNaming(RuleOp):
-    def dataset(self, ctx: RuleContext, node: DatasetNode):
+    def validate_dataset(self, ctx: RuleContext, node: DatasetNode):
         time_vars = {
             var_name: var
             for var_name, var in node.dataset.coords.items()
diff --git a/xrlint/rule.py b/xrlint/rule.py
@@ -75,7 +75,7 @@ class RuleExit(Exception):
 class RuleOp(ABC):
     """Define the specific rule validation operations."""
 
-    def dataset(self, context: RuleContext, node: DatasetNode) -> None:
+    def validate_dataset(self, context: RuleContext, node: DatasetNode) -> None:
         """Validate the given dataset node.
 
         Args:
@@ -86,7 +86,7 @@ def dataset(self, context: RuleContext, node: DatasetNode) -> None:
             RuleExit: to exit rule logic and further node traversal
         """
 
-    def data_array(self, context: RuleContext, node: DataArrayNode) -> None:
+    def validate_data_array(self, context: RuleContext, node: DataArrayNode) -> None:
         """Validate the given data array (variable) node.
 
         Args:
@@ -108,7 +108,7 @@ def attrs(self, context: RuleContext, node: AttrsNode) -> None:
             RuleExit: to exit rule logic and further node traversal
         """
 
-    def attr(self, context: RuleContext, node: AttrNode) -> None:
+    def validate_attr(self, context: RuleContext, node: AttrNode) -> None:
         """Validate the given attribute node.
 
         Args:

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`description="Dimensions of data variables should have corresponding coordinates.",`
`12`	`12`	`)`
`13`	`13`	`class CoordsForDims(RuleOp):`
`14`		`- def dataset(self, ctx: RuleContext, node: DatasetNode):`
	`14`	`+ def validate_dataset(self, ctx: RuleContext, node: DatasetNode):`
`15`	`15`	`dataset = node.dataset`
`16`	`16`
`17`	`17`	`# Get data variable dimensions`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`description="Datasets should be given a non-empty title.",`
`11`	`11`	`)`
`12`	`12`	`class DatasetTitleAttr(RuleOp):`
`13`		`- def dataset(self, ctx: RuleContext, node: DatasetNode):`
	`13`	`+ def validate_dataset(self, ctx: RuleContext, node: DatasetNode):`
`14`	`14`	`title = node.dataset.attrs.get("title")`
`15`	`15`	`if not title:`
`16`	`16`	`ctx.report("Missing 'title' attribute in dataset.")`