Remove Event suffix from stream events

The suffix doesn't add a lot of extra clarity and make names too long.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

RELEASE_NOTES.md

@@ -17,9 +17,9 @@
 
     for msg in recv:
         match msg:
-            case StreamStartedEvent():
+            case StreamStarted():
                 print("Stream started")
-            case StreamStoppedEvent() as event:
+            case StreamStopped() as event:
                 print(f"Stream stopped, reason {event.exception}, retry in {event.retry_time}")
             case int() as output:
                 print(f"Received message: {output}")

src/frequenz/client/base/streaming.py

@@ -27,12 +27,12 @@
 
 
 @dataclass(frozen=True, kw_only=True)
-class StreamStartedEvent:
+class StreamStarted:
     """Event indicating that the stream has started."""
 
 
 @dataclass(frozen=True, kw_only=True)
-class StreamStoppedEvent:
+class StreamStopped:
     """Event indicating that the stream has stopped."""
 
     retry_time: timedelta | None = None
@@ -42,7 +42,7 @@ class StreamStoppedEvent:
     """The exception that caused the stream to stop, if any."""
 
 
-StreamEvent: TypeAlias = StreamStartedEvent | StreamStoppedEvent
+StreamEvent: TypeAlias = StreamStarted | StreamStopped
 """Type alias for the events that can be sent over the stream."""
 
 
@@ -79,9 +79,9 @@ def async_range() -> AsyncIterable[int]:
 
         for msg in recv:
             match msg:
-                case StreamStartedEvent():
+                case StreamStarted():
                     print("Stream started")
-                case StreamStoppedEvent() as event:
+                case StreamStopped() as event:
                     print(f"Stream stopped, reason {event.exception}, retry in {event.retry_time}")
                 case int() as output:
                     print(f"Received message: {output}")
@@ -168,7 +168,7 @@ async def _run(self) -> None:
             _logger.info("%s: starting to stream", self._stream_name)
             try:
                 call = self._stream_method()
-                await sender.send(StreamStartedEvent())
+                await sender.send(StreamStarted())
                 async for msg in call:
                     await sender.send(self._transform(msg))
             except grpc.aio.AioRpcError as err:
@@ -177,7 +177,7 @@ async def _run(self) -> None:
             interval = self._retry_strategy.next_interval()
 
             await sender.send(
-                StreamStoppedEvent(
+                StreamStopped(
                     retry_time=timedelta(seconds=interval) if interval else None,
                     exception=error,
                 )

tests/streaming/test_grpc_stream_broadcaster.py

@@ -17,8 +17,8 @@
 from frequenz.client.base import retry, streaming
 from frequenz.client.base.streaming import (
     StreamEvent,
-    StreamStartedEvent,
-    StreamStoppedEvent,
+    StreamStarted,
+    StreamStopped,
 )
 
 
@@ -95,7 +95,7 @@ async def _split_message(
     events: list[StreamEvent] = []
     async for item in receiver:
         match item:
-            case StreamStartedEvent() | StreamStoppedEvent() as item:
+            case StreamStarted() | StreamStopped() as item:
                 events.append(item)
             case str():
                 items.append(item)
@@ -148,7 +148,7 @@ async def test_streaming_success_retry_on_exhausted(
         "transformed_4",
     ]
     assert events == [
-        StreamStoppedEvent(exception=None, retry_time=None),
+        StreamStopped(exception=None, retry_time=None),
     ]
 
     assert caplog.record_tuples == [
@@ -190,7 +190,7 @@ async def test_streaming_success(
         "transformed_4",
     ]
     assert events == [
-        StreamStoppedEvent(exception=None, retry_time=None),
+        StreamStopped(exception=None, retry_time=None),
     ]
     assert caplog.record_tuples == [
         (
@@ -337,11 +337,11 @@ async def test_messages_on_retry(
     assert [type(e) for e in events] == [
         type(e)
         for e in [
-            StreamStartedEvent(),
-            StreamStoppedEvent(
+            StreamStarted(),
+            StreamStopped(
                 exception=mock_error(), retry_time=timedelta(seconds=0.01)
             ),
-            StreamStartedEvent(),
-            StreamStoppedEvent(exception=mock_error(), retry_time=None),
+            StreamStarted(),
+            StreamStopped(exception=mock_error(), retry_time=None),
         ]
     ]