Merge pull request #70 from multiscale/update_port_timelines

Implement improved ideas regarding timelines for components and ports

Author: LourensVeen

ymmsl/v0_2/ports.py

@@ -105,9 +105,24 @@ def __len__(self) -> int:
         """Return the number of parts in the Timeline."""
         return len(self._parts)
 
-    def __getitem__(self, index: int) -> Reference:
-        """Return the index'th item in the timeline."""
-        return self._parts[index]
+    @overload
+    def __getitem__(self, index: int) -> Reference: ...
+
+    @overload
+    def __getitem__(self, index: slice) -> "Timeline": ...
+
+    def __getitem__(self, index: int | slice) -> "Reference | Timeline":
+        """Return an item or a subtimeline.
+
+        Args
+            key: Either an int, to retrieve the given item, or a slice, to return a new
+                Timeline object with the given items.
+        """
+        if isinstance(index, int):
+            return self._parts[index]
+        if isinstance(index, slice):
+            return Timeline(self._parts[index])
+        raise TypeError("Subscript must be either an int or a slice")
 
     def __iter__(self) -> Iterator[Reference]:
         """Iterate over the timeline parts."""
@@ -121,13 +136,20 @@ def __add__(self, other: Any) -> "Timeline":
                     "Cannot concatenate an absolute Timeline onto another one"
                 )
             return Timeline(self._parts + other._parts, self.absolute)
+
+        if isinstance(other, Reference):
+            return Timeline(self._parts + [other], self.absolute)
+
         return NotImplemented
 
     @property
-    def parent(self) -> "Timeline | None":
-        """Get the parent of this timeline. Returns None when there is no parent."""
+    def parent(self) -> "Timeline":
+        """Get the parent of this timeline.
+
+        Raises:
+            RuntimeError if this is the root and there is no parent."""
         if not self._parts:
-            return None
+            raise RuntimeError("The root timeline does not have a parent")
         return Timeline(self._parts[:-1], self.absolute)
 
     def relative_to(self, other: "Timeline") -> "Timeline":

ymmsl/v0_2/tests/test_ports.py

@@ -126,8 +126,11 @@ def test_timeline_concatenate_empty() -> None:
 
 
 def test_timeline_parent() -> None:
-    assert Timeline("").parent is None
-    assert Timeline(":").parent is None
+    with pytest.raises(RuntimeError, match="root timeline"):
+        _ = Timeline("").parent
+
+    with pytest.raises(RuntimeError, match="root timeline"):
+        _ = Timeline(":").parent
 
     assert Timeline("a:b").parent == Timeline("a")
     assert Timeline(":a:b").parent == Timeline(":a")

ymmsl/v0_2/tests/test_timeline_resolver.py

@@ -6,11 +6,11 @@
 from ymmsl.v0_2 import ConduitFilter, Configuration, Timeline
 from ymmsl.v0_2 import Reference as Ref
 from ymmsl.v0_2.timeline_resolver import (
-    ROOT_TIMELINE,
     ConduitTimelineError,
     CyclicDependency,
     InconsistentTimelines,
     TooManyReducerFilters,
+    check_timelines,
     resolve_timelines,
 )
 
@@ -29,24 +29,15 @@ def test_consistent_configuration(timelines_configuration: Configuration) -> Non
 def test_dispatch(timelines_configuration: Configuration) -> None:
     model = timelines_configuration.models[Ref("dispatch")]
     resolve_timelines(model)
-    assert model.components[Ref("first")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("second")].timeline == ROOT_TIMELINE
+    assert model.components[Ref("first")].timeline == ":first"
+    assert model.components[Ref("second")].timeline == ":second"
 
 
 def test_macromicro(timelines_configuration: Configuration) -> None:
     model = timelines_configuration.models[Ref("macromicro")]
     resolve_timelines(model)
-    assert model.components[Ref("macro")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("micro")].timeline == Timeline(":macro")
-
-    # Check that ports have the correct relative timelines:
-    macro = model.components[Ref("macro")]
-    assert macro.ports["init"].timeline == Timeline("")
-    assert macro.ports["out"].timeline == Timeline("macro")
-    assert macro.ports["in"].timeline == Timeline("macro")
-
-    for micro_port in model.components[Ref("micro")].ports.values():
-        assert micro_port.timeline == Timeline("")
+    assert model.components[Ref("macro")].timeline == Timeline(":macro")
+    assert model.components[Ref("micro")].timeline == Timeline(":macro:micro")
 
 
 def test_cycle(timelines_configuration: Configuration) -> None:
@@ -57,8 +48,8 @@ def test_cycle(timelines_configuration: Configuration) -> None:
 def test_reducer(timelines_configuration: Configuration) -> None:
     model = timelines_configuration.models[Ref("reducer")]
     resolve_timelines(model)
-    assert model.components[Ref("first")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("second")].timeline == ROOT_TIMELINE
+    assert model.components[Ref("first")].timeline == Timeline(":first")
+    assert model.components[Ref("second")].timeline == Timeline(":second")
 
 
 def test_only_reducer(timelines_configuration: Configuration) -> None:
@@ -67,8 +58,8 @@ def test_only_reducer(timelines_configuration: Configuration) -> None:
     del model.conduits[0]
     assert model.conduits[0].filters == [ConduitFilter("last")]
     resolve_timelines(model)
-    assert model.components[Ref("first")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("second")].timeline == ROOT_TIMELINE
+    assert model.components[Ref("first")].timeline == Timeline(":first")
+    assert model.components[Ref("second")].timeline == Timeline(":second")
 
 
 def test_too_many_reducers(timelines_configuration: Configuration) -> None:
@@ -86,9 +77,9 @@ def test_inconsistent_timelines(timelines_configuration: Configuration) -> None:
 def test_repeaters(timelines_configuration: Configuration) -> None:
     model = timelines_configuration.models[Ref("repeaters")]
     resolve_timelines(model)
-    assert model.components[Ref("macro")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("meso")].timeline == Timeline(":macro")
-    assert model.components[Ref("micro")].timeline == Timeline(":macro:meso")
+    assert model.components[Ref("macro")].timeline == Timeline(":macro")
+    assert model.components[Ref("meso")].timeline == Timeline(":macro:meso")
+    assert model.components[Ref("micro")].timeline == Timeline(":macro:meso:micro")
 
 
 def test_too_many_repeaters(timelines_configuration: Configuration) -> None:
@@ -115,10 +106,10 @@ def test_repeater_and_too_many_reducers(timelines_configuration: Configuration)
 def test_repeater_after_reducer(timelines_configuration: Configuration) -> None:
     model = timelines_configuration.models[Ref("repeater_reducer")]
     resolve_timelines(model)
-    assert model.components[Ref("macro1")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("macro2")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("micro1")].timeline == Timeline(":macro1")
-    assert model.components[Ref("micro2")].timeline == Timeline(":macro2")
+    assert model.components[Ref("macro1")].timeline == Timeline(":macro1")
+    assert model.components[Ref("macro2")].timeline == Timeline(":macro2")
+    assert model.components[Ref("micro1")].timeline == Timeline(":macro1:micro1")
+    assert model.components[Ref("micro2")].timeline == Timeline(":macro2:micro2")
 
     # Remove filters on the last conduit to make the incoming timelines inconsistent
     model.conduits[-1].filters = []
@@ -132,18 +123,26 @@ def test_repeater_after_reducer_error(timelines_configuration: Configuration) ->
         resolve_timelines(model)
     model.conduits[-1].filters = []
     resolve_timelines(model)
-    assert model.components[Ref("macro")].timeline == ROOT_TIMELINE
-    assert model.components[Ref("micro1")].timeline == Timeline(":macro")
-    assert model.components[Ref("micro2")].timeline == Timeline(":macro")
+    assert model.components[Ref("macro")].timeline == Timeline(":macro")
+    assert model.components[Ref("micro1")].timeline == Timeline(":macro:micro1")
+    assert model.components[Ref("micro2")].timeline == Timeline(":macro:micro2")
 
 
 def test_inconsistent_interact(timelines_configuration: Configuration) -> None:
     model = timelines_configuration.models[Ref("inconsistent_interact")]
     with pytest.raises(ConduitTimelineError, match="missing timeline annotations"):
         resolve_timelines(model)
-    model.components[Ref("B")].ports["out"].timeline = Timeline("A")
-    model.components[Ref("B")].ports["in"].timeline = Timeline("A")
-    resolve_timelines(model)
+    # TODO: add matching_timelines and try again successfully
+
+
+def test_subtimelines(timelines_configuration: Configuration) -> None:
+    model = timelines_configuration.models[Ref("different_subtimelines")]
+    check_timelines(model)
+
+    model.conduits[0].receiver = Ref("micro2.init")
+    model.conduits[2].receiver = Ref("micro1.init")
+    with pytest.raises(ConduitTimelineError, match="these do not match"):
+        resolve_timelines(model)
 
 
 def test_model_ports(timelines_configuration: Configuration) -> None:

ymmsl/v0_2/tests/ymmsl1/timelines.ymmsl

@@ -195,6 +195,12 @@ models:
       B.out: A.in
 
   model_ports:
+    ports:
+      f_init: init
+      timeline tl1:tl2:
+        o_i: out
+        s: in
+      o_f: final
     components:
       macro:
         description: macro
@@ -210,12 +216,6 @@ models:
           o_i: out
           s: in
           o_f: final
-    ports:
-      f_init: init
-      timeline macro:meso:
-        o_i: out
-        s: in
-      o_f: final
     conduits:
       init: macro.init
       macro.out: meso.init
@@ -238,3 +238,30 @@ models:
     conduits:
       mc.parameters_out: sim.muscle_settings_in
       sim.state_out: mc.states_in
+
+  different_subtimelines:
+    components:
+      macro:
+        description: macro with two subtimelines
+        ports:
+          timeline tl1:
+            o_i: out1
+            s: in1
+          timeline tl2:
+            o_i: out2
+            s: in2
+      micro1:
+        description: micro1
+        ports:
+          f_init: init
+          o_f: final
+      micro2:
+        description: micro2
+        ports:
+          f_init: init
+          o_f: final
+    conduits:
+      macro.out1: micro1.init
+      micro1.final: macro.in1
+      macro.out2: micro2.init
+      micro2.final: macro.in2