Add function to check dimensions against regex

checksit/generic.py

@@ -160,7 +160,7 @@ def check_var_exists(dct, variables, skip_spellcheck=False):
 
 def check_dim_exists(dct, dimensions, skip_spellcheck=False):
     """
-    Check that variables exist
+    Check that dimensions exist
 
     E.g. check-dim-exists:dimensions:time|latitude
     """
@@ -185,6 +185,35 @@ def check_dim_exists(dct, dimensions, skip_spellcheck=False):
     return errors, warnings
 
 
+def check_dim_regex(dct, regex_dims, skip_spellcheck=False):
+    """
+    Check dimension exists matching regex
+
+    E.g. check-dime-regex:regex-dims:^string_length[^,]*$
+    """
+    errors = []
+    warnings = []
+    for regex_dim in regex_dims:
+        if regex_dim.endswith(":__OPTIONAL__"):
+            regex_dim = ":".join(regex_dim.split(":")[:-1])
+            r = re.compile(regex_dim)
+            matches = list(filter(r.match, dct["dimensions"].keys()))
+            #if not re.match(regex_dim, dct["dimensions"].keys()):
+            if len(matches) == 0:
+                warnings.append(
+                    f"[dimension**************:{regex_dim}]: No dimension matching optional regex check in file. "
+                )
+        else:
+            r = re.compile(regex_dim)
+            matches = list(filter(r.match, dct["dimensions"].keys()))
+            #if not re.match(regex_dim, dct["dimensions"].keys()):
+            if len(matches) == 0:
+                errors.append(
+                    f"[dimension**************:{regex_dim}]: No dimension matching regex check in file. "
+                )
+    return errors, warnings
+
+
 def check_var(dct, variable, defined_attrs, rules_attrs=None, skip_spellcheck=False):
     """
     Check variable exists and has attributes defined.