Deprecate Event.UNSPECIFIED

Mark `Event.UNSPECIFIED` as deprecated.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Author: llucax

src/frequenz/client/common/streaming/_event.py

@@ -3,14 +3,18 @@
 
 """Streaming event type enum."""
 
-import enum
+from frequenz.core.enum import Enum, deprecated_member, unique
 
 
-@enum.unique
-class Event(enum.Enum):
+@unique
+class Event(Enum):
     """A type of streaming event."""
 
-    UNSPECIFIED = 0
+    UNSPECIFIED = deprecated_member(
+        0,
+        "Event.UNSPECIFIED is deprecated; use the `int` value `0` "
+        "instead if you really need to check for this low-level value.",
+    )
     """Unspecified event type."""
 
     CREATED = 1

tests/streaming/proto/v1alpha8/test_event.py

@@ -21,3 +21,4 @@ class TestEventParity(EnumParityTest):
     name_prefix = "EVENT_"
     from_proto = staticmethod(event_from_proto)
     to_proto = staticmethod(event_to_proto)
+    deprecated_members = frozenset({"UNSPECIFIED"})

tests/streaming/test_event.py

@@ -3,13 +3,16 @@
 
 """Tests for the `Event` enum domain model."""
 
+import pytest
+
 from frequenz.client.common.streaming import Event
 
 
 def test_event_members() -> None:
     """Test that Event has the expected members with correct values."""
     assert [m.name for m in Event] == ["UNSPECIFIED", "CREATED", "UPDATED", "DELETED"]
-    assert Event.UNSPECIFIED.value == 0
+    with pytest.warns(DeprecationWarning):
+        assert Event.UNSPECIFIED.value == 0
     assert Event.CREATED.value == 1
     assert Event.UPDATED.value == 2
     assert Event.DELETED.value == 3