Merge pull request #372 from apdavison/fix-parameters

Fix a different in interface between NTParameterSet and the other ParameterSet classes

Author: apdavison

sumatra/parameters.py

@@ -60,7 +60,7 @@ class ParameterSet(metaclass=abc.ABCMeta):
 
     def _new_param_check(self, name, value):
         try:
-            self.values[name]
+            self._values[name]
         except KeyError:
             raise ValueError("")
 
@@ -98,6 +98,9 @@ def parse_command_line_parameter(self, p):
     def diff(self, other):
         return _dict_diff(self, other)
 
+    def items(self):
+        return self._values
+
 
 def _dict_diff(a, b):
         a_keys = set(a.keys())
@@ -139,16 +142,16 @@ def __init__(self, initialiser):
             try:
                 if os.path.exists(initialiser):
                     with open(initialiser) as fid:
-                        self.values = yaml.safe_load(fid)
+                        self._values = yaml.safe_load(fid)
                     self.source_file = initialiser
                 else:
                     if initialiser:
-                        self.values = yaml.safe_load(initialiser)
+                        self._values = yaml.safe_load(initialiser)
                     else:
-                        self.values = {}
+                        self._values = {}
             except yaml.YAMLError:
                 raise SyntaxError("Misformatted YAML file")
-            if not isinstance(self.values, dict):
+            if not isinstance(self._values, dict):
                 raise SyntaxError("YAML file cannot be represented as a dict")
         else:
             raise ImportError("Cannot import PyYAML module")
@@ -157,7 +160,7 @@ def __str__(self):
         return self.pretty()
 
     def __getitem__(self, name):
-        return self.values[name]
+        return self._values[name]
 
     def __eq__(self, other):
         return self.as_dict() == other.as_dict()
@@ -166,7 +169,7 @@ def __ne__(self, other):
         return not self.__eq__(other)
 
     def keys(self):
-        return self.values.keys()
+        return self._values.keys()
 
     def pretty(self, expand_urls=False):
         """
@@ -177,26 +180,26 @@ def pretty(self, expand_urls=False):
                     not used.
         """
 
-        output = yaml.dump(self.values, indent=4)
+        output = yaml.dump(self._values, indent=4)
         return output
 
     def as_dict(self):
-        return self.values
+        return self._values
 
     def save(self, filename, add_extension=False):
         if add_extension:
             filename += ".yaml"
         with open(filename, "w") as f:
-            yaml.dump(self.values, f)
+            yaml.dump(self._values, f)
         return filename
 
     def update(self, E, **F):
-        self.values.update(E, **F)
+        self._values.update(E, **F)
     update.__doc__ = dict.update.__doc__
 
     def pop(self, key, d=None):
-        if key in self.values:
-            return self.values.pop(key)
+        if key in self._values:
+            return self._values.pop(key)
         else:
             return d
 
@@ -209,9 +212,13 @@ class NTParameterSet(parameters.ParameterSet, ParameterSet):
     def save(self, filename, add_extension=False):
         if add_extension:
             filename += ".params"
-        super().save(filename)
+        super(NTParameterSet, self).save(filename)
         return filename
 
+    def _new_param_check(self, name, value):
+        if name not in self:
+            raise ValueError("")
+
 
 @component
 class SimpleParameterSet(ParameterSet):
@@ -228,7 +235,7 @@ def __init__(self, initialiser):
         Create a new parameter set from a file or string. In both cases,
         parameters should be separated by newlines.
         """
-        self.values = {}
+        self._values = {}
         self.types = {}
         self.comments = {}
         if isinstance(initialiser, dict):
@@ -298,7 +305,7 @@ def _add_or_update_parameter(self, name, value, comment=None):
         if value is not None and not isinstance(value, (int, float, str, bool, list, tuple)):
             raise TypeError("Value must be one of the basic types (a numeric value, bool, "
                 "string, list, tuple or None. Got: '{}' ({})".format(value, type(value)))
-        self.values[name] = value
+        self._values[name] = value
         self.types[name] = type(value)
         if comment is not None:
             self.comments[name] = comment
@@ -307,20 +314,20 @@ def __str__(self):
         return self.pretty()
 
     def __getitem__(self, name):
-        return self.values[name]
+        return self._values[name]
 
     def __eq__(self, other):
-        return ((self.values == other.values) and (self.types == other.types))
+        return ((self._values == other._values) and (self.types == other.types))
 
     def __ne__(self, other):
         return not self.__eq__(other)
 
     def keys(self):
-        return self.values.keys()
+        return self._values.keys()
 
     def pop(self, k, d=POP_NONE):
-        if k in self.values:
-            v = self.values.pop(k)
+        if k in self._values:
+            v = self._values.pop(k)
             self.types.pop(k)
             self.comments.pop(k, None)
             return v
@@ -338,7 +345,7 @@ def pretty(self, expand_urls=False):
                     not used.
         """
         output = []
