Update microgrid client

RELEASE_NOTES.md

@@ -6,7 +6,7 @@
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+* The microgrid client dependency has been updated to version 0.9.0
 
 ## New Features
 

benchmarks/power_distribution/power_distributor.py

@@ -12,7 +12,8 @@
 from typing import Any
 
 from frequenz.channels import Broadcast
-from frequenz.client.microgrid import Component, ComponentCategory, ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import Component, ComponentCategory
 from frequenz.quantities import Power
 
 from frequenz.sdk import microgrid

pyproject.toml

@@ -29,12 +29,13 @@ dependencies = [
   # Make sure to update the mkdocs.yml file when
   # changing the version
   # (plugins.mkdocstrings.handlers.python.import)
-  "frequenz-client-microgrid >= 0.7.0, < 0.8.0",
-  "frequenz-channels >= 1.6.0, < 2.0.0",
+  "frequenz-client-microgrid >= 0.9.0, < 0.10.0",
+  "frequenz-client-common >= 0.3.2, < 0.4.0",
+  "frequenz-channels >= 1.6.1, < 2.0.0",
   "frequenz-quantities[marshmallow] >= 1.0.0, < 2.0.0",
   "networkx >= 2.8, < 4",
   "numpy >= 2, < 3",
-  "typing_extensions >= 4.6.1, < 5",
+  "typing_extensions >= 4.13.0, < 5",
   "marshmallow >= 3.19.0, < 5",
   "marshmallow_dataclass >= 8.7.1, < 9",
 ]
