Recursively parse default env functions

Author: AntoinePrv

python/ecole/src/ecole/data.py

@@ -23,7 +23,9 @@ def parse(something, default):
 
     """
     if something == "default":
-        return default
+        if default is None:
+            raise ValueError("""Cannot parse "default" without a default value.""")
+        return parse(default, None)
     elif something is None:
         return NoneFunction()
     elif isinstance(something, numbers.Number):

python/ecole/tests/test_data.py

@@ -51,6 +51,21 @@ def test_MapFunction(model, done):
     assert data == {"name1": "something", "name2": "else"}
 
 
+@pytest.mark.parametrize("done", (True, False))
+@pytest.mark.parametrize("wall", (True, False))
+def test_TimedFunction(model, done, wall):
+    """Time a given data function."""
+    data_func = mock.MagicMock()
+    time_data_func = ecole.data.TimedFunction(data_func, wall=wall)
+
+    time_data_func.before_reset(model)
+    data_func.before_reset.assert_called_once_with(model)
+
+    pytest.helpers.advance_to_stage(model, ecole.scip.Stage.Solving)
+    time = time_data_func.extract(model, done)
+    assert time > 0
+
+
 def test_parse_None():
     """None is parsed as NoneFunction."""
     assert isinstance(ecole.data.parse(None, mock.MagicMock()), ecole.data.NoneFunction)
@@ -62,6 +77,12 @@ def test_parse_default():
     assert ecole.data.parse("default", default_func) == default_func
 
 
+def test_parse_self_reference():
+    """Default can not be used in the default function."""
+    with pytest.raises(ValueError):
+        ecole.data.parse("default", "default")
+
+
 def test_parse_number():
     """Number return ConstantFunction."""
     assert isinstance(ecole.data.parse(1, mock.MagicMock()), ecole.data.ConstantFunction)
@@ -98,16 +119,16 @@ def test_parse_recursive(model):
     assert data["name3"] == default_func.extract.return_value
 
 
-@pytest.mark.parametrize("done", (True, False))
-@pytest.mark.parametrize("wall", (True, False))
-def test_MapFunction(model, done, wall):
-    """Time a given data function."""
-    data_func = mock.MagicMock()
-    time_data_func = ecole.data.TimedFunction(data_func, wall=wall)
-
-    time_data_func.before_reset(model)
-    data_func.before_reset.assert_called_once_with(model)
-
-    pytest.helpers.advance_to_stage(model, ecole.scip.Stage.Solving)
-    time = time_data_func.extract(model, done)
-    assert time > 0
+def test_parse_recursive_default(model):
+    """Default function is parsed as well."""
+    aggregate = {
+        "name1": mock.MagicMock(),
+        "name2": (mock.MagicMock(), None, 1),
+    }
+    func = ecole.data.parse("default", aggregate)
+    # Using the extract method to inspect the recusive parsing since Vector, Map, Constant functions are private.
+    data = func.extract(model, False)
+    assert isinstance(data, dict)
+    assert isinstance(data["name2"], list)
+    assert data["name2"][1] is None
+    assert data["name2"][2] == 1