pygrass: Better handling of multiple and keydescvalues parameters

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@61183 15284696-431f-4ddb-bdfa-cd5b030d7da7

lib/python/pygrass/modules/interface/parameter.py

@@ -46,21 +46,24 @@ def _check_value(param, value):
     if value is None:
         return param.default, param.default
 
-    # find errors with multiple parmaeters
-    if param.multiple or param.keydescvalues:
-        if not isinstance(value, (list, tuple)):
-            msg = ('The Parameter <%s> require multiple inputs,'
-                   ' give: %r instaed')
-            raise TypeError(msg % (param.name, value))
-        # everything looks fine, so check each value
-        try:
-            return [param.type(check_string(val)) for val in value], value
-        except Exception as exc:
-            raiseexcpet(exc, param, param.type, value)
-    elif isinstance(value, (list, tuple)):
-        # this check is needed to avoid a list is converted to string silently
-        msg = 'The Parameter <%s> does not accept multiple inputs'
-        raise TypeError(msg % param.name)
+    # find errors with multiple parmeters
+    if isinstance(value, (list, tuple)):
+        if param.keydescvalues:
+            return (([value, ], value) if isinstance(value, tuple)
+                    else (value, value))
+        if param.multiple:
+            # everything looks fine, so check each value
+            try:
+                return [param.type(check_string(val)) for val in value], value
+            except Exception as exc:
+                raiseexcpet(exc, param, param.type, value)
+        else:
+            msg = 'The Parameter <%s> does not accept multiple inputs'
+            raise TypeError(msg % param.name)
+
+    if param.keydescvalues:
+        msg = 'The Parameter <%s> require multiple inputs in the form: %s'
+        raise TypeError(msg % (param.name, param.keydescvalues))
 
     if param.typedesc == 'all':
         return value, value
@@ -86,7 +89,8 @@ def _check_value(param, value):
         # check if value is in the list of valid values
         if param.values is not None and newvalue not in param.values:
             raise ValueError(must_val % (param.name, param.values))
-    return newvalue, value
+    return (([newvalue, ] if (param.multiple or param.keydescvalues)
+             else newvalue), value)
 
 
 # TODO add documentation

lib/python/pygrass/modules/interface/testsuite/test_parameter.py

@@ -69,12 +69,16 @@ class TestCheckValueFunction(unittest.TestCase):
             value = ("1.4", "2.3")
             self.assertTupleEqual(([float(v) for v in value], value),
                                   _check_value(param, value))
+            value = 1.
+            self.assertTupleEqual(([value, ], value),
+                                  _check_value(param, value))
+            value = 1
+            self.assertTupleEqual(([value, ], value),
+                                  _check_value(param, value))
 
             # test errors
-            with self.assertRaises(TypeError):
-                _check_value(param, 1.)
-            with self.assertRaises(TypeError):
-                _check_value(param, 1)
+            with self.assertRaises(ValueError):
+                _check_value(param, "elev")
             with self.assertRaises(ValueError):
                 _check_value(param, ("elev", "slope", "aspect"))
 
@@ -124,6 +128,7 @@ class TestCheckValueFunction(unittest.TestCase):
         param = Parameter(diz=dict(name='int_number', required='yes',
                                    multiple='yes', type='integer'))
         value = (1, 2)
+        #import ipdb; ipdb.set_trace()
         self.assertTupleEqual((list(value), value), _check_value(param, value))
         value = (1.2, 2.3)
         self.assertTupleEqual(([int(v) for v in value], value),
@@ -131,19 +136,36 @@ class TestCheckValueFunction(unittest.TestCase):
         value = ("1", "2")
         self.assertTupleEqual(([int(v) for v in value], value),
                               _check_value(param, value))
+        value = 1
+        self.assertTupleEqual(([1, ], value), _check_value(param, value))
+        value = 1.2
+        self.assertTupleEqual(([int(value), ], value),
+                              _check_value(param, value))
+        value = "1"
+        self.assertTupleEqual(([int(value), ], value),
+                              _check_value(param, value))
 
         # test errors
-        with self.assertRaises(TypeError):
-            _check_value(param, 1)
-        with self.assertRaises(TypeError):
-            _check_value(param, 1.0)
-        with self.assertRaises(TypeError):
-            _check_value(param, "1.")
-        with self.assertRaises(TypeError):
+        with self.assertRaises(ValueError):
             _check_value(param, "elev")
         with self.assertRaises(ValueError):
             _check_value(param, ("elev", "slope", "aspect"))
 
+    def test_keydescvalues(self):
+        for ptype in ('integer', 'float'):
+            param = Parameter(diz=dict(name='int_number', required='yes',
+                                       multiple='yes',
+                                       keydesc=('range', '(min, max)'),
+                                       type='integer'))
+            value = (1, 2)
+            self.assertTupleEqual(([value, ], value),
+                                  _check_value(param, value))
+            value = [(1, 2), (2, 3)]
+            self.assertTupleEqual((value, value), _check_value(param, value))
+
+            with self.assertRaises(TypeError):
+                _check_value(param, 1)
+
     def test_range_integer(self):
         param = Parameter(diz=dict(name='int_number', required='yes',
                                    multiple='no', type='integer',
@@ -224,6 +246,8 @@ class TestCheckValueFunction(unittest.TestCase):
         value = (1, 2, 3)
         self.assertTupleEqual(([str(v) for v in value], value),
                               _check_value(param, value))
+        value = 'elev'
+        self.assertTupleEqual(([value, ], value), _check_value(param, value))
 
         # test errors
         with self.assertRaises(ValueError):
@@ -234,7 +258,7 @@ class TestCheckValueFunction(unittest.TestCase):
         param = Parameter(diz=dict(name='rastname', required='yes',
                                    multiple='no', type='string',
                                    values=values))
-        value="asp"
+        value = "asp"
         self.assertTupleEqual((value, value), _check_value(param, value))
 
         # test errors