Add some backwards compatibility for Item objects

Author: fqqb

yamcs-client/src/yamcs/client/activities.py

@@ -2,13 +2,15 @@
 from dataclasses import dataclass, field
 from importlib.metadata import entry_points
 from typing import Any, List, Mapping, Optional, Union
+import warnings
 
 from yamcs.client.core.helpers import to_argument_value
 from yamcs.protobuf.activities import activities_pb2
 
 __all__ = [
     "Activity",
     "CommandActivity",
+    "ManualActivity",
     "ScriptActivity",
     "StackActivity",
 ]
@@ -219,3 +221,15 @@ def _to_proto(self) -> activities_pb2.ActivityDefinitionInfo:
         if self.processor:
             proto.args["processor"] = self.processor
         return proto
+
+
+@dataclass
+class ManualActivity(Activity):
+    def __post_init__(self):
+        warnings.warn(
+            "ManualActivity is deprecated. Instead of using "
+            "Item(activity=ManualActivity()), use the TimelineTask "
+            "class.",
+            category=DeprecationWarning,
+            stacklevel=3,
+        )

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

@@ -1,10 +1,10 @@
 import datetime
-from typing import Iterable, Optional
+from typing import Iterable, Optional, Union
 
 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, TimelineItem, View
+from yamcs.client.timeline.model import Band, Item, TimelineItem, View
 from yamcs.protobuf.timeline import timeline_pb2
 
 __all__ = [
@@ -187,13 +187,21 @@ def get_item(self, id: str) -> TimelineItem:
         message.ParseFromString(response.content)
         return TimelineItem._from_proto(message)
 
-    def save_item(self, item: TimelineItem):
+    def save_item(self, item: Union[TimelineItem, Item]):
         """
         Save or update an item.
 
-        :param item:
-            TimelineItem object
+        :param item: The item to persist.
+            Note: Support for the 'Item' type is deprecated and
+            maintained only for migration purposes. Transition
+            to one of the 'TimelineItem' subclasses
+            ('TimelineEvent', 'TimelineActivity', 'TimelineTask').
         """
+
+        # Temp backwards compatibility
+        if isinstance(item, Item):
+            item = item._to_timeline_item()
+
         url = f"/timeline/{self._instance}/items/{item.id}"
         req = timeline_pb2.SaveItemRequest()
 

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

@@ -1,18 +1,20 @@
 import abc
 import datetime
 import uuid
+import warnings
 from dataclasses import dataclass
 from enum import Enum
 from typing import Any, Dict, List, Optional, Union, cast
 
-from yamcs.client.activities import Activity
+from yamcs.client.activities import Activity, ManualActivity
 from yamcs.client.core.helpers import ProtoList, parse_server_time, to_server_time
 from yamcs.protobuf.timeline import timeline_pb2
 
 __all__ = [
     "Band",
     "CommandBand",
     "ItemBand",
+    "Item",
     "OnCompletion",
     "OnFailure",
     "OnStart",
@@ -1394,3 +1396,76 @@ def bands(self, value: List[Band]):
 
     def __str__(self):
         return self.name
+
+
+class Item:
+    def __init__(self):
+        warnings.warn(
+            "Item is deprecated and will be removed in a future version. "
+            "Use TimelineEvent, TimelineActivity, or TimelineTask instead.",
+            category=DeprecationWarning,
+            stacklevel=2,
+        )
+
+        self.name: str = None
+        self.tags: List[str] = []
+        self.start: datetime.datetime = None
+        self.duration: datetime.timedelta = None
+        self.activity: Optional[Activity] = None
+        self.background_color: Optional[str] = None
+        self.border_color: Optional[str] = None
+        self.border_width: Optional[int] = None
+        self.corner_radius: Optional[int] = None
+        self.margin_left: Optional[int] = None
+        self.text_color: Optional[str] = None
+        self.text_size: Optional[int] = None
+
+    @property
+    def item_type(self) -> str:
+        """Type of item."""
+        return timeline_pb2.TimelineItemType.Name(self._proto.type)
+
+    def _to_timeline_item(self) -> TimelineItem:
+        if self.activity:
+            if isinstance(self.activity, ManualActivity):
+                return self._to_timeline_task()
+            else:
+                return self._to_timeline_activity()
+        else:
+            return self._to_timeline_event()
+
+    def _to_timeline_task(self) -> TimelineTask:
+        item = TimelineTask(
+            name=self.name,
+            start=self.start,
+            tags=self.tags,
+            duration=self.duration,
+        )
+        return item
+
+    def _to_timeline_activity(self) -> TimelineActivity:
+        assert self.activity is not None
+        item = TimelineActivity(
+            name=self.name,
+            start=self.start,
+            tags=self.tags,
+            duration=self.duration,
+            activity=self.activity,
+        )
+        return item
+
+    def _to_timeline_event(self) -> TimelineEvent:
+        item = TimelineEvent(
+            name=self.name,
+            start=self.start,
+            tags=self.tags,
+            duration=self.duration,
+            background_color=self.background_color,
+            border_color=self.border_color,
+            border_width=self.border_width,
+            corner_radius=self.corner_radius,
+            margin_left=self.margin_left,
+            text_color=self.text_color,
+            text_size=self.text_size,
+        )
+        return item