config: allow types other than string in get_target_option()/set_target_option()

There is no reason to limit options to strings. YAML supports scalars,
lists and dictionaries. As there is no way to write the options set
during runtime back to YAML, so there is no reason to limit the types for
the set_option() method either.

Lift this limitation, so YAML-supported data types can be retrieved and
all data types can be set.

Note that this changes previous behavior, because now options are not
converted to strings anymore.

Signed-off-by: Bastian Krause <bst@pengutronix.de>

Author: Bastian-Krause

labgrid/config.py

@@ -176,11 +176,11 @@ def get_target_option(self, target, name, default=None):
         Args:
             target (str): name of the target
             name (str): name of the option
-            default (str): A default parameter in case the option can not be
+            default (any): A default parameter in case the option can not be
                 found
 
         Returns:
-            str: value of the option or default parameter
+            any: value of the option or default parameter
 
         Raises:
             KeyError: if the requested key can not be found in the
@@ -191,7 +191,7 @@ def get_target_option(self, target, name, default=None):
             raise KeyError(f"No target '{target}' found in configuration")
 
         try:
-            return str(self.data['targets'][target]['options'][name])
+            return self.data['targets'][target]['options'][name]
         except (KeyError, TypeError):
             # Empty target declarations become None in the target dict, hence
             # TypeError when we try to subscript it.
@@ -206,15 +206,14 @@ def set_target_option(self, target, name, value):
         Args:
             target (str): name of the target
             name (str): name of the option
-            value (str): the new value
+            value (any): the new value
 
         Raises:
             KeyError: if the requested target can not be found in the
                 configuration
         """
         assert isinstance(target, str)
         assert isinstance(name, str)
-        assert isinstance(value, str)
 
         if target not in self.data['targets']:
             raise KeyError(f"No target '{target}' found in configuration")

tests/test_config.py

@@ -1,3 +1,5 @@
+from collections import OrderedDict
+
 import pytest
 
 from labgrid.config import Config
@@ -10,19 +12,32 @@ def test_get_target_option(tmpdir):
         targets:
           main:
             options:
-              foo: bar
-              spam: eggs
+              str: test
+              list: [1, 2, 3]
+              dict:
+                a: 1
+                b: 2
+              bool: False
+              int: 0x20
+              float: 3.14
+              none: null
         """
     )
     c = Config(str(p))
-    assert c.get_target_option("main", "spam") == "eggs"
+    assert c.get_target_option("main", "str") == "test"
+    assert c.get_target_option("main", "list") == [1, 2, 3]
+    assert c.get_target_option("main", "dict") == OrderedDict([('a', 1), ('b', 2)])
+    assert c.get_target_option("main", "bool") is False
+    assert c.get_target_option("main", "int") == 0x20
+    assert c.get_target_option("main", "float") == 3.14
+    assert c.get_target_option("main", "none") is None
 
     with pytest.raises(KeyError) as err:
         c.get_target_option("main", "blah")
     assert "No option" in str(err)
 
     with pytest.raises(KeyError) as err:
-        c.get_target_option("nonexist", "spam")
+        c.get_target_option("nonexist", "str")
     assert "No target" in str(err)
 
 def test_set_target_option(tmpdir):
@@ -42,6 +57,10 @@ def test_set_target_option(tmpdir):
     c.set_target_option("main", "spam", "eggs")
     assert c.get_target_option("main", "spam") == "eggs"
 
+    obj = object()
+    c.set_target_option("main", "obj", obj)
+    assert c.get_target_option("main", "obj") is obj
+
 def test_template(tmpdir):
     p = tmpdir.join("config.yaml")
     p.write(