Migrate metric identifiers from ComponentMetricId to Metric

This change updates the SDK to use the new `Metric` enum from
`frequenz.client.microgrid.metrics` (and the new `TransitionalMetric`)
in place of the old `ComponentMetricId`.

It adapts internal types and mappings to accept `Metric
| TransitionalMetric` where appropriate.

Imports, request/channel naming, and data-extraction maps across the
microgrid data sourcing and timeseries modules (battery pool, voltage/
frequency streamers, formula engine, etc.) have been updated to the new
metric names (for example `ACTIVE_POWER` → `AC_ACTIVE_POWER`, etc.), and
a `TransitionalMetric` shim is used to preserve compatibility for
metrics that are still referenced by older code paths.

Tests and benchmarks were updated accordingly.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

benchmarks/timeseries/benchmark_datasourcing.py

@@ -17,7 +17,7 @@
 from typing import Any
 
 from frequenz.channels import Broadcast, Receiver, ReceiverStoppedError
-from frequenz.client.microgrid import ComponentMetricId
+from frequenz.client.microgrid.metrics import Metric
 
 from frequenz.sdk import microgrid
 from frequenz.sdk._internal._channels import ChannelRegistry
@@ -37,9 +37,9 @@
     sys.exit(1)
 
 COMPONENT_METRIC_IDS = [
-    ComponentMetricId.CURRENT_PHASE_1,
-    ComponentMetricId.CURRENT_PHASE_2,
-    ComponentMetricId.CURRENT_PHASE_3,
+    Metric.AC_CURRENT_PHASE_1,
+    Metric.AC_CURRENT_PHASE_2,
+    Metric.AC_CURRENT_PHASE_3,
 ]
 
 

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

@@ -3,11 +3,13 @@
 
 """The DataSourcingActor."""
 
-from ._component_metric_request import ComponentMetricId, ComponentMetricRequest
+from frequenz.client.microgrid.metrics import Metric
+
+from ._component_metric_request import ComponentMetricRequest
 from .data_sourcing import DataSourcingActor
 
 __all__ = [
-    "ComponentMetricId",
+    "Metric",
     "ComponentMetricRequest",
     "DataSourcingActor",
 ]

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

@@ -7,9 +7,11 @@
 from datetime import datetime
 
 from frequenz.client.common.microgrid.components import ComponentId
-from frequenz.client.microgrid import ComponentMetricId
+from frequenz.client.microgrid.metrics import Metric
 
-__all__ = ["ComponentMetricRequest", "ComponentMetricId"]
+from frequenz.sdk.microgrid._old_component_data import TransitionalMetric
+
+__all__ = ["ComponentMetricRequest", "Metric"]
 
 
 @dataclass
@@ -25,7 +27,7 @@ class ComponentMetricRequest:
     metric. For example, requesters can use different `namespace` values to subscribe to
     raw or resampled data streams separately. This ensures that each requester receives
     the appropriate type of data without interference. Requests with the same
-    `namespace`, `component_id`, and `metric_id` will use the same channel, preventing
+    `namespace`, `component_id`, and `metric` will use the same channel, preventing
     unnecessary duplication of data streams.
 
     The requester and provider must use the same channel name so that they can
@@ -40,7 +42,7 @@ class ComponentMetricRequest:
     component_id: ComponentId
     """The ID of the requested component."""
 
-    metric_id: ComponentMetricId
+    metric: Metric | TransitionalMetric
     """The ID of the requested component's metric."""
 
     start_time: datetime | None
@@ -60,7 +62,7 @@ def get_channel_name(self) -> str:
             "component_metric_request<"
             f"namespace={self.namespace},"
             f"component_id={self.component_id},"
-            f"metric_id={self.metric_id.name}"
+            f"metric={self.metric.name}"
             f"{start}"
             ">"
         )

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

@@ -13,123 +13,114 @@
 from frequenz.client.microgrid import (
     BatteryData,
     ComponentCategory,
-    ComponentMetricId,
     EVChargerData,
     InverterData,
     MeterData,
 )
+from frequenz.client.microgrid.metrics import Metric
 from frequenz.quantities import Quantity
 
 from ..._internal._asyncio import run_forever
 from ..._internal._channels import ChannelRegistry
 from ...microgrid import connection_manager
 from ...timeseries import Sample
+from .._old_component_data import (
+    TransitionalMetric,
+)
 from ._component_metric_request import ComponentMetricRequest
 
 _logger = logging.getLogger(__name__)
 
-_MeterDataMethods: dict[ComponentMetricId, Callable[[MeterData], float]] = {
-    ComponentMetricId.ACTIVE_POWER: lambda msg: msg.active_power,
-    ComponentMetricId.ACTIVE_POWER_PHASE_1: lambda msg: msg.active_power_per_phase[0],
-    ComponentMetricId.ACTIVE_POWER_PHASE_2: lambda msg: msg.active_power_per_phase[1],
-    ComponentMetricId.ACTIVE_POWER_PHASE_3: lambda msg: msg.active_power_per_phase[2],
-    ComponentMetricId.CURRENT_PHASE_1: lambda msg: msg.current_per_phase[0],
-    ComponentMetricId.CURRENT_PHASE_2: lambda msg: msg.current_per_phase[1],
-    ComponentMetricId.CURRENT_PHASE_3: lambda msg: msg.current_per_phase[2],
-    ComponentMetricId.VOLTAGE_PHASE_1: lambda msg: msg.voltage_per_phase[0],
-    ComponentMetricId.VOLTAGE_PHASE_2: lambda msg: msg.voltage_per_phase[1],
-    ComponentMetricId.VOLTAGE_PHASE_3: lambda msg: msg.voltage_per_phase[2],
-    ComponentMetricId.FREQUENCY: lambda msg: msg.frequency,
-    ComponentMetricId.REACTIVE_POWER: lambda msg: msg.reactive_power,
-    ComponentMetricId.REACTIVE_POWER_PHASE_1: lambda msg: msg.reactive_power_per_phase[
-        0
-    ],
-    ComponentMetricId.REACTIVE_POWER_PHASE_2: lambda msg: msg.reactive_power_per_phase[
-        1
-    ],
-    ComponentMetricId.REACTIVE_POWER_PHASE_3: lambda msg: msg.reactive_power_per_phase[
-        2
-    ],
+_MeterDataMethods: dict[Metric | TransitionalMetric, Callable[[MeterData], float]] = {
+    Metric.AC_ACTIVE_POWER: lambda msg: msg.active_power,
+    Metric.AC_ACTIVE_POWER_PHASE_1: lambda msg: msg.active_power_per_phase[0],
+    Metric.AC_ACTIVE_POWER_PHASE_2: lambda msg: msg.active_power_per_phase[1],
+    Metric.AC_ACTIVE_POWER_PHASE_3: lambda msg: msg.active_power_per_phase[2],
+    Metric.AC_CURRENT_PHASE_1: lambda msg: msg.current_per_phase[0],
+    Metric.AC_CURRENT_PHASE_2: lambda msg: msg.current_per_phase[1],
+    Metric.AC_CURRENT_PHASE_3: lambda msg: msg.current_per_phase[2],
+    Metric.AC_VOLTAGE_PHASE_1_N: lambda msg: msg.voltage_per_phase[0],
+    Metric.AC_VOLTAGE_PHASE_2_N: lambda msg: msg.voltage_per_phase[1],
+    Metric.AC_VOLTAGE_PHASE_3_N: lambda msg: msg.voltage_per_phase[2],
+    Metric.AC_FREQUENCY: lambda msg: msg.frequency,
+    Metric.AC_REACTIVE_POWER: lambda msg: msg.reactive_power,
+    Metric.AC_REACTIVE_POWER_PHASE_1: lambda msg: msg.reactive_power_per_phase[0],
+    Metric.AC_REACTIVE_POWER_PHASE_2: lambda msg: msg.reactive_power_per_phase[1],
+    Metric.AC_REACTIVE_POWER_PHASE_3: lambda msg: msg.reactive_power_per_phase[2],
 }
 
-_BatteryDataMethods: dict[ComponentMetricId, Callable[[BatteryData], float]] = {
-    ComponentMetricId.SOC: lambda msg: msg.soc,
-    ComponentMetricId.SOC_LOWER_BOUND: lambda msg: msg.soc_lower_bound,
-    ComponentMetricId.SOC_UPPER_BOUND: lambda msg: msg.soc_upper_bound,
-    ComponentMetricId.CAPACITY: lambda msg: msg.capacity,
-    ComponentMetricId.POWER_INCLUSION_LOWER_BOUND: lambda msg: (
+_BatteryDataMethods: dict[
+    Metric | TransitionalMetric, Callable[[BatteryData], float]
+] = {
+    Metric.BATTERY_SOC_PCT: lambda msg: msg.soc,
+    TransitionalMetric.SOC_LOWER_BOUND: lambda msg: msg.soc_lower_bound,
+    TransitionalMetric.SOC_UPPER_BOUND: lambda msg: msg.soc_upper_bound,
+    Metric.BATTERY_CAPACITY: lambda msg: msg.capacity,
+    TransitionalMetric.POWER_INCLUSION_LOWER_BOUND: lambda msg: (
         msg.power_inclusion_lower_bound
     ),
-    ComponentMetricId.POWER_EXCLUSION_LOWER_BOUND: lambda msg: (
+    TransitionalMetric.POWER_EXCLUSION_LOWER_BOUND: lambda msg: (
         msg.power_exclusion_lower_bound
     ),
-    ComponentMetricId.POWER_EXCLUSION_UPPER_BOUND: lambda msg: (
+    TransitionalMetric.POWER_EXCLUSION_UPPER_BOUND: lambda msg: (
         msg.power_exclusion_upper_bound
     ),
-    ComponentMetricId.POWER_INCLUSION_UPPER_BOUND: lambda msg: (
+    TransitionalMetric.POWER_INCLUSION_UPPER_BOUND: lambda msg: (
         msg.power_inclusion_upper_bound
     ),
-    ComponentMetricId.TEMPERATURE: lambda msg: msg.temperature,
+    Metric.BATTERY_TEMPERATURE: lambda msg: msg.temperature,
 }
 
-_InverterDataMethods: dict[ComponentMetricId, Callable[[InverterData], float]] = {
-    ComponentMetricId.ACTIVE_POWER: lambda msg: msg.active_power,
-    ComponentMetricId.ACTIVE_POWER_PHASE_1: lambda msg: msg.active_power_per_phase[0],
-    ComponentMetricId.ACTIVE_POWER_PHASE_2: lambda msg: msg.active_power_per_phase[1],
-    ComponentMetricId.ACTIVE_POWER_PHASE_3: lambda msg: msg.active_power_per_phase[2],
-    ComponentMetricId.ACTIVE_POWER_INCLUSION_LOWER_BOUND: lambda msg: (
+_InverterDataMethods: dict[
+    Metric | TransitionalMetric, Callable[[InverterData], float]
+] = {
+    Metric.AC_ACTIVE_POWER: lambda msg: msg.active_power,
+    Metric.AC_ACTIVE_POWER_PHASE_1: lambda msg: msg.active_power_per_phase[0],
+    Metric.AC_ACTIVE_POWER_PHASE_2: lambda msg: msg.active_power_per_phase[1],
+    Metric.AC_ACTIVE_POWER_PHASE_3: lambda msg: msg.active_power_per_phase[2],
+    TransitionalMetric.ACTIVE_POWER_INCLUSION_LOWER_BOUND: lambda msg: (
         msg.active_power_inclusion_lower_bound
     ),
-    ComponentMetricId.ACTIVE_POWER_EXCLUSION_LOWER_BOUND: lambda msg: (
+    TransitionalMetric.ACTIVE_POWER_EXCLUSION_LOWER_BOUND: lambda msg: (
         msg.active_power_exclusion_lower_bound
     ),
-    ComponentMetricId.ACTIVE_POWER_EXCLUSION_UPPER_BOUND: lambda msg: (
+    TransitionalMetric.ACTIVE_POWER_EXCLUSION_UPPER_BOUND: lambda msg: (
         msg.active_power_exclusion_upper_bound
     ),
-    ComponentMetricId.ACTIVE_POWER_INCLUSION_UPPER_BOUND: lambda msg: (
+    TransitionalMetric.ACTIVE_POWER_INCLUSION_UPPER_BOUND: lambda msg: (
         msg.active_power_inclusion_upper_bound
     ),
-    ComponentMetricId.CURRENT_PHASE_1: lambda msg: msg.current_per_phase[0],
-    ComponentMetricId.CURRENT_PHASE_2: lambda msg: msg.current_per_phase[1],
-    ComponentMetricId.CURRENT_PHASE_3: lambda msg: msg.current_per_phase[2],
-    ComponentMetricId.VOLTAGE_PHASE_1: lambda msg: msg.voltage_per_phase[0],
-    ComponentMetricId.VOLTAGE_PHASE_2: lambda msg: msg.voltage_per_phase[1],
-    ComponentMetricId.VOLTAGE_PHASE_3: lambda msg: msg.voltage_per_phase[2],
-    ComponentMetricId.FREQUENCY: lambda msg: msg.frequency,
-    ComponentMetricId.REACTIVE_POWER: lambda msg: msg.reactive_power,
-    ComponentMetricId.REACTIVE_POWER_PHASE_1: lambda msg: msg.reactive_power_per_phase[
-        0
-    ],
-    ComponentMetricId.REACTIVE_POWER_PHASE_2: lambda msg: msg.reactive_power_per_phase[
-        1
-    ],
-    ComponentMetricId.REACTIVE_POWER_PHASE_3: lambda msg: msg.reactive_power_per_phase[
-        2
-    ],
+    Metric.AC_CURRENT_PHASE_1: lambda msg: msg.current_per_phase[0],
+    Metric.AC_CURRENT_PHASE_2: lambda msg: msg.current_per_phase[1],
+    Metric.AC_CURRENT_PHASE_3: lambda msg: msg.current_per_phase[2],
+    Metric.AC_VOLTAGE_PHASE_1_N: lambda msg: msg.voltage_per_phase[0],
+    Metric.AC_VOLTAGE_PHASE_2_N: lambda msg: msg.voltage_per_phase[1],
+    Metric.AC_VOLTAGE_PHASE_3_N: lambda msg: msg.voltage_per_phase[2],
+    Metric.AC_FREQUENCY: lambda msg: msg.frequency,
+    Metric.AC_REACTIVE_POWER: lambda msg: msg.reactive_power,
+    Metric.AC_REACTIVE_POWER_PHASE_1: lambda msg: msg.reactive_power_per_phase[0],
+    Metric.AC_REACTIVE_POWER_PHASE_2: lambda msg: msg.reactive_power_per_phase[1],
+    Metric.AC_REACTIVE_POWER_PHASE_3: lambda msg: msg.reactive_power_per_phase[2],
 }
 
-_EVChargerDataMethods: dict[ComponentMetricId, Callable[[EVChargerData], float]] = {
-    ComponentMetricId.ACTIVE_POWER: lambda msg: msg.active_power,
-    ComponentMetricId.ACTIVE_POWER_PHASE_1: lambda msg: msg.active_power_per_phase[0],
-    ComponentMetricId.ACTIVE_POWER_PHASE_2: lambda msg: msg.active_power_per_phase[1],
-    ComponentMetricId.ACTIVE_POWER_PHASE_3: lambda msg: msg.active_power_per_phase[2],
-    ComponentMetricId.CURRENT_PHASE_1: lambda msg: msg.current_per_phase[0],
-    ComponentMetricId.CURRENT_PHASE_2: lambda msg: msg.current_per_phase[1],
-    ComponentMetricId.CURRENT_PHASE_3: lambda msg: msg.current_per_phase[2],
-    ComponentMetricId.VOLTAGE_PHASE_1: lambda msg: msg.voltage_per_phase[0],
-    ComponentMetricId.VOLTAGE_PHASE_2: lambda msg: msg.voltage_per_phase[1],
-    ComponentMetricId.VOLTAGE_PHASE_3: lambda msg: msg.voltage_per_phase[2],
-    ComponentMetricId.FREQUENCY: lambda msg: msg.frequency,
-    ComponentMetricId.REACTIVE_POWER: lambda msg: msg.reactive_power,
-    ComponentMetricId.REACTIVE_POWER_PHASE_1: lambda msg: msg.reactive_power_per_phase[
-        0
-    ],
-    ComponentMetricId.REACTIVE_POWER_PHASE_2: lambda msg: msg.reactive_power_per_phase[
-        1
-    ],
-    ComponentMetricId.REACTIVE_POWER_PHASE_3: lambda msg: msg.reactive_power_per_phase[
-        2
-    ],
+_EVChargerDataMethods: dict[
+    Metric | TransitionalMetric, Callable[[EVChargerData], float]
+] = {
+    Metric.AC_ACTIVE_POWER: lambda msg: msg.active_power,
+    Metric.AC_ACTIVE_POWER_PHASE_1: lambda msg: msg.active_power_per_phase[0],
+    Metric.AC_ACTIVE_POWER_PHASE_2: lambda msg: msg.active_power_per_phase[1],
+    Metric.AC_ACTIVE_POWER_PHASE_3: lambda msg: msg.active_power_per_phase[2],
+    Metric.AC_CURRENT_PHASE_1: lambda msg: msg.current_per_phase[0],
+    Metric.AC_CURRENT_PHASE_2: lambda msg: msg.current_per_phase[1],
+    Metric.AC_CURRENT_PHASE_3: lambda msg: msg.current_per_phase[2],
+    Metric.AC_VOLTAGE_PHASE_1_N: lambda msg: msg.voltage_per_phase[0],
+    Metric.AC_VOLTAGE_PHASE_2_N: lambda msg: msg.voltage_per_phase[1],
+    Metric.AC_VOLTAGE_PHASE_3_N: lambda msg: msg.voltage_per_phase[2],
+    Metric.AC_FREQUENCY: lambda msg: msg.frequency,
+    Metric.AC_REACTIVE_POWER: lambda msg: msg.reactive_power,
+    Metric.AC_REACTIVE_POWER_PHASE_1: lambda msg: msg.reactive_power_per_phase[0],
+    Metric.AC_REACTIVE_POWER_PHASE_2: lambda msg: msg.reactive_power_per_phase[1],
+    Metric.AC_REACTIVE_POWER_PHASE_3: lambda msg: msg.reactive_power_per_phase[2],
 }
 
 
@@ -159,7 +150,7 @@ def __init__(
 
         self._registry = registry
         self._req_streaming_metrics: dict[
-            ComponentId, dict[ComponentMetricId, list[ComponentMetricRequest]]
+            ComponentId, dict[Metric | TransitionalMetric, list[ComponentMetricRequest]]
         ] = {}
 
     async def _get_component_category(
@@ -189,7 +180,7 @@ async def _get_component_category(
     async def _check_battery_request(
         self,
         comp_id: ComponentId,
-        requests: dict[ComponentMetricId, list[ComponentMetricRequest]],
+        requests: dict[Metric | TransitionalMetric, list[ComponentMetricRequest]],
     ) -> None:
         """Check if the requests are valid Battery metrics.
 
@@ -214,7 +205,7 @@ async def _check_battery_request(
     async def _check_ev_charger_request(
         self,
         comp_id: ComponentId,
-        requests: dict[ComponentMetricId, list[ComponentMetricRequest]],
+        requests: dict[Metric | TransitionalMetric, list[ComponentMetricRequest]],
     ) -> None:
         """Check if the requests are valid EV Charger metrics.
 
@@ -239,7 +230,7 @@ async def _check_ev_charger_request(
     async def _check_inverter_request(
         self,
         comp_id: ComponentId,
-        requests: dict[ComponentMetricId, list[ComponentMetricRequest]],
+        requests: dict[Metric | TransitionalMetric, list[ComponentMetricRequest]],
     ) -> None:
         """Check if the requests are valid Inverter metrics.
 
@@ -264,7 +255,7 @@ async def _check_inverter_request(
     async def _check_meter_request(
         self,
         comp_id: ComponentId,
-        requests: dict[ComponentMetricId, list[ComponentMetricRequest]],
+        requests: dict[Metric | TransitionalMetric, list[ComponentMetricRequest]],
     ) -> None:
         """Check if the requests are valid Meter metrics.
 
@@ -290,7 +281,7 @@ async def _check_requested_component_and_metrics(
         self,
         comp_id: ComponentId,
         category: ComponentCategory,
-        requests: dict[ComponentMetricId, list[ComponentMetricRequest]],
+        requests: dict[Metric | TransitionalMetric, list[ComponentMetricRequest]],
     ) -> None:
         """Check if the requested component and metrics are valid.
 
@@ -321,7 +312,7 @@ async def _check_requested_component_and_metrics(
             raise ValueError(err)
 
     def _get_data_extraction_method(
-        self, category: ComponentCategory, metric: ComponentMetricId
+        self, category: ComponentCategory, metric: Metric | TransitionalMetric
     ) -> Callable[[Any], float]:
         """Get the data extraction method for the given metric.
 
@@ -351,7 +342,7 @@ def _get_data_extraction_method(
     def _get_metric_senders(
         self,
         category: ComponentCategory,
-        requests: dict[ComponentMetricId, list[ComponentMetricRequest]],
+        requests: dict[Metric | TransitionalMetric, list[ComponentMetricRequest]],
     ) -> list[tuple[Callable[[Any], float], list[Sender[Sample[Quantity]]]]]:
         """Get channel senders from the channel registry for each requested metric.
 
@@ -484,15 +475,15 @@ async def add_metric(self, request: ComponentMetricRequest) -> None:
             return
 
         self._req_streaming_metrics.setdefault(comp_id, {}).setdefault(
-            request.metric_id, []
+            request.metric, []
         )
 
-        for existing_request in self._req_streaming_metrics[comp_id][request.metric_id]:
+        for existing_request in self._req_streaming_metrics[comp_id][request.metric]:
             if existing_request.get_channel_name() == request.get_channel_name():
                 # the requested metric is already being handled, so nothing to do.
                 return
 
-        self._req_streaming_metrics[comp_id][request.metric_id].append(request)
+        self._req_streaming_metrics[comp_id][request.metric].append(request)
 
         await self._update_streams(
             comp_id,

src/frequenz/sdk/timeseries/_grid_frequency.py

@@ -10,7 +10,8 @@
 
 from frequenz.channels import Receiver, Sender
 from frequenz.client.common.microgrid.components import ComponentId
-from frequenz.client.microgrid import Component, ComponentCategory, ComponentMetricId
+from frequenz.client.microgrid import Component, ComponentCategory
+from frequenz.client.microgrid.metrics import Metric
 from frequenz.quantities import Frequency, Quantity
 
 from .._internal._channels import ChannelRegistry
@@ -31,7 +32,7 @@ def create_request(component_id: ComponentId) -> ComponentMetricRequest:
         A component metric request for grid frequency.
     """
     return ComponentMetricRequest(
-        "grid-frequency", component_id, ComponentMetricId.FREQUENCY, None
+        "grid-frequency", component_id, Metric.AC_FREQUENCY, None
     )