@@ -163,21 +164,30 @@ disable = [
 max-attributes = 12
 
 [tool.pytest.ini_options]
-# We need to ignore PytestUnraisableExceptionWarning because we have some
-# cleanup issues, and sometimes exceptions are raised in __del__ methods, for
-# example when trying to do async stuff and the event loop is already closed.
-# This could even be caused by the GC, some time after the test function that
-# has the issue was completed.
-# Please see this issue for more details:
-# https://github.com/frequenz-floss/frequenz-sdk-python/issues/982
-addopts = "-W=all -Werror -Wdefault::DeprecationWarning -Wdefault::PendingDeprecationWarning -Wdefault::pytest.PytestUnraisableExceptionWarning -vv"
+addopts = "-vv"
 testpaths = ["tests", "src"]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
 required_plugins = ["pytest-asyncio", "pytest-mock"]
 markers = [
   "integration: integration tests (deselect with '-m \"not integration\"')",
 ]
+filterwarnings = [
+  "error",
+  "once::DeprecationWarning",
+  "once::PendingDeprecationWarning",
+  # We need to ignore PytestUnraisableExceptionWarning because we have some
+  # cleanup issues, and sometimes exceptions are raised in __del__ methods, for
+  # example when trying to do async stuff and the event loop is already closed.
+  # This could even be caused by the GC, some time after the test function that
+  # has the issue was completed.
+  # Please see this issue for more details:
+  # https://github.com/frequenz-floss/frequenz-sdk-python/issues/982
+  "default::pytest.PytestUnraisableExceptionWarning",
+  # We use a raw string (single quote) to avoid the need to escape special
+  # chars as this is a regex
+  'ignore:Protobuf gencode version .*exactly one major version older.*:UserWarning',
+]
 
 [tool.mypy]
 explicit_package_bases = true

src/frequenz/sdk/actor/_background_service.py

@@ -268,13 +268,6 @@ def __await__(self) -> collections.abc.Generator[None, None, None]:
         """
         return self.wait().__await__()
 
-    def __del__(self) -> None:
-        """Destroy this instance.
-
-        Cancel all running tasks spawned by this background service.
-        """
-        self.cancel("{self!r} was deleted")
-
     def __repr__(self) -> str:
         """Return a string representation of this instance.
 

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -17,7 +17,8 @@
 from datetime import timedelta
 
 from frequenz.channels import Broadcast, Sender
-from frequenz.client.microgrid import ComponentCategory, ComponentId, InverterType
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import ComponentCategory, InverterType
 
 from frequenz.sdk.microgrid._power_managing._base_classes import Algorithm, DefaultPower
 

src/frequenz/sdk/microgrid/_data_sourcing/_component_metric_request.py

@@ -6,7 +6,8 @@
 from dataclasses import dataclass
 from datetime import datetime
 
-from frequenz.client.microgrid import ComponentId, ComponentMetricId
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import ComponentMetricId
 
 __all__ = ["ComponentMetricRequest", "ComponentMetricId"]
 

src/frequenz/sdk/microgrid/_data_sourcing/microgrid_api_source.py

@@ -9,10 +9,10 @@
 from typing import Any
 
 from frequenz.channels import Receiver, Sender
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import (
     BatteryData,
     ComponentCategory,
-    ComponentId,
     ComponentMetricId,
     EVChargerData,
     InverterData,

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

@@ -11,11 +11,11 @@
 from datetime import timedelta
 
 from frequenz.channels import LatestValueCache, Receiver, Sender
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import (
     ApiClientError,
     BatteryData,
     ComponentCategory,
-    ComponentId,
     InverterData,
     OperationOutOfRange,
 )

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

@@ -7,7 +7,7 @@
 import collections.abc
 
 from frequenz.channels import Sender
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 
 from .._component_status import ComponentPoolStatus
 from ..request import Request

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

@@ -7,7 +7,7 @@
 from dataclasses import dataclass, field
 from datetime import timedelta
 
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.quantities import Current
 
 

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

@@ -16,10 +16,10 @@
     select,
     selected_from,
 )
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import (
     ApiClientError,
     ComponentCategory,
-    ComponentId,
     EVChargerData,
     MicrogridApiClient,
 )

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

@@ -8,7 +8,8 @@
 from datetime import datetime
 from typing import Iterable
 
-from frequenz.client.microgrid import ComponentId, EVChargerData
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import EVChargerData
 from frequenz.quantities import Power
 
 

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

@@ -9,10 +9,10 @@
 from datetime import timedelta
 
 from frequenz.channels import LatestValueCache, Sender
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import (
     ApiClientError,
     ComponentCategory,
-    ComponentId,
     InverterData,
     InverterType,
 )

src/frequenz/sdk/microgrid/_power_distributing/_component_pool_status_tracker.py

@@ -11,7 +11,7 @@
 from datetime import timedelta
 
 from frequenz.channels import Broadcast, Merger, Receiver, Sender, merge
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 
 from ..._internal._asyncio import cancel_and_await
 from ._component_status import (

src/frequenz/sdk/microgrid/_power_distributing/_component_status/_battery_status_tracker.py

@@ -23,13 +23,13 @@
 
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import (
     BatteryComponentState,
     BatteryData,
     BatteryRelayState,
     ComponentCategory,
     ComponentData,
-    ComponentId,
     ErrorLevel,
     InverterComponentState,
     InverterData,

src/frequenz/sdk/microgrid/_power_distributing/_component_status/_component_status.py

@@ -11,7 +11,7 @@
 from datetime import timedelta
 
 from frequenz.channels import Receiver, Sender
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 
 from ....actor._background_service import BackgroundService
 

src/frequenz/sdk/microgrid/_power_distributing/_component_status/_ev_charger_status_tracker.py

@@ -10,8 +10,8 @@
 
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import (
-    ComponentId,
     EVChargerCableState,
     EVChargerComponentState,
     EVChargerData,

src/frequenz/sdk/microgrid/_power_distributing/_component_status/_pv_inverter_status_tracker.py

@@ -9,7 +9,8 @@
 
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
-from frequenz.client.microgrid import ComponentId, InverterComponentState, InverterData
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import InverterComponentState, InverterData
 from typing_extensions import override
 
 from ...._internal._asyncio import run_forever

src/frequenz/sdk/microgrid/_power_distributing/_distribution_algorithm/_battery_distribution_algorithm.py

@@ -8,7 +8,8 @@
 from dataclasses import dataclass
 from typing import NamedTuple, Sequence
 
-from frequenz.client.microgrid import BatteryData, ComponentId, InverterData
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import BatteryData, InverterData
 from frequenz.quantities import Power
 
 from ...._internal._math import is_close_to_zero

src/frequenz/sdk/microgrid/_power_distributing/power_distributing.py

@@ -15,12 +15,8 @@
 from datetime import timedelta
 
 from frequenz.channels import Receiver, Sender
-from frequenz.client.microgrid import (
-    ComponentCategory,
-    ComponentId,
-    ComponentType,
-    InverterType,
-)
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import ComponentCategory, ComponentType, InverterType
 from typing_extensions import override
 
 from ...actor._actor import Actor

src/frequenz/sdk/microgrid/_power_distributing/request.py

@@ -6,7 +6,7 @@
 import dataclasses
 from collections import abc
 
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.quantities import Power
 
 

src/frequenz/sdk/microgrid/_power_distributing/result.py

@@ -7,7 +7,7 @@
 import dataclasses
 from collections import abc
 
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.quantities import Power
 
 from .request import Request
@@ -119,7 +119,6 @@ class OutOfBounds(_BaseResultMixin):
     from frequenz.sdk.actor.power_distributing.request import Request
     from frequenz.sdk.actor.power_distributing.result import PowerBounds
     from frequenz.quantities import Power
-    from frequenz.client.microgrid import ComponentId
 
     def handle_power_request_result(result: Result) -> None:
         match result:

src/frequenz/sdk/microgrid/_power_managing/_base_classes.py

@@ -10,7 +10,7 @@
 import enum
 import typing
 
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.quantities import Power
 
 from ... import timeseries

src/frequenz/sdk/microgrid/_power_managing/_matryoshka.py

@@ -23,7 +23,7 @@
 import typing
 from datetime import timedelta
 
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.quantities import Power
 from typing_extensions import override
 

src/frequenz/sdk/microgrid/_power_managing/_power_managing_actor.py

@@ -13,12 +13,8 @@
 
 from frequenz.channels import Receiver, Sender, select, selected_from
 from frequenz.channels.timer import SkipMissedAndDrift, Timer
-from frequenz.client.microgrid import (
-    ComponentCategory,
-    ComponentId,
-    ComponentType,
-    InverterType,
-)
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import ComponentCategory, ComponentType, InverterType
 from typing_extensions import override
 
 from ..._internal._asyncio import run_forever

src/frequenz/sdk/microgrid/_power_managing/_shifting_matryoshka.py

@@ -9,7 +9,7 @@
 import typing
 from datetime import timedelta
 
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.quantities import Power
 from typing_extensions import override
 

src/frequenz/sdk/microgrid/component_graph.py

@@ -27,10 +27,10 @@
 from collections.abc import Callable, Iterable
 
 import networkx as nx
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import (
     Component,
     ComponentCategory,
-    ComponentId,
     Connection,
     InverterType,
     MicrogridApiClient,

src/frequenz/sdk/microgrid/connection_manager.py

@@ -11,12 +11,8 @@
 import logging
 from abc import ABC, abstractmethod
 
-from frequenz.client.microgrid import (
-    Location,
-    Metadata,
-    MicrogridApiClient,
-    MicrogridId,
-)
+from frequenz.client.common.microgrid import MicrogridId
+from frequenz.client.microgrid import Location, Metadata, MicrogridApiClient
 
 from .component_graph import ComponentGraph, _MicrogridComponentGraph
 

src/frequenz/sdk/timeseries/_grid_frequency.py

@@ -9,12 +9,8 @@
 import logging
 
 from frequenz.channels import Receiver, Sender
-from frequenz.client.microgrid import (
-    Component,
-    ComponentCategory,
-    ComponentId,
-    ComponentMetricId,
-)
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import Component, ComponentCategory, ComponentMetricId
 from frequenz.quantities import Frequency, Quantity
 
 from .._internal._channels import ChannelRegistry

src/frequenz/sdk/timeseries/battery_pool/_battery_pool.py

@@ -12,7 +12,7 @@
 import uuid
 from collections import abc
 
-from frequenz.client.microgrid import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.quantities import Energy, Percentage, Power, Temperature
 
 from ... import timeseries

src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py

@@ -11,7 +11,8 @@
 from typing import Any
 
 from frequenz.channels import Receiver, Sender
-from frequenz.client.microgrid import ComponentCategory, ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.microgrid import ComponentCategory
 
 from ..._internal._asyncio import cancel_and_await
 from ..._internal._channels import ChannelRegistry, ReceiverFetcher