Upgrade to microgrid client v0.4.0 (#955)

- **Bump frequenz-client-microgrid to v0.4.0**
- **Use `GrpcError` instead of `grpc.aio.AioRpcError`**
- **Avoid repetition on error handling**
- **Use a server URL to connect to the microgrid API**
- **Use new microgrid API wrapped types**
- **Stop using the `mock_api` for testing**
- **Remove the, now unused, `mock_api` and its tests**
- **Silence `hpack` debug logging**
- **Fix mock return value**
- **Avoid disabling some pylint checks when unnecessary**
- **Remove unsed protobuf and grpcio dependencies**

Author: llucax

RELEASE_NOTES.md

@@ -6,10 +6,21 @@
 
 ## Upgrading
 
+- The `frequenz-client-microgrid` dependency was bumped to v0.4.0. If you are using the client directly in your code, you will need to upgrade too.
+
 - Calls to `microgrid.*_pool` methods now always need to specified a priority value, corresponding to the requirements/priority of the actor making the call.
 
 - The `microgrid.*_pool` methods would only accept keyword arguments from now on.
 
+- The `microgrid.initialize()` method now takes a `server_url` instead of a `host` and `port`.
+
+   The following format is expected: `grpc://hostname{:port}{?ssl=ssl}`, where the port should be an int between `0` and `65535` (defaulting to `9090`) and `ssl` should be a boolean (defaulting to `false`). For example: `grpc://localhost` or `grpc://localhost:1090?ssl=true`.
+
+   The default was also removed, so you always need to specify the server URL.
+
+   This applies to the `ConnectionManager` as well, which also now doesn't expose the `host` and `port` attributes, only the `server_url`. If you need to extract the host or port from the `server_url`, you can use the standard Python `urllib.parse.urlparse()` function.
+
+
 ## New Features
 
 - Calls to `microgrid.*_pool` methods now accept an optional `in_shifting_group` parameter.  Power requests sent to `*_pool` instances that have the `in_shifting_group` flag set, will get resolved separately, and their target power will be added to the target power calculated from regular actors, if any, which would, in effect, shift the zero for the regular actors by the target power from the shifting group.

benchmarks/power_distribution/power_distributor.py

@@ -137,10 +137,9 @@ async def run_test(  # pylint: disable=too-many-locals
 
 async def run() -> None:
     """Create microgrid api and run tests."""
-    # pylint: disable=protected-access
-
     await microgrid.initialize(
-        HOST, PORT, ResamplerConfig(resampling_period=timedelta(seconds=1.0))
+        "grpc://microgrid.sandbox.api.frequenz.io:62060",
+        ResamplerConfig(resampling_period=timedelta(seconds=1.0)),
     )
 
     all_batteries: set[Component] = connection_manager.get().component_graph.components(

benchmarks/timeseries/benchmark_datasourcing.py

@@ -49,12 +49,12 @@ def enable_mock_client(client: MockMicrogridClient) -> None:
     Args:
         client: the mock microgrid client to enable.
     """
-    # pylint: disable=protected-access
-    microgrid.connection_manager._CONNECTION_MANAGER = client.mock_microgrid
+    microgrid.connection_manager._CONNECTION_MANAGER = (  # pylint: disable=protected-access
+        client.mock_microgrid
+    )
 
 
-# pylint: disable=too-many-locals
-async def benchmark_data_sourcing(
+async def benchmark_data_sourcing(  # pylint: disable=too-many-locals
     num_ev_chargers: int, num_msgs_per_battery: int
 ) -> None:
     """Benchmark the data sourcing actor.

docs/tutorials/getting_started.md

@@ -44,13 +44,11 @@ microgrid.
 ```python
 async def run() -> None:
     # This points to the default Frequenz microgrid sandbox
-    microgrid_host = "microgrid.sandbox.api.frequenz.io"
-    microgrid_port = 62060
+    server_url = "grpc://microgrid.sandbox.api.frequenz.io:62060",
 
     # Initialize the microgrid
     await microgrid.initialize(
-        microgrid_host,
-        microgrid_port,
+        server_url,
         ResamplerConfig(resampling_period=timedelta(seconds=1)),
     )
 
@@ -106,13 +104,11 @@ from frequenz.sdk.actor import ResamplerConfig
 
 async def run() -> None:
     # This points to the default Frequenz microgrid sandbox
-    microgrid_host = "microgrid.sandbox.api.frequenz.io"
-    microgrid_port = 62060
+    server_url = "grpc://microgrid.sandbox.api.frequenz.io:62060",
 
     # Initialize the microgrid
     await microgrid.initialize(
-        microgrid_host,
-        microgrid_port,
+        server_url,
         ResamplerConfig(resampling_period=timedelta(seconds=1)),
     )
 

examples/battery_pool.py

@@ -22,9 +22,11 @@ async def main() -> None:
     logging.basicConfig(
         level=logging.DEBUG, format="%(asctime)s %(name)s %(levelname)s:%(message)s"
     )
+    # Reduce undesired noise from hpack
+    logging.getLogger("hpack.hpack").setLevel(logging.INFO)
+
     await microgrid.initialize(
-        host=HOST,
-        port=PORT,
+        "grpc://microgrid.sandbox.api.frequenz.io:62060",
         resampler_config=ResamplerConfig(resampling_period=timedelta(seconds=1.0)),
     )
 

mkdocs.yml

@@ -114,15 +114,11 @@ plugins:
           import:
             # See https://mkdocstrings.github.io/python/usage/#import for details
             - https://docs.python.org/3/objects.inv
-            - https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
             - https://frequenz-floss.github.io/frequenz-channels-python/v0.16/objects.inv
-            - https://frequenz-floss.github.io/frequenz-api-microgrid/v0.15/objects.inv
-            - https://grpc.github.io/grpc/python/objects.inv
+            - https://frequenz-floss.github.io/frequenz-client-microgrid-python/v0.4/objects.inv
             - https://networkx.org/documentation/stable/objects.inv
             - https://numpy.org/doc/stable/objects.inv
-            - https://protobuf.readthedocs.io/en/latest/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
-            - https://watchfiles.helpmanual.io/objects.inv
   # Note this plugin must be loaded after mkdocstrings to be able to use macros
   # inside docstrings. See the comment in `docs/_scripts/macros.py` for more
   # details

pyproject.toml

@@ -26,23 +26,15 @@ classifiers = [
 ]
 requires-python = ">= 3.11, < 4"
 dependencies = [
-  "frequenz-api-microgrid >= 0.15.3, < 0.16.0",
   # Make sure to update the mkdocs.yml file when
   # changing the version
   # (plugins.mkdocstrings.handlers.python.import)
+  "frequenz-client-microgrid >= 0.4.0, < 0.5.0",
   "frequenz-channels >= 1.0.0-rc1, < 2.0.0",
-  "frequenz-client-microgrid >= 0.3.0, < 0.4.0",
-  "google-api-python-client >= 2.71, < 3",
-  "grpcio >= 1.60.1, < 2",
-  "grpcio-tools >= 1.60.1, < 2",
   "networkx >= 2.8, < 4",
   "numpy >= 1.26.4, < 2",
-  "protobuf >= 4.21.6, < 6",
   "pydantic >= 2.3, < 3",
-  "timezonefinder >= 6.2.0, < 7",
-  "tqdm >= 4.38.0, < 5",
   "typing_extensions >= 4.6.1, < 5",
-  "watchfiles >= 0.15.0",
 ]
 dynamic = ["version"]
 
@@ -73,7 +65,6 @@ dev-mkdocs = [
 ]
 dev-mypy = [
   "mypy == 1.10.0",
-  "grpc-stubs == 1.24.12",               # This dependency introduces breaking changes in patch releases
   "types-Markdown == 3.6.0.20240316",
   "types-protobuf == 5.26.0.20240422",
   "types-setuptools == 70.0.0.20240524",
@@ -188,8 +179,6 @@ strict = true
 module = [
   "async_solipsism",
   "async_solipsism.*",
-  "grpc.aio",
-  "grpc.aio.*",
   "mkdocs_macros.*",
   # The available stubs packages are outdated or incomplete (WIP/experimental):
   # https://github.com/frequenz-floss/frequenz-sdk-python/issues/430

src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py

@@ -10,9 +10,14 @@
 import typing
 from datetime import timedelta
 
-import grpc
 from frequenz.channels import Receiver, Sender
-from frequenz.client.microgrid import BatteryData, ComponentCategory, InverterData
+from frequenz.client.microgrid import (
+    BatteryData,
+    ClientError,
+    ComponentCategory,
+    InverterData,
+    OperationOutOfRange,
+)
 from typing_extensions import override
 
 from .... import microgrid
@@ -647,39 +652,38 @@ def _parse_result(
 
         for inverter_id, aws in tasks.items():
             battery_ids = self._inv_bats_map[inverter_id]
+            failed = True
             try:
                 aws.result()
-            except grpc.aio.AioRpcError as err:
-                failed_power += distribution[inverter_id]
-                failed_batteries = failed_batteries.union(battery_ids)
-                if err.code() == grpc.StatusCode.OUT_OF_RANGE:
-                    _logger.debug(
-                        "Set power for battery %s failed, error %s",
-                        battery_ids,
-                        str(err),
-                    )
-                else:
-                    _logger.warning(
-                        "Set power for battery %s failed, error %s. Mark it as broken.",
-                        battery_ids,
-                        str(err),
-                    )
+                failed = False
+            except OperationOutOfRange as err:
+                _logger.debug(
+                    "Set power for battery %s failed due to out of range error: %s",
+                    battery_ids,
+                    err,
+                )
+            except ClientError as err:
+                _logger.warning(
+                    "Set power for battery %s failed, mark it as broken. Error: %s",
+                    battery_ids,
+                    err,
+                )
             except asyncio.exceptions.CancelledError:
-                failed_power += distribution[inverter_id]
-                failed_batteries = failed_batteries.union(battery_ids)
                 _logger.warning(
                     "Battery %s didn't respond in %f sec. Mark it as broken.",
                     battery_ids,
                     request_timeout.total_seconds(),
                 )
             except Exception:  # pylint: disable=broad-except
-                failed_power += distribution[inverter_id]
-                failed_batteries = failed_batteries.union(battery_ids)
                 _logger.exception(
                     "Unknown error while setting power to batteries: %s",
                     battery_ids,
                 )
 
+            if failed:
+                failed_power += distribution[inverter_id]
+                failed_batteries.update(battery_ids)
+
         return failed_power, failed_batteries
 
     async def _cancel_tasks(

src/frequenz/sdk/actor/power_distributing/_component_managers/_ev_charger_manager/_ev_charger_manager.py

@@ -8,9 +8,13 @@
 import logging
 from datetime import datetime, timedelta, timezone
 
-import grpc
 from frequenz.channels import Broadcast, Sender, merge, select, selected_from
-from frequenz.client.microgrid import ApiClient, ComponentCategory, EVChargerData
+from frequenz.client.microgrid import (
+    ApiClient,
+    ClientError,
+    ComponentCategory,
+    EVChargerData,
+)
 from typing_extensions import override
 
 from frequenz.sdk import microgrid
@@ -335,9 +339,9 @@ async def _set_api_power(
                     _logger.warning(
                         "Timeout while setting power to EV charger %s", component_id
                     )
-                case grpc.aio.AioRpcError() as err:
+                case ClientError() as err:
                     _logger.warning(
-                        "Error while setting power to EV charger %s: %s",
+                        "Got a client error while setting power to EV charger %s: %s",
                         component_id,
                         err,
                     )

src/frequenz/sdk/actor/power_distributing/_component_managers/_pv_inverter_manager/_pv_inverter_manager.py

@@ -8,9 +8,13 @@
 import logging
 from datetime import timedelta
 
-import grpc
 from frequenz.channels import Broadcast, Sender
-from frequenz.client.microgrid import ComponentCategory, InverterData, InverterType
+from frequenz.client.microgrid import (
+    ClientError,
+    ComponentCategory,
+    InverterData,
+    InverterType,
+)
 from typing_extensions import override
 
 from ....._internal._channels import LatestValueCache
@@ -197,9 +201,9 @@ async def _set_api_power(  # pylint: disable=too-many-locals
                     _logger.warning(
                         "Timeout while setting power to PV inverter %s", component_id
                     )
-                case grpc.aio.AioRpcError() as err:
+                case ClientError() as err:
                     _logger.warning(
-                        "Error while setting power to PV inverter %s: %s",
+                        "Got a client error while setting power to PV inverter %s: %s",
                         component_id,
                         err,
                     )