Some fixes to failure messages in the cc6 checks (#73)

* Some fixes to failure messages in the cc6 checks
* Adding sanitization of consistency output to ensure json serializability.

Author: sol1105

cc_plugin_cc6/base.py

@@ -15,7 +15,7 @@
 from cc_plugin_cc6 import __version__
 
 from ._constants import deltdic
-from .utils import match_pattern_or_string, to_str
+from .utils import match_pattern_or_string, sanitize, to_str
 
 get_tseconds = lambda t: t.total_seconds()  # noqa
 get_tseconds_vector = np.vectorize(get_tseconds)
@@ -484,17 +484,19 @@ def _write_consistency_output(self):
         # Write combined dictionary
         with open(self.consistency_output, "w") as f:
             json.dump(
-                {
-                    "global_attributes": file_attrs_req,
-                    "global_attributes_non_required": file_attrs_nreq,
-                    "global_attributes_dtypes": file_attrs_dtypes,
-                    "variable_attributes": var_attrs,
-                    "variable_attributes_dtypes": var_attrs_dtypes,
-                    "variable_dtypes": var_dtypes,
-                    "dimensions": dims,
-                    "coordinates": coord_checksums,
-                    "time_info": time_info,
-                },
+                sanitize(
+                    {
+                        "global_attributes": file_attrs_req,
+                        "global_attributes_non_required": file_attrs_nreq,
+                        "global_attributes_dtypes": file_attrs_dtypes,
+                        "variable_attributes": var_attrs,
+                        "variable_attributes_dtypes": var_attrs_dtypes,
+                        "variable_dtypes": var_dtypes,
+                        "dimensions": dims,
+                        "coordinates": coord_checksums,
+                        "time_info": time_info,
+                    }
+                ),
                 f,
                 indent=4,
             )

cc_plugin_cc6/cc6.py

@@ -333,14 +333,14 @@ def check_time_chunking(self, ds):
             # Check if the first time is equal to the expected start date
             if first_time != expected_start_date:
                 messages.append(
-                    f"The first timestep conflicts with this recommendation ('{expected_start_date}'): '{first_time}'. "
-                    + errmsg
+                    errmsg
+                    + f" The first timestep conflicts with this recommendation ('{expected_start_date}'): '{first_time}'. "
                 )
             # Check if the last time is equal to the expected end date
             if last_time != expected_end_date and last_time != expected_end_date_exp:
                 messages.append(
-                    f"The last timestep conflicts with this recommendation ('{expected_end_date}'): '{last_time}'. "
-                    + errmsg
+                    errmsg
+                    + f" The last timestep conflicts with this recommendation ('{expected_end_date}'): '{last_time}'. "
                 )
         if len(messages) == 0:
             score += 1
@@ -823,22 +823,19 @@ def check_lon_value_range(self, ds):
                     else:
                         messages.append(
                             "The longitude coordinate should be strictly monotonically increasing."
-                            f"{increasing_0}, {increasing_1}"
                         )
                 elif rlon_idx == 1:
                     if increasing_1:
                         score += 1
                     else:
                         messages.append(
                             "The longitude coordinate should be strictly monotonically increasing."
-                            f"{increasing_0}, {increasing_1}"
                         )
             elif increasing_0 or increasing_1:
                 score += 1
             else:
                 messages.append(
                     "The longitude coordinate should be strictly monotonically increasing."
-                    f"{increasing_0}, {increasing_1}"
                 )
 
         # Check if longitude coordinates are confined to the range -180 to 360

cc_plugin_cc6/utils.py

@@ -73,3 +73,20 @@ def to_str(val):
         except UnicodeDecodeError:
             return val
     return str(val)
+
+
+def sanitize(obj):
+    """
+    Make sure all values are json-serializable.
+    """
+    if isinstance(obj, dict):
+        return {k: sanitize(v) for k, v in obj.items()}
+    if isinstance(obj, list):
+        return [sanitize(v) for v in obj]
+    if isinstance(obj, (np.integer,)):
+        return int(obj)
+    if isinstance(obj, (np.floating,)):
+        return float(obj)
+    if isinstance(obj, (np.ndarray,)):
+        return obj.tolist()
+    return obj