Add tag filter support to gridpool trades stream

- Add `tag` parameter to `gridpool_trades()` method for filtering trades by tag
- Update `GridpoolTradeFilter` dataclass to include `tag` field
- Update equality and hash methods to include tag field
- Update `from_pb()` and `to_pb()` methods to handle tag serialization
- Bump frequenz-api-electricity-trading dependency to 0.9.0
- Update import path for PaginationParams to v1alpha8

Signed-off-by: Phillip Wenig <[email protected]>

Author: phillip-wenig-frequenz

pyproject.toml

@@ -46,7 +46,7 @@ dependencies = [
   "frequenz-channels >= 1.6.1, < 2",
   "frequenz-client-base >= 0.11.0, < 0.12.0",
   "frequenz-client-common >= 0.1.0, < 0.4.0",
-  "frequenz-api-electricity-trading >= 0.8.0, < 0.9.0",
+  "frequenz-api-electricity-trading >= 0.9.0, < 0.10.0",
   "protobuf >= 6.31.1, < 8", # Do not widen beyond 8!
 ]
 dynamic = ["version"]

src/frequenz/client/electricity_trading/_client.py

@@ -15,7 +15,7 @@
 from zoneinfo import ZoneInfo
 
 import grpc
-from frequenz.api.common.v1.pagination.pagination_params_pb2 import PaginationParams
+from frequenz.api.common.v1alpha8.pagination.pagination_params_pb2 import PaginationParams
 
 # pylint: disable=no-member
 from frequenz.api.electricity_trading.v1 import (
@@ -343,6 +343,7 @@ def gridpool_trades_stream(
         market_side: MarketSide | None = None,
         delivery_period: DeliveryPeriod | None = None,
         delivery_area: DeliveryArea | None = None,
+        tag: str | None = None,
     ) -> GrpcStreamBroadcaster[
         electricity_trading_pb2.ReceiveGridpoolTradesStreamResponse, Trade
     ]:
@@ -356,6 +357,7 @@ def gridpool_trades_stream(
             market_side: The market side to filter for.
             delivery_period: The delivery period to filter for.
             delivery_area: The delivery area to filter for.
+            tag: The tag to filter for.
 
         Returns:
             The gridpool trades streamer.
@@ -371,6 +373,7 @@ def gridpool_trades_stream(
             side=market_side,
             delivery_period=delivery_period,
             delivery_area=delivery_area,
+            tag=tag,
         )
 
         stream_key = (gridpool_id, gridpool_trade_filter)

src/frequenz/client/electricity_trading/_types.py

@@ -1576,6 +1576,9 @@ class GridpoolTradeFilter:
     delivery_area: DeliveryArea | None = None
     """Delivery area to filter for."""
 
+    tag: str | None = None
+    """Tag associated with the trades to be filtered."""
+
     def __eq__(self, other: object) -> bool:
         """
         Check if two GridpoolTradeFilter objects are equal.
@@ -1594,6 +1597,7 @@ def __eq__(self, other: object) -> bool:
             and self.side == other.side
             and self.delivery_period == other.delivery_period
             and self.delivery_area == other.delivery_area
+            and self.tag == other.tag
         )
 
     def __hash__(self) -> int:
@@ -1610,6 +1614,7 @@ def __hash__(self) -> int:
                 self.side,
                 self.delivery_period,
                 self.delivery_area,
+                self.tag,
             )
         )
 
@@ -1652,6 +1657,11 @@ def from_pb(
                 if gridpool_trade_filter.HasField("delivery_area")
                 else None
             ),
+            tag=(
+                gridpool_trade_filter.tag
+                if gridpool_trade_filter.HasField("tag")
+                else None
+            ),
         )
 
     def to_pb(self) -> electricity_trading_pb2.GridpoolTradeFilter:
@@ -1673,6 +1683,7 @@ def to_pb(self) -> electricity_trading_pb2.GridpoolTradeFilter:
                 self.delivery_period.to_pb() if self.delivery_period else None
             ),
             delivery_area=self.delivery_area.to_pb() if self.delivery_area else None,
+            tag=self.tag if self.tag else None,
         )