WIP: add minimal validation of dicts on template init

Author: mhidas

ncwriter/template.py

@@ -21,6 +21,19 @@
 import numpy as np
 
 
+def validate_dict(o, name):
+    """
+    Check that the given object is a dictionary. If not, raise TypeError.
+
+    :param o: The object to validate.
+    :param str name: The name of the object to use in the error message.
+    :return: None
+    """
+
+    if not isinstance(o, dict):
+        raise TypeError("{name} should be a dictionary (got {o})".format(name=name, o=repr(o)))
+
+
 class NetCDFGroupDict(object):
     def __init__(self,
                  dimensions=None,
@@ -54,6 +67,10 @@ def __init__(self,
                 #w4.variables.keys() = ['temp']
                 #w4.dimensions = {'lon':720,'lat':330,'time':300}
         """
+        self._dimensions = None
+        self._variables = None
+        self._global_attributes = None
+
         self.title = title
         self.dimensions = dimensions or OrderedDict()
         self.variables = variables or OrderedDict()
@@ -83,6 +100,33 @@ def __add__(self, other):
         self_copy.title = "{t1} + {t2}".format(t1=self.title, t2=other.title)
         return self_copy
 
+    @property
+    def dimensions(self):
+        return self._dimensions
+
+    @dimensions.setter
+    def dimensions(self, value):
+        validate_dict(value, 'dimensions')
+        self._dimensions = value
+
+    @property
+    def variables(self):
+        return self._variables
+
+    @variables.setter
+    def variables(self, value):
+        validate_dict(value, 'variables')
+        self._variables = value
+
+    @property
+    def global_attributes(self):
+        return self._global_attributes
+
+    @global_attributes.setter
+    def global_attributes(self, value):
+        validate_dict(value, 'global_attributes')
+        self._global_attributes = value
+
     def is_dim_consistent(self):
         """Check if the variable dictionary
         is consistent with current dimensions"""

test_ncwriter/test_template.py

@@ -56,6 +56,22 @@ def test_init_from_dicts(self):
         self.assertEqual(self.variables, template.variables)
         self.assertEqual(self.global_attributes, template.global_attributes)
 
+    def test_init_from_dicts_validation(self):
+        with self.assertRaises(TypeError):
+            DatasetTemplate(dimensions='TIME')
+        with self.assertRaises(TypeError):
+            DatasetTemplate(dimensions=100)
+        with self.assertRaises(TypeError):
+            DatasetTemplate(dimensions=['TIME', 'Z'])
+
+        with self.assertRaises(TypeError):
+            DatasetTemplate(variables='TEMP')
+        with self.assertRaises(TypeError):
+            DatasetTemplate(variables=['TEMP', 'PSAL'])
+
+        with self.assertRaises(TypeError):
+            DatasetTemplate(global_attributes=['title', 'abstract'])
+
     def test_init_from_json(self):
         template = DatasetTemplate.from_json(TEMPLATE_JSON)
         self.assertEqual(self.dimensions, template.dimensions)