Bump the frequenz-client-microgrid dependency to 0.5.0 (#1057)

Author: llucax

RELEASE_NOTES.md

@@ -2,11 +2,11 @@
 
 ## Summary
 
-<!-- Here goes a general summary of what this release is about -->
+This release mainly introduces a new feature that allows fallback components to be used in generated formulas, but it also fixes a few bugs and gets rid of `betterproto`/`grpclib` and goes back to Google's implementation.
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+- The `frequenz-client-microgrid` dependency was bumped to `0.5.0`. This can cause dependency issues if you are using other API clients and the `frequenz-client-base` dependencies don't match.
 
 ## New Features
 
@@ -19,8 +19,6 @@
 
 ## Bug Fixes
 
-- Bump the `grpclib` dependency to pull a fix for using IPv6 addresses.
-
 - Allow setting `api_power_request_timeout` in `microgrid.initialize()`.
 
 - Fix an issue where in grid meters could be identified as {pv/ev/battery/chp} meters in some component graph configurations.

mkdocs.yml

@@ -115,8 +115,8 @@ 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-channels-python/v0.16/objects.inv
-            - https://frequenz-floss.github.io/frequenz-client-microgrid-python/v0.4/objects.inv
+            - https://frequenz-floss.github.io/frequenz-channels-python/v1.1/objects.inv
+            - https://frequenz-floss.github.io/frequenz-client-microgrid-python/v0.5/objects.inv
             - https://networkx.org/documentation/stable/objects.inv
             - https://numpy.org/doc/stable/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv

pyproject.toml

@@ -29,12 +29,11 @@ dependencies = [
   # 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-client-microgrid >= 0.5.0, < 0.6.0",
   "frequenz-channels >= 1.1.0, < 2.0.0",
   "networkx >= 2.8, < 4",
   "numpy >= 1.26.4, < 2",
   "typing_extensions >= 4.6.1, < 5",
-  "grpclib >= 0.4.8rc2",
 ]
 dynamic = ["version"]
 

src/frequenz/sdk/actor/__init__.py

@@ -454,7 +454,7 @@ async def main() -> None:  # (2)!
 
 This example shows how to create an actor that receives messages from multiple
 [broadcast][frequenz.channels.Broadcast] channels using
-[`select()`][frequenz.channels.util.select].
+[`select()`][frequenz.channels.select].
 
 ```python title="select.py"
 import asyncio
@@ -530,7 +530,7 @@ async def main() -> None:  # (6)!
     them to another channel.
 
 2. We implement the [`_run()`][_run] method that will receive messages from the two
-    channels using [`select()`][frequenz.channels.util.select] and send them to the
+    channels using [`select()`][frequenz.channels.select] and send them to the
     output channel. The `run()` method will stop if a `False` message is received.
 
 3. We create the channels that will be used with the actor.
@@ -551,20 +551,20 @@ async def main() -> None:  # (6)!
 9. We start the actor and wait for it to finish using the
     [`run()`][frequenz.sdk.actor.run] function.
 
-10. The [`select()`][frequenz.channels.util.select] function will get the first message
+10. The [`select()`][frequenz.channels.select] function will get the first message
     available from the two channels. The order in which they will be handled is
     unknown, but in this example we assume that the first message will be from
     `input_channel_1` (`True`) and the second from `input_channel_1` (`False`).
 
-11. The [`selected_from()`][frequenz.channels.util.selected_from] function will return
+11. The [`selected_from()`][frequenz.channels.selected_from] function will return
     `True` for the `input_channel_1` receiver. `selected.value` holds the received
     message, so `"Received from receiver_1: True"` will be printed and `True` will be
     sent to the `output` channel.
 
 12. Since `selected.value` is `True`, the loop will continue, going back to the
-    [`select()`][frequenz.channels.util.select] function.
+    [`select()`][frequenz.channels.select] function.
 
-13. The [`selected_from()`][frequenz.channels.util.selected_from] function will return
+13. The [`selected_from()`][frequenz.channels.selected_from] function will return
     `False` for the `input_channel_1` receiver and `True` for the `input_channel_2`
     receiver. The message stored in `selected.value` will now be `False`, so
     `"Received from receiver_2: False"` will be printed and `False` will be sent to the

src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_battery_manager.py

@@ -12,8 +12,8 @@
 
 from frequenz.channels import LatestValueCache, Receiver, Sender
 from frequenz.client.microgrid import (
+    ApiClientError,
     BatteryData,
-    ClientError,
     ComponentCategory,
     InverterData,
     OperationOutOfRange,
@@ -670,7 +670,7 @@ def _parse_result(
                     battery_ids,
                     err,
                 )
-            except ClientError as err:
+            except ApiClientError as err:
                 _logger.warning(
                     "Set power for battery %s failed, mark it as broken. Error: %s",
                     battery_ids,

src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_ev_charger_manager/_ev_charger_manager.py

@@ -18,7 +18,7 @@
 )
 from frequenz.client.microgrid import (
     ApiClient,
-    ClientError,
+    ApiClientError,
     ComponentCategory,
     EVChargerData,
 )
@@ -339,7 +339,7 @@ async def _set_api_power(
                 _logger.warning(
                     "Timeout while setting power to EV charger %s", component_id
                 )
-            except ClientError as exc:
+            except ApiClientError as exc:
                 _logger.warning(
                     "Got a client error while setting power to EV charger %s: %s",
                     component_id,

src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_pv_inverter_manager/_pv_inverter_manager.py

@@ -10,7 +10,7 @@
 
 from frequenz.channels import Broadcast, LatestValueCache, Sender
 from frequenz.client.microgrid import (
-    ClientError,
+    ApiClientError,
     ComponentCategory,
     InverterData,
     InverterType,
@@ -211,7 +211,7 @@ async def _set_api_power(  # pylint: disable=too-many-locals
                 _logger.warning(
                     "Timeout while setting power to PV inverter %s", component_id
                 )
-            except ClientError as exc:
+            except ApiClientError as exc:
                 _logger.warning(
                     "Got a client error while setting power to PV inverter %s: %s",
                     component_id,

tests/microgrid/test_microgrid_api.py

@@ -104,7 +104,7 @@ def metadata(self) -> Metadata:
             ),
         )
 
-    @mock.patch("grpclib.client.Channel")
+    @mock.patch("grpc.aio.insecure_channel")
     async def test_connection_manager(
         self,
         _insecure_channel_mock: MagicMock,
@@ -185,7 +185,7 @@ async def test_connection_manager(
             assert api.microgrid_id == metadata.microgrid_id
             assert api.location == metadata.location
 
-    @mock.patch("grpclib.client.Channel")
+    @mock.patch("grpc.aio.insecure_channel")
     async def test_connection_manager_another_method(
         self,
         _insecure_channel_mock: MagicMock,