Use IDs from frequenz-client-common

RELEASE_NOTES.md

@@ -2,16 +2,13 @@
 
 ## Summary
 
-<!-- Here goes a general summary of what this release is about -->
+This is a small release to allow for easier interoperability between different APIs.
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+- Some minimum dependency versions are bumped, so you might need to update your dependencies as well.
+- The IDs (`MicrogridId`, `ComponentId`, `SensorId`) are now imported from `frequenz-client-common`. Please add it to your dependencies if you haven't already, then you can replace your imports:
 
-## New Features
-
-<!-- Here goes the main new features and examples or instructions on how to use them -->
-
-## Bug Fixes
-
-<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
+    * `from frequenz.client.microgrid import MicrogridId` -> `from frequenz.client.common.microgrid import MicrogridId`
+    * `from frequenz.client.microgrid import ComponentId` -> `from frequenz.client.common.microgrid.components import ComponentId`
+    * `from frequenz.client.microgrid import SensorId` -> `from frequenz.client.common.microgrid.sensors import SensorId`

pyproject.toml

@@ -36,13 +36,14 @@ classifiers = [
 ]
 requires-python = ">= 3.11, < 4"
 dependencies = [
-  "frequenz-api-microgrid >= 0.15.3, < 0.16.0",
+  "frequenz-api-microgrid >= 0.15.5, < 0.16.0",
   "frequenz-channels >= 1.0.0-rc1, < 2.0.0",
   "frequenz-client-base >= 0.8.0, < 0.12.0",
-  "grpcio >= 1.59.0, < 2",
-  "protobuf >= 4.21.6, < 7",
+  "frequenz-client-common >= 0.3.2, < 0.4.0",
+  "grpcio >= 1.63.0, < 2",
+  "protobuf >= 5.26.1, < 7",
   "timezonefinder >= 6.2.0, < 7",
-  "typing-extensions >= 4.6.0, < 5",
+  "typing-extensions >= 4.13.0, < 5",
 ]
 dynamic = ["version"]
 
@@ -161,7 +162,15 @@ disable = [
 ]
 
 [tool.pytest.ini_options]
-addopts = "-W=all -Werror -Wdefault::DeprecationWarning -Wdefault::PendingDeprecationWarning -vv"
+addopts = "-vv"
+filterwarnings = [
+  "error",
+  "once::DeprecationWarning",
+  "once::PendingDeprecationWarning",
+  # 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',
+]
 testpaths = ["tests", "src"]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"

src/frequenz/client/microgrid/_client.py

@@ -17,6 +17,9 @@
 from frequenz.api.microgrid import microgrid_pb2, microgrid_pb2_grpc, sensor_pb2
 from frequenz.channels import Receiver
 from frequenz.client.base import channel, client, retry, streaming
+from frequenz.client.common.microgrid import MicrogridId
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.common.microgrid.sensors import SensorId
 from google.protobuf.empty_pb2 import Empty
 from typing_extensions import override
 
@@ -39,7 +42,6 @@
 from ._exception import ApiClientError, ClientNotConnected
 from ._metadata import Location, Metadata
 from ._sensor_proto import sensor_data_samples_from_proto, sensor_from_proto
-from .id import ComponentId, MicrogridId, SensorId
 from .sensor import Sensor, SensorDataSamples, SensorMetric
 
 DEFAULT_GRPC_CALL_TIMEOUT = 60.0

src/frequenz/client/microgrid/_component.py

@@ -8,8 +8,7 @@
 
 from frequenz.api.common import components_pb2
 from frequenz.api.microgrid import grid_pb2, inverter_pb2
-
-from .id import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 
 
 class ComponentType(Enum):

src/frequenz/client/microgrid/_component_data.py

@@ -9,6 +9,7 @@
 from typing import Self
 
 from frequenz.api.microgrid import microgrid_pb2
+from frequenz.client.common.microgrid.components import ComponentId
 
 from ._component_error import BatteryError, InverterError
 from ._component_states import (
@@ -18,7 +19,6 @@
     EVChargerComponentState,
     InverterComponentState,
 )
-from .id import ComponentId
 
 
 @dataclass(frozen=True)

src/frequenz/client/microgrid/_connection.py

@@ -6,7 +6,7 @@
 
 from dataclasses import dataclass
 
-from .id import ComponentId
+from frequenz.client.common.microgrid.components import ComponentId
 
 
 @dataclass(frozen=True)

src/frequenz/client/microgrid/_metadata.py

@@ -6,10 +6,9 @@
 from dataclasses import dataclass
 from zoneinfo import ZoneInfo
 
+from frequenz.client.common.microgrid import MicrogridId
 from timezonefinder import TimezoneFinder
 
-from .id import MicrogridId
-
 _timezone_finder = TimezoneFinder()
 
 

src/frequenz/client/microgrid/_sensor_proto.py

@@ -10,10 +10,10 @@
 from frequenz.api.common import components_pb2
 from frequenz.api.microgrid import common_pb2, microgrid_pb2, sensor_pb2
 from frequenz.client.base import conversion
+from frequenz.client.common.microgrid.sensors import SensorId
 
 from ._lifetime import Lifetime
 from ._util import enum_from_proto
-from .id import SensorId
 from .sensor import (
     Sensor,
     SensorDataSamples,

src/frequenz/client/microgrid/sensor.py

@@ -36,9 +36,9 @@
 from typing import assert_never
 
 from frequenz.api.microgrid import sensor_pb2
+from frequenz.client.common.microgrid.sensors import SensorId
 
 from ._lifetime import Lifetime
-from .id import SensorId
 from .metrics import AggregatedMetricValue, AggregationMethod
 
 

tests/test_client.py

@@ -17,6 +17,9 @@
 from frequenz.api.common import components_pb2, metrics_pb2
 from frequenz.api.microgrid import grid_pb2, inverter_pb2, microgrid_pb2, sensor_pb2
 from frequenz.client.base import conversion, retry
+from frequenz.client.common.microgrid import MicrogridId
+from frequenz.client.common.microgrid.components import ComponentId
+from frequenz.client.common.microgrid.sensors import SensorId
 from google.protobuf.empty_pb2 import Empty
 
 from frequenz.client.microgrid import (
@@ -34,7 +37,6 @@
     MeterData,
     MicrogridApiClient,
 )
-from frequenz.client.microgrid.id import ComponentId, MicrogridId, SensorId
 from frequenz.client.microgrid.sensor import (
     Sensor,
     SensorDataSamples,

tests/test_component.py

@@ -5,13 +5,13 @@
 
 import pytest
 from frequenz.api.common import components_pb2
+from frequenz.client.common.microgrid.components import ComponentId
 
 from frequenz.client.microgrid import (
     Component,
     ComponentCategory,
 )
 from frequenz.client.microgrid._component import component_category_from_protobuf
-from frequenz.client.microgrid.id import ComponentId
 
 
 def test_component_category_from_protobuf() -> None: