Move SetPowerResult class to _component_status.py

So that it can be reused by other component status tracker
specializations.  Also make it `frozen` and `kw_only`, and update
some docs and field names in the class.

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

src/frequenz/sdk/actor/power_distributing/_battery_status_tracker.py

@@ -6,7 +6,6 @@
 import asyncio
 import logging
 import math
-from collections.abc import Iterable
 from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
 
@@ -28,22 +27,11 @@
     ComponentData,
     InverterData,
 )
-from ._component_status import ComponentStatus, ComponentStatusEnum
+from ._component_status import ComponentStatus, ComponentStatusEnum, SetPowerResult
 
 _logger = logging.getLogger(__name__)
 
 
-@dataclass
-class SetPowerResult:
-    """Information what batteries succeed or failed the last request."""
-
-    succeed: Iterable[int]
-    """Set of the batteries that succeed."""
-
-    failed: Iterable[int]
-    """Set of the batteries that failed."""
-
-
 @dataclass
 class _ComponentStreamStatus:
     component_id: int
@@ -255,7 +243,7 @@ def _handle_status_inverter(self, inv_data: InverterData) -> None:
         self._inverter.data_recv_timer.reset()
 
     def _handle_status_set_power_result(self, result: SetPowerResult) -> None:
-        if self.battery_id in result.succeed:
+        if self.battery_id in result.succeeded:
             self._blocking_status.unblock()
 
         elif (

src/frequenz/sdk/actor/power_distributing/_component_pool_status_tracker.py

@@ -12,8 +12,13 @@
 from frequenz.channels.util import Merge
 
 from ..._internal._asyncio import cancel_and_await
-from ._battery_status_tracker import BatteryStatusTracker, SetPowerResult
-from ._component_status import ComponentPoolStatus, ComponentStatus, ComponentStatusEnum
+from ._battery_status_tracker import BatteryStatusTracker
+from ._component_status import (
+    ComponentPoolStatus,
+    ComponentStatus,
+    ComponentStatusEnum,
+    SetPowerResult,
+)
 
 _logger = logging.getLogger(__name__)
 
@@ -143,7 +148,7 @@ async def update_status(
             failed_components: Components that failed request
         """
         await self._set_power_result_sender.send(
-            SetPowerResult(succeed_components, failed_components)
+            SetPowerResult(succeeded=succeed_components, failed=failed_components)
         )
 
     def get_working_components(self, components: abc.Set[int]) -> abc.Set[int]:

src/frequenz/sdk/actor/power_distributing/_component_status.py

@@ -5,6 +5,7 @@
 
 
 import enum
+import typing
 from collections import abc
 from dataclasses import dataclass
 
@@ -60,3 +61,14 @@ class ComponentStatus:
 
     value: ComponentStatusEnum
     """Component status."""
+
+
+@dataclass(frozen=True, kw_only=True)
+class SetPowerResult:
+    """Lists of components for which the last set power command succeeded or failed."""
+
+    succeeded: typing.Iterable[int]
+    """Component IDs for which the last set power command succeeded."""
+
+    failed: typing.Iterable[int]
+    """Component IDs for which the last set power command failed."""

tests/actor/test_battery_status.py

@@ -30,11 +30,11 @@
 
 from frequenz.sdk.actor.power_distributing._battery_status_tracker import (
     BatteryStatusTracker,
-    SetPowerResult,
 )
 from frequenz.sdk.actor.power_distributing._component_status import (
     ComponentStatus,
     ComponentStatusEnum,
+    SetPowerResult,
 )
 from frequenz.sdk.microgrid.component import BatteryData, InverterData
 from tests.timeseries.mock_microgrid import MockMicrogrid
@@ -356,7 +356,7 @@ async def test_sync_blocking_feature(self, mocker: MockerFixture) -> None:
 
             # message is not correct, component should not block.
             tracker._handle_status_set_power_result(
-                SetPowerResult(succeed={1}, failed={BATTERY_ID})
+                SetPowerResult(succeeded={1}, failed={BATTERY_ID})
             )
 
             assert tracker._get_new_status_if_changed() is None
@@ -370,7 +370,7 @@ async def test_sync_blocking_feature(self, mocker: MockerFixture) -> None:
             for timeout in expected_blocking_timeout:
                 # message is not correct, component should not block.
                 tracker._handle_status_set_power_result(
-                    SetPowerResult(succeed={1}, failed={BATTERY_ID})
+                    SetPowerResult(succeeded={1}, failed={BATTERY_ID})
                 )
 
                 assert (
@@ -381,7 +381,7 @@ async def test_sync_blocking_feature(self, mocker: MockerFixture) -> None:
                 # Battery should be still blocked, nothing should happen
                 time.shift(timeout - 1)
                 tracker._handle_status_set_power_result(
-                    SetPowerResult(succeed={1}, failed={BATTERY_ID})
+                    SetPowerResult(succeeded={1}, failed={BATTERY_ID})
                 )
 
                 assert tracker._get_new_status_if_changed() is None
@@ -399,7 +399,7 @@ async def test_sync_blocking_feature(self, mocker: MockerFixture) -> None:
 
             # should block for 30 sec
             tracker._handle_status_set_power_result(
-                SetPowerResult(succeed={1}, failed={BATTERY_ID})
+                SetPowerResult(succeeded={1}, failed={BATTERY_ID})
             )
 
             assert tracker._get_new_status_if_changed() is ComponentStatusEnum.UNCERTAIN
@@ -422,14 +422,14 @@ async def test_sync_blocking_feature(self, mocker: MockerFixture) -> None:
 
             # should block for 30 sec
             tracker._handle_status_set_power_result(
-                SetPowerResult(succeed={1}, failed={BATTERY_ID})
+                SetPowerResult(succeeded={1}, failed={BATTERY_ID})
             )
             assert tracker._get_new_status_if_changed() is ComponentStatusEnum.UNCERTAIN
             time.shift(28)
 
             # If battery succeed, then it should unblock.
             tracker._handle_status_set_power_result(
-                SetPowerResult(succeed={BATTERY_ID}, failed={19})
+                SetPowerResult(succeeded={BATTERY_ID}, failed={19})
             )
             assert tracker._get_new_status_if_changed() is ComponentStatusEnum.WORKING
 
@@ -470,15 +470,15 @@ async def test_sync_blocking_interrupted_with_with_max_data(
             assert tracker._get_new_status_if_changed() is ComponentStatusEnum.WORKING
 
             tracker._handle_status_set_power_result(
-                SetPowerResult(succeed={1}, failed={BATTERY_ID})
+                SetPowerResult(succeeded={1}, failed={BATTERY_ID})
             )
             assert tracker._get_new_status_if_changed() is ComponentStatusEnum.UNCERTAIN
 
             expected_blocking_timeout = [1, 2, 4]
             for timeout in expected_blocking_timeout:
                 # message is not correct, component should not block.
                 tracker._handle_status_set_power_result(
-                    SetPowerResult(succeed={1}, failed={BATTERY_ID})
+                    SetPowerResult(succeeded={1}, failed={BATTERY_ID})
                 )
                 assert tracker._get_new_status_if_changed() is None
                 time.shift(timeout)
@@ -520,7 +520,7 @@ async def test_sync_blocking_interrupted_with_invalid_message(
         assert tracker._get_new_status_if_changed() is ComponentStatusEnum.WORKING
 
         tracker._handle_status_set_power_result(
-            SetPowerResult(succeed={1}, failed={BATTERY_ID})
+            SetPowerResult(succeeded={1}, failed={BATTERY_ID})
         )
         assert tracker._get_new_status_if_changed() is ComponentStatusEnum.UNCERTAIN
 
@@ -533,12 +533,12 @@ async def test_sync_blocking_interrupted_with_invalid_message(
         assert tracker._get_new_status_if_changed() is ComponentStatusEnum.NOT_WORKING
 
         tracker._handle_status_set_power_result(
-            SetPowerResult(succeed={1}, failed={BATTERY_ID})
+            SetPowerResult(succeeded={1}, failed={BATTERY_ID})
         )
         assert tracker._get_new_status_if_changed() is None
 
         tracker._handle_status_set_power_result(
-            SetPowerResult(succeed={BATTERY_ID}, failed={})
+            SetPowerResult(succeeded={BATTERY_ID}, failed={})
         )
         assert tracker._get_new_status_if_changed() is None
 
@@ -648,7 +648,7 @@ async def test_async_battery_status(self, mocker: MockerFixture) -> None:
             assert status.value is ComponentStatusEnum.WORKING
 
             await set_power_result_sender.send(
-                SetPowerResult(succeed={}, failed={BATTERY_ID})
+                SetPowerResult(succeeded={}, failed={BATTERY_ID})
             )
             status = await asyncio.wait_for(status_receiver.receive(), timeout=0.1)
             assert status.value is ComponentStatusEnum.UNCERTAIN
@@ -669,7 +669,7 @@ async def test_async_battery_status(self, mocker: MockerFixture) -> None:
             assert status.value is ComponentStatusEnum.NOT_WORKING
 
             await set_power_result_sender.send(
-                SetPowerResult(succeed={}, failed={BATTERY_ID})
+                SetPowerResult(succeeded={}, failed={BATTERY_ID})
             )
             await asyncio.sleep(0.3)
             assert len(status_receiver) == 0