refact(net): propertize sol.overwrites

Author: ankostis

docs/source/arch.rst

@@ -122,7 +122,8 @@ Architecture
             to get back the given inputs in case of `overwrites`.
 
     overwrites
-        Values in the `solution` that are written by more than one `operation`\s.
+        Values in the `solution` that are written by more than one `operation`\s,
+        accessed by :attr:`Solution.overwrites`:
 
     net
     network

graphtik/network.py

@@ -165,6 +165,12 @@ class Solution(ChainMap, Plotter):
         a "virtual" property with executed operations that raised an exception
     :ivar canceled:
         A sorted set of operations canceled due to upstream failures.
+    :ivar overwrites:
+        a "virtual" property to a dictionary with keys the names of values that
+        exist more than once, and values, all those values in a list, ordered:
+
+        - before :meth:`finsihed()`, as computed;
+        - after :meth:`finsihed()`, in reverse.
     :ivar finished:
         a flag denoting that this instance cannot acccept more results
         (after the :meth:`finished` has been invoked)
@@ -216,13 +222,14 @@ def __delitem__(self, key):
         for d in self.maps:
             d.pop(key, None)
 
+    @property
     def overwrites(self) -> Mapping[Any, List]:
         """
-        Collect items in the maps that exist more than once.
+        The data in the solution that exist more than once.
 
         :return:
             a dictionary with keys only those items that existed in more than one map,
-            an values, all those values, in the order of given `maps`
+            and values, all those values, in the order of given `maps`
         """
         maps = self.maps
         dd = defaultdict(list)

test/test_graphtik.py

@@ -457,11 +457,11 @@ def test_pruning_not_overrides_given_intermediate(exemethod):
     #
     solution = pipeline.compute(inputs, ["asked"])
     assert solution == filtdict(exp, "asked")
-    assert solution.overwrites() == {}  # unjust must have been pruned
+    assert solution.overwrites == {}  # unjust must have been pruned
 
     solution = pipeline(**inputs)
     assert solution == exp
-    assert solution.overwrites() == {}  # unjust must have been pruned
+    assert solution.overwrites == {}  # unjust must have been pruned
 
 
 def test_pruning_multiouts_not_override_intermediates1(exemethod):
@@ -488,24 +488,24 @@ def test_pruning_multiouts_not_override_intermediates1(exemethod):
     # - on v4.0.0 (overidden, asked) := (5, 11)
     solution = pipeline.compute(inp1)
     assert solution == exp
-    assert solution.overwrites() == {"overidden": [5, 1]}
+    assert solution.overwrites == {"overidden": [5, 1]}
 
     # FAILs
     # - on v1.2.4 with KeyError: 'e',
     # - on #18(unsatisfied) + #23(ordered-sets) with empty result.
     # FIXED on #26
     solution = pipeline.compute(inp2, "asked")
     assert solution == exp2
-    assert solution.overwrites() == {}
+    assert solution.overwrites == {}
 
     ## Test OVERWITES
     #
     solution = pipeline.compute(inp1)
     assert solution == exp
-    assert solution.overwrites() == {"overidden": [5, 1]}
+    assert solution.overwrites == {"overidden": [5, 1]}
 
     solution = pipeline.compute(inp1, "asked")
-    assert solution.overwrites() == {}
+    assert solution.overwrites == {}
 
 
 @pytest.mark.xfail(
@@ -546,17 +546,17 @@ def test_pruning_multiouts_not_override_intermediates2(exemethod):
     #
     solution = pipeline.compute(inputs)
     assert solution == exp
-    assert solution.overwrites() == {"overidden": [5, 1]}
+    assert solution.overwrites == {"overidden": [5, 1]}
     # No overwrites when evicted.
     #
     solution = pipeline.compute(inputs, "asked")
     assert solution == filtdict(exp, "asked")
-    assert solution.overwrites() == {}
+    assert solution.overwrites == {}
     # ... but overrites collected if asked.
     #
     solution = pipeline.compute(inputs, ["asked", "overidden"])
     assert solution == filtdict(exp, "asked", "overidden")
-    assert solution.overwrites() == {"overidden": [5, 1]}
+    assert solution.overwrites == {"overidden": [5, 1]}
 
 
 def test_pruning_with_given_intermediate_and_asked_out(exemethod):
@@ -585,11 +585,11 @@ def test_pruning_with_given_intermediate_and_asked_out(exemethod):
     #
     solution = pipeline.compute(inps)
     assert solution == exp
-    assert solution.overwrites() == {}
+    assert solution.overwrites == {}
 
     solution = pipeline.compute(inps, "asked")
     assert solution == filtdict(exp, "asked")
-    assert solution.overwrites() == {}
+    assert solution.overwrites == {}
 
 
 def test_same_outputs_operations_order():
@@ -617,17 +617,17 @@ def test_same_outputs_operations_order():
     # Notice that `ab` assumed as 2 for `AB` but results in `2`
     solution = addsub.compute(inp)
     assert solution == {"a": 3, "b": 1, "ab": 2, "AB": 4}
-    assert solution.overwrites() == {"ab": [2, 4]}
+    assert solution.overwrites == {"ab": [2, 4]}
     solution = addsub.compute(inp, "AB")
     assert solution == {"AB": 4}
-    assert solution.overwrites() == {}
+    assert solution.overwrites == {}
 
     solution = subadd.compute(inp)
     assert solution == {"a": 3, "b": 1, "ab": 4, "AB": 2}
-    assert solution.overwrites() == {"ab": [4, 2]}
+    assert solution.overwrites == {"ab": [4, 2]}
     solution = subadd.compute(inp, "AB")
     assert solution == {"AB": 2}
-    assert solution.overwrites() == {}
+    assert solution.overwrites == {}
 
     assert subadd.compute(inp, "AB") == {"AB": 2}
     assert len(subadd.last_plan.steps) == 6