Support listing invalid orders

When listing, gridpool orders are filtered by validity. Valid orders
require a finite price and quantity to be set unless they are
cancelled. The filter can optionally be disabled when calling the
endpoint.

Signed-off-by: cwasicki <[email protected]>

Author: cwasicki

src/frequenz/client/electricity_trading/_client.py

@@ -809,6 +809,7 @@ async def list_gridpool_orders(
         tag: str | None = None,
         page_size: int | None = None,
         timeout: timedelta | None = None,
+        valid_only: bool = True,
     ) -> AsyncIterator[OrderDetail]:
         """
         List orders for a specific Gridpool with optional filters.
@@ -822,6 +823,7 @@ async def list_gridpool_orders(
             tag: The tag to filter by.
             page_size: The number of orders to return per page.
             timeout: Timeout duration, defaults to None.
+            valid_only: If True, only returns orders that are valid.
 
         Yields:
             The list of orders for the given gridpool.
@@ -856,9 +858,11 @@ async def list_gridpool_orders(
                         timeout=timeout,
                     ),
                 )
-
                 for order_detail in response.order_details:
-                    yield OrderDetail.from_pb(order_detail)
+                    od = OrderDetail.from_pb(order_detail)
+                    if valid_only and not od.is_valid:
+                        continue
+                    yield od
 
                 if response.pagination_info.next_page_token:
                     request.pagination_params.CopyFrom(

src/frequenz/client/electricity_trading/_types.py

@@ -1316,9 +1316,6 @@ def from_pb(cls, order_detail: electricity_trading_pb2.OrderDetail) -> Self:
 
         Returns:
             OrderDetail object corresponding to the protobuf message.
-
-        Raises:
-            ValueError: If the order price and quantity are not specified for a non-canceled order.
         """
         od = cls(
             order_id=order_detail.order_id,
@@ -1332,18 +1329,24 @@ def from_pb(cls, order_detail: electricity_trading_pb2.OrderDetail) -> Self:
             ),
         )
 
+        return od
+
+    @property
+    def is_valid(self) -> bool:
+        """Check if the order detail is valid.
+
+        Returns:
+            True if the order detail is valid, False otherwise.
+        """
         # Only cancelled orders are allowed to have missing price or quantity
-        missing_price_or_quantity = (
-            od.order.price.amount.is_nan()
-            or od.order.price.currency == Currency.UNSPECIFIED
-            or od.order.quantity.mw.is_nan()
-        )
-        if missing_price_or_quantity and od.state_detail.state != OrderState.CANCELED:
-            raise ValueError(
-                f"Price and quantity must be specified for a non-canceled order (`{od}`)."
-            )
+        if self.state_detail.state == OrderState.CANCELED:
+            return True
 
-        return od
+        return not (
+            self.order.price.amount.is_nan()
+            or self.order.price.currency == Currency.UNSPECIFIED
+            or self.order.quantity.mw.is_nan()
+        )
 
     def to_pb(self) -> electricity_trading_pb2.OrderDetail:
         """Convert an OrderDetail object to protobuf OrderDetail.

tests/test_types.py

@@ -554,22 +554,24 @@ def test_order_detail_from_pb_missing_fields() -> None:
     # Missing price
     od_pb1 = electricity_trading_pb2.OrderDetail()
     od_pb1.CopyFrom(ORDER_DETAIL_PB)
+    assert OrderDetail.from_pb(od_pb1).is_valid
     od_pb1.order.ClearField("price")
     # Not allowed for active orders
-    with pytest.raises(ValueError):
-        OrderDetail.from_pb(od_pb1)
+    assert not OrderDetail.from_pb(od_pb1).is_valid
     # But allowed for canceled orders
     od_pb1.state_detail.state = electricity_trading_pb2.OrderState.ORDER_STATE_CANCELED
     OrderDetail.from_pb(od_pb1)
+    assert OrderDetail.from_pb(od_pb1).is_valid
 
     # Missing quantity (same logic as above)
     od_pb2 = electricity_trading_pb2.OrderDetail()
     od_pb2.CopyFrom(ORDER_DETAIL_PB)
+    assert OrderDetail.from_pb(od_pb2).is_valid
     od_pb2.order.ClearField("quantity")
-    with pytest.raises(ValueError):
-        OrderDetail.from_pb(od_pb2)
+    assert not OrderDetail.from_pb(od_pb2).is_valid
     od_pb2.state_detail.state = electricity_trading_pb2.OrderState.ORDER_STATE_CANCELED
     OrderDetail.from_pb(od_pb2)
+    assert OrderDetail.from_pb(od_pb2).is_valid
 
 
 def test_order_detail_no_timezone_error() -> None: