Rename base class from Item to TimelineItem

(so that we can reuse Item to add deprecated
backwards compatibility in a next commit)

Author: fqqb

docs/timeline/model.rst

@@ -11,11 +11,6 @@ Model
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: yamcs.client.Item
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 .. autoclass:: yamcs.client.ItemBand
     :members:
     :undoc-members:
@@ -61,6 +56,11 @@ Model
     :undoc-members:
     :show-inheritance:
 
+.. autoclass:: yamcs.client.TimelineItem
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 .. autoclass:: yamcs.client.TimelineActivity
     :members:
     :undoc-members:

yamcs-client/src/yamcs/client/timeline/client.py

@@ -4,7 +4,7 @@
 from yamcs.client.core import pagination
 from yamcs.client.core.context import Context
 from yamcs.client.core.helpers import to_isostring, to_server_time
-from yamcs.client.timeline.model import Band, Item, View
+from yamcs.client.timeline.model import Band, TimelineItem, View
 from yamcs.protobuf.timeline import timeline_pb2
 
 __all__ = [
@@ -141,7 +141,7 @@ def list_items(
         start: Optional[datetime.datetime] = None,
         stop: Optional[datetime.datetime] = None,
         page_size: int = 500,
-    ) -> Iterable[Item]:
+    ) -> Iterable[TimelineItem]:
         """
         List the items.
 
@@ -171,10 +171,10 @@ def list_items(
             params=params,
             response_class=timeline_pb2.ListItemsResponse,
             items_key="items",
-            item_mapper=Item._as_subclass,
+            item_mapper=TimelineItem._as_subclass,
         )
 
-    def get_item(self, id: str) -> Item:
+    def get_item(self, id: str) -> TimelineItem:
         """
         Fetch an item by its identifier.
 
@@ -185,14 +185,14 @@ def get_item(self, id: str) -> Item:
         response = self.ctx.get_proto(url)
         message = timeline_pb2.TimelineItem()
         message.ParseFromString(response.content)
-        return Item._from_proto(message)
+        return TimelineItem._from_proto(message)
 
-    def save_item(self, item: Item):
+    def save_item(self, item: TimelineItem):
         """
         Save or update an item.
 
         :param item:
-            Item object
+            TimelineItem object
         """
         url = f"/timeline/{self._instance}/items/{item.id}"
         req = timeline_pb2.SaveItemRequest()

yamcs-client/src/yamcs/client/timeline/model.py

@@ -12,7 +12,6 @@
 __all__ = [
     "Band",
     "CommandBand",
-    "Item",
     "ItemBand",
     "OnCompletion",
     "OnFailure",
@@ -26,6 +25,7 @@
     "StartCondition",
     "TimelineActivity",
     "TimelineEvent",
+    "TimelineItem",
     "TimelineTask",
     "TimeRuler",
     "Trace",
@@ -84,13 +84,13 @@ class OnCompletion:
     success or failure).
     """
 
-    item: Union["Item", str]
+    item: Union["TimelineItem", str]
     """Predecessor item (or its identifier)"""
 
     @property
     def item_id(self) -> str:
         """Item identifier of the predecessor"""
-        if isinstance(self.item, Item):
+        if isinstance(self.item, TimelineItem):
             return self.item.id
         else:
             return self.item
@@ -103,13 +103,13 @@ def _to_predecessor(self) -> "Predecessor":
 class OnSuccess:
     """The item starts only if the predecessor has completed successfully."""
 
-    item: Union["Item", str]
+    item: Union["TimelineItem", str]
     """Predecessor item (or its identifier)"""
 
     @property
     def item_id(self) -> str:
         """Item identifier of the predecessor"""
-        if isinstance(self.item, Item):
+        if isinstance(self.item, TimelineItem):
             return self.item.id
         else:
             return self.item
@@ -122,13 +122,13 @@ def _to_predecessor(self) -> "Predecessor":
 class OnFailure:
     """The item starts only if the predecessor has failed."""
 
-    item: Union["Item", str]
+    item: Union["TimelineItem", str]
     """Predecessor item (or its identifier)"""
 
     @property
     def item_id(self) -> str:
         """Item identifier of the predecessor"""
-        if isinstance(self.item, Item):
+        if isinstance(self.item, TimelineItem):
             return self.item.id
         else:
             return self.item
@@ -141,13 +141,13 @@ def _to_predecessor(self) -> "Predecessor":
 class OnStart:
     """The item starts as soon as the predecessor has started."""
 
-    item: Union["Item", str]
+    item: Union["TimelineItem", str]
     """Predecessor item (or its identifier)"""
 
     @property
     def item_id(self) -> str:
         """Item identifier of the predecessor"""
-        if isinstance(self.item, Item):
+        if isinstance(self.item, TimelineItem):
             return self.item.id
         else:
             return self.item
@@ -165,7 +165,7 @@ def _to_predecessor(self) -> "Predecessor":
 @dataclass
 class Predecessor:
 
-    item: Union[str, "Item"]
+    item: Union[str, "TimelineItem"]
     """Predecessor item (or its identifier)"""
 
     start_condition: StartCondition = StartCondition.ON_SUCCESS
@@ -174,7 +174,7 @@ class Predecessor:
     @property
     def item_id(self) -> str:
         """Item identifier of the predecessor"""
-        if isinstance(self.item, Item):
+        if isinstance(self.item, TimelineItem):
             return self.item.id
         else:
             return self.item
@@ -193,7 +193,7 @@ def _to_proto(self) -> timeline_pb2.PredecessorInfo:
         return proto
 
 
-class Item(abc.ABC):
+class TimelineItem(abc.ABC):
 
     def __init__(
         self,
@@ -305,7 +305,7 @@ def _to_start_trigger(predecessor: Predecessor) -> StartTrigger:
 
     @staticmethod
     @abc.abstractmethod
-    def _from_proto(proto: timeline_pb2.TimelineItem) -> "Item":
+    def _from_proto(proto: timeline_pb2.TimelineItem) -> "TimelineItem":
         pass
 
     @staticmethod
@@ -338,7 +338,7 @@ def _to_proto(self) -> timeline_pb2.TimelineItem:
         return proto
 
 
-class TimelineEvent(Item):
+class TimelineEvent(TimelineItem):
     """
     An event on the timeline. This has a fixed start time, and an
     optional duration.