-        for name, value in self.values.items():
+        for name, value in self._values.items():
             if isinstance(value, str):
                 output.append('%s = "%s"' % (name, value))
             else:
@@ -348,7 +355,7 @@ def pretty(self, expand_urls=False):
         return "\n".join(output)
 
     def as_dict(self):
-        return self.values.copy()
+        return self._values.copy()
 
     def save(self, filename, add_extension=False):
         if add_extension:
@@ -506,21 +513,21 @@ def __init__(self, initialiser):
         try:
             if os.path.exists(initialiser):
                 with open(initialiser) as fid:
-                    self.values = json.load(fid)
+                    self._values = json.load(fid)
                 self.source_file = initialiser
             else:
                 if initialiser:
-                    self.values = json.loads(initialiser)
+                    self._values = json.loads(initialiser)
                 else:
-                    self.values = {}
+                    self._values = {}
         except ValueError:
             raise SyntaxError("Misformatted JSON file")
 
     def __str__(self):
         return self.pretty()
 
     def __getitem__(self, name):
-        return self.values[name]
+        return self._values[name]
 
     def __eq__(self, other):
         return self.as_dict() == other.as_dict()
@@ -529,7 +536,7 @@ def __ne__(self, other):
         return not self.__eq__(other)
 
     def keys(self):
-        return self.values.keys()
+        return self._values.keys()
 
     def pretty(self, expand_urls=False):
         """
@@ -540,26 +547,26 @@ def pretty(self, expand_urls=False):
                     not used.
         """
 
-        output = json.dumps(self.values, sort_keys=True, indent=4)
+        output = json.dumps(self._values, sort_keys=True, indent=4)
         return output
 
     def as_dict(self):
-        return self.values
+        return self._values
 
     def save(self, filename, add_extension=False):
         if add_extension:
             filename += ".json"
         with open(filename, "w") as f:
-            json.dump(self.values, f)
+            json.dump(self._values, f)
         return filename
 
     def update(self, E, **F):
-        self.values.update(E, **F)
+        self._values.update(E, **F)
     update.__doc__ = dict.update.__doc__
 
     def pop(self, key, d=None):
-        if key in self.values:
-            return self.values.pop(key)
+        if key in self._values:
+            return self._values.pop(key)
         else:
             return d
 

test/unittests/test_parameters.py

@@ -86,7 +86,7 @@ def test__init__should_accept_hash_as_comment_character(self):
 
     def test__init__should_accept_an_empty_initializer(self):
         P = SimpleParameterSet("")
-        self.assertEqual(P.values, {})
+        self.assertEqual(P._values, {})
 
     def test__init__should_accept_dict(self):
         P = SimpleParameterSet({'x': 2, 'y': 3})
@@ -99,7 +99,7 @@ def test__init__should_accept_a_filename_or_string(self):
         with open("test_file", "w") as f:
             f.write(init)
         P2 = SimpleParameterSet("test_file")
-        self.assertEqual(P1.values, P2.values)
+        self.assertEqual(P1.items(), P2.items())
         os.remove("test_file")
 
     def test__init__should_raise_a_TypeError_if_initializer_is_not_a_filename_or_string(self):
@@ -167,7 +167,7 @@ def test__pretty__output_should_be_useable_to_create_an_identical_parameterset(s
         init = "x = 2\ny = 3\nz = 'hello'"
         P1 = SimpleParameterSet(init)
         P2 = SimpleParameterSet(P1.pretty())
-        self.assertEqual(P1.values, P2.values)
+        self.assertEqual(P1.items(), P2.items())
 
     def test__save__should_backup_an_existing_file_before_overwriting_it(self):
         # not really sure what the desired behaviour is here