better json schemas

Author: otvam

pypeec/lib_check/check_data_options.py

@@ -14,22 +14,20 @@ def check_tag_list(data_check, tag_list):
     Check the list of plots to be shown.
     """
 
-    # allowed tags
-    tag_allowed = list(data_check.keys())
-
-    # check fields
+    # check tag_list with a schema
     schema = {
         "type": ["null", "array"],
         "items": {
             "type": "string",
             "minLength": 1,
         },
     }
-
-    # validate base schema
     scisave.validate_schema(tag_list, schema)
 
-    # check tag
+    # get a list with the allowed tags
+    tag_allowed = list(data_check.keys())
+
+    # check that the provided tags a subset of the allowed tags
     if tag_list is not None:
         for tag in tag_list:
             if tag not in tag_allowed:
@@ -41,14 +39,14 @@ def check_plot_options(plot_mode, folder, name):
     Check the plot mode (display or not the plots).
     """
 
-    # check plot_mode
+    # check plot_mode with a schema
     schema = {
         "type": ["null", "string"],
         "enum": [None, "qt", "nb_int", "nb_std", "png", "vtk", "debug"],
     }
     scisave.validate_schema(plot_mode, schema)
 
-    # check folder and name
+    # check folder and name with a schema
     schema = {
         "type": ["null", "string"],
         "minLength": 1,

pypeec/main.py

@@ -20,7 +20,7 @@
 LOGGER = scilogger.get_logger(__name__, "pypeec")
 
 
-def _create_data(datatype, timestamp, data):
+def _create_data(layout, timestamp, data):
     """
     Create an output data structure.
     """
@@ -32,10 +32,10 @@ def _create_data(datatype, timestamp, data):
     meta = {
         "name": pypeec.__name__,
         "version": pypeec.__version__,
-        "datatype": datatype,
+        "layout": layout,
+        "date": date,
         "duration": duration,
         "seconds": seconds,
-        "date": date,
     }
 
     # assemble the output data
@@ -47,35 +47,59 @@ def _create_data(datatype, timestamp, data):
     return data_out
 
 
-def _load_data(datatype_out, data_out):
+def _load_data(layout_out, data_out):
     """
     Load an output data structure.
     """
 
-    # check fields
+    # check the output data
     schema = {
         "type": "object",
         "required": [
             "meta",
             "data",
         ],
+        "properties": {
+            "meta" : {"type": "object"},
+            "data": {"type": "object"},
+        }
     }
-
-    # validate base schema
     scisave.validate_schema(data_out, schema)
 
     # extract the output data
     meta = data_out["meta"]
     data = data_out["data"]
 
+    # check the metata
+    schema = {
+        "type": "object",
+        "required": [
+            "name",
+            "version",
+            "layout",
+            "seconds",
+            "duration",
+            "date",
+        ],
+        "properties": {
+            "meta" : {"type": "string", "minLength": 1},
+            "version" : {"type": "string", "minLength": 1},
+            "layout": {"type": "string", "minLength": 1},
+            "date": {"type": "string", "minLength": 1},
+            "duration": {"type": "string", "minLength": 1},
+            "seconds": {"type": "number", "minimum": 0},
+        }
+    }
+    scisave.validate_schema(meta, schema)
+
     # extract meta
     name = meta["name"]
     version = meta["version"]
-    datatype = meta["datatype"]
+    layout = meta["layout"]
 
-    # check that the datatype is correct
-    if datatype != datatype_out:
-        raise ValueError("invalid data format: %s" % datatype)
+    # check that the layout is correct
+    if layout != layout_out:
+        raise ValueError("invalid data format: %s" % layout)
 
     # display a warning in case of a version mismatch
     if (name != pypeec.__name__) or (version != pypeec.__version__):