Update to electricity trading API v0.0.8 (#150)

Author: matthias-wende-frequenz

RELEASE_NOTES.md

@@ -1,17 +1,14 @@
 # Frequenz Electricity Trading API Client Release Notes
 
-## Summary
-
-<!-- Here goes a general summary of what this release is about -->
-
 ## Upgrading
 
-- The client interface now requires that other than the `gridpool_id`, all parameters to client methods are kw-only, and can't be specified as positional arguments.
+- The minimum allowed version of `protobuf` and `grpcio` has been updated to 6.31.1 and 1.72.1 respectively.
 
 ## New Features
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+- Updated to `v0.8.0` of the Electricity Trading API.
+- Updated to `v0.11.0` of the base client library.
 
 ## Bug Fixes
 
-- Usage examples have been fixed.
+- Added `OrderType` field to `PublicOrder` class.

pyproject.toml

@@ -40,13 +40,13 @@ requires-python = ">= 3.11, < 4"
 dependencies = [
   "click >= 8.1.8, < 9",
   "entsoe-py >= 0.6.16, < 1",
-  "frequenz-api-common >= 0.6.3, < 0.7.0",
-  "grpcio >= 1.68.1, < 2",
+  "frequenz-api-common >= 0.6.5, < 0.7.0",
+  "grpcio >= 1.72.1, < 2",
   "frequenz-channels >= 1.6.1, < 2",
-  "frequenz-client-base >= 0.9.0, < 0.10.0",
+  "frequenz-client-base >= 0.11.0, < 0.12.0",
   "frequenz-client-common >= 0.1.0, < 0.4.0",
-  "frequenz-api-electricity-trading >= 0.7.0, < 0.8.0",
-  "protobuf >= 5.29.2, < 7",
+  "frequenz-api-electricity-trading >= 0.8.0, < 0.9.0",
+  "protobuf >= 6.31.1, < 8", # Do not widen beyond 8!
 ]
 dynamic = ["version"]
 
@@ -171,11 +171,22 @@ disable = [
 ]
 
 [tool.pytest.ini_options]
-addopts = "-W=all -Werror -Wdefault::DeprecationWarning -Wdefault::PendingDeprecationWarning -vv"
+addopts = "-vv"
 testpaths = ["tests", "src"]
 asyncio_default_fixture_loop_scope = "function"
 asyncio_mode = "auto"
 required_plugins = ["pytest-asyncio", "pytest-mock"]
+filterwarnings = [
+  "error",
+  "once::DeprecationWarning",
+  "once::PendingDeprecationWarning",
+  # We ignore warnings about protobuf gencode version being one version older
+  # than the current version, as this is supported by protobuf, and we expect to
+  # have such cases. If we go too far, we will get a proper error anyways.
+  # We use a raw string (single quotes) to avoid the need to escape special
+  # characters as this is a regex.
+  'ignore:Protobuf gencode version .*exactly one major version older.*:UserWarning',
+]
 
 [tool.mypy]
 explicit_package_bases = true

src/frequenz/client/electricity_trading/_types.py

@@ -1959,6 +1959,9 @@ class PublicOrder:  # pylint: disable=too-many-instance-attributes
     delivery_period: DeliveryPeriod
     """The delivery period for the contract."""
 
+    type: OrderType | None
+    """The type of order (e.g., LIMIT, STOP_LIMIT, ICEBERG)."""
+
     side: MarketSide
     """Indicates if the order is on the Buy or Sell side of the market."""
 
@@ -2007,11 +2010,17 @@ def from_pb(
             if public_order.HasField("execution_option")
             else None
         )
+        order_type = (
+            OrderType.from_pb(public_order.type)
+            if public_order.HasField("type")
+            else None
+        )
 
         return cls(
             public_order_id=public_order.id,
             delivery_area=DeliveryArea.from_pb(public_order.delivery_area),
             delivery_period=DeliveryPeriod.from_pb(public_order.delivery_period),
+            type=order_type,
             side=MarketSide.from_pb(public_order.side),
             price=Price.from_pb(public_order.price),
             quantity=Power.from_pb(public_order.quantity),

tests/test_types.py

@@ -179,6 +179,7 @@
     public_order_id=42,
     delivery_area=DeliveryArea(code="XYZ", code_type=EnergyMarketCodeType.EUROPE_EIC),
     delivery_period=DeliveryPeriod(start=START_TIME, duration=timedelta(minutes=15)),
+    type=OrderType.LIMIT,
     side=MarketSide.BUY,
     price=Price(amount=Decimal("100.00"), currency=Currency.EUR),
     quantity=Power(mw=Decimal("5.00")),
@@ -196,6 +197,7 @@
         start=START_TIME_PB,
         duration=delivery_duration_pb2.DeliveryDuration.DELIVERY_DURATION_15,
     ),
+    type=electricity_trading_pb2.OrderType.ORDER_TYPE_LIMIT,
     side=electricity_trading_pb2.MarketSide.MARKET_SIDE_BUY,
     price=price_pb2.Price(
         amount=decimal_pb2.Decimal(value="100.00"),