@@ -393,7 +393,7 @@ def __init__(
         :param extra:
             Project-specific properties (ignored by Yamcs)
         """
-        Item.__init__(
+        TimelineItem.__init__(
             self,
             name=name,
             start=start,
@@ -471,7 +471,7 @@ def _from_proto(proto: timeline_pb2.TimelineItem) -> "TimelineEvent":
 
 
 @dataclass
-class TimelineActivity(Item):
+class TimelineActivity(TimelineItem):
     """
     An activity on the timeline. Activities can be scheduled at a fixed
     time, or they can be scheduled relative to predecessor items.
@@ -515,7 +515,7 @@ def __init__(
         :param extra:
             Project-specific properties (ignored by Yamcs)
         """
-        Item.__init__(
+        TimelineItem.__init__(
             self,
             name=name,
             start=start,
@@ -538,9 +538,9 @@ def _from_proto(proto: timeline_pb2.TimelineItem) -> "TimelineActivity":
         if not predecessors:
             start = parse_server_time(proto.start)
         elif len(predecessors) == 1:
-            start = Item._to_start_trigger(predecessors[0])
+            start = TimelineItem._to_start_trigger(predecessors[0])
         else:
-            start = [Item._to_start_trigger(x) for x in predecessors]
+            start = [TimelineItem._to_start_trigger(x) for x in predecessors]
 
         item = TimelineActivity(
             id=proto.id,
@@ -571,7 +571,7 @@ def _to_proto(self) -> timeline_pb2.TimelineItem:
 
 
 @dataclass
-class TimelineTask(Item):
+class TimelineTask(TimelineItem):
     """
     A task on the timeline. Tasks are actions to be performed by the
     user. Tasks can be scheduled at a fixed time, or they can be
@@ -614,7 +614,7 @@ def __init__(
         :param extra:
             Project-specific properties (ignored by Yamcs)
         """
-        Item.__init__(
+        TimelineItem.__init__(
             self,
             name=name,
             start=start,
@@ -634,9 +634,9 @@ def _from_proto(proto: timeline_pb2.TimelineItem) -> "TimelineTask":
         if not predecessors:
             start = parse_server_time(proto.start)
         elif len(predecessors) == 1:
-            start = Item._to_start_trigger(predecessors[0])
+            start = TimelineItem._to_start_trigger(predecessors[0])
         else:
-            start = [Item._to_start_trigger(x) for x in predecessors]
+            start = [TimelineItem._to_start_trigger(x) for x in predecessors]
 
         item = TimelineTask(
             id=proto.id,