Rename ComponentStatus → ComponentPoolStatus

shsms · shsms · commit 61672f505954 · 2023-11-09T16:03:34.000+01:00
It is actually a dataclass for holding the status of a pool of
components, so this name is more accurate.

Also move it to a separate `_component_status.py` sub-module.

Signed-off-by: Sahas Subramanian &lt;sahas.subramanian@proton.me&gt;
diff --git a/benchmarks/power_distribution/power_distributor.py b/benchmarks/power_distribution/power_distributor.py
@@ -16,7 +16,7 @@
 from frequenz.sdk import microgrid
 from frequenz.sdk.actor import ResamplerConfig
 from frequenz.sdk.actor.power_distributing import (
-    ComponentStatus,
+    ComponentPoolStatus,
     Error,
     OutOfBounds,
     PartialFailure,
@@ -112,7 +112,7 @@ async def run_test(  # pylint: disable=too-many-locals
     start = timeit.default_timer()
 
     power_request_channel = Broadcast[Request]("power-request")
-    battery_status_channel = Broadcast[ComponentStatus]("battery-status")
+    battery_status_channel = Broadcast[ComponentPoolStatus]("battery-status")
     power_result_channel = Broadcast[Result]("power-result")
     async with PowerDistributingActor(
         requests_receiver=power_request_channel.new_receiver(),
diff --git a/src/frequenz/sdk/actor/power_distributing/__init__.py b/src/frequenz/sdk/actor/power_distributing/__init__.py
@@ -10,7 +10,7 @@
 PowerDistributingActor and send requests for charging or discharging power.
 """
 
-from ._component_pool_status_tracker import ComponentStatus
+from ._component_status import ComponentPoolStatus
 from .power_distributing import PowerDistributingActor
 from .request import Request
 from .result import Error, OutOfBounds, PartialFailure, Result, Success
@@ -23,5 +23,5 @@
     "Success",
     "OutOfBounds",
     "PartialFailure",
-    "ComponentStatus",
+    "ComponentPoolStatus",
 ]
diff --git a/src/frequenz/sdk/actor/power_distributing/_component_pool_status_tracker.py b/src/frequenz/sdk/actor/power_distributing/_component_pool_status_tracker.py
@@ -14,35 +14,11 @@
 
 from ..._internal._asyncio import cancel_and_await
 from ._battery_status import BatteryStatusTracker, SetPowerResult, Status
+from ._component_status import ComponentPoolStatus
 
 _logger = logging.getLogger(__name__)
 
 
-@dataclass
-class ComponentStatus:
-    """Status of all components of a certain category in the microgrid."""
-
-    working: set[int]
-    """Set of working component ids."""
-
-    uncertain: set[int]
-    """Set of components to be used only when there are none known to be working."""
-
-    def get_working_components(self, components: abc.Set[int]) -> set[int]:
-        """From the given set of components return the working ones.
-
-        Args:
-            components: Set of components.
-
-        Returns:
-            Subset with working components.
-        """
-        working = self.working.intersection(components)
-        if len(working) > 0:
-            return working
-        return self.uncertain.intersection(components)
-
-
 @dataclass
 class _ComponentStatusChannelHelper:
     """Helper class to create component status channel.
@@ -73,7 +49,7 @@ class ComponentPoolStatusTracker:
     def __init__(  # noqa: DOC502 (RuntimeError raised from BatteryStatusTracker)
         self,
         component_ids: set[int],
-        component_status_sender: Sender[ComponentStatus],
+        component_status_sender: Sender[ComponentPoolStatus],
         max_data_age_sec: float,
         max_blocking_duration_sec: float,
     ) -> None:
@@ -96,7 +72,7 @@ def __init__(  # noqa: DOC502 (RuntimeError raised from BatteryStatusTracker)
         """
         # At first no component is working, we will get notification when they start
         # working.
-        self._current_status = ComponentStatus(working=set(), uncertain=set())
+        self._current_status = ComponentPoolStatus(working=set(), uncertain=set())
 
         # Channel for sending results of requests to the components.
         set_power_result_channel = Broadcast[SetPowerResult]("component_request_status")
@@ -147,7 +123,7 @@ async def stop(self) -> None:
         )
         await self._component_status_channel.stop()
 
-    async def _run(self, component_status_sender: Sender[ComponentStatus]) -> None:
+    async def _run(self, component_status_sender: Sender[ComponentPoolStatus]) -> None:
         """Start tracking component status.
 
         Args:
@@ -163,7 +139,7 @@ async def _run(self, component_status_sender: Sender[ComponentStatus]) -> None:
                 )
 
     async def _update_status(
-        self, component_status_sender: Sender[ComponentStatus]
+        self, component_status_sender: Sender[ComponentPoolStatus]
     ) -> None:
         """Wait for any component to change status and update status.
 
diff --git a/src/frequenz/sdk/actor/power_distributing/_component_status.py b/src/frequenz/sdk/actor/power_distributing/_component_status.py
@@ -0,0 +1,33 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Classes to track the status of components in the microgrid."""
+
+
+from collections import abc
+from dataclasses import dataclass
+
+
+@dataclass
+class ComponentPoolStatus:
+    """Status of all components of a certain category in the microgrid."""
+
+    working: set[int]
+    """Set of working component ids."""
+
+    uncertain: set[int]
+    """Set of components to be used only when there are none known to be working."""
+
+    def get_working_components(self, components: abc.Set[int]) -> set[int]:
+        """From the given set of components return the working ones.
+
+        Args:
+            components: Set of components.
+
+        Returns:
+            Subset with working components.
+        """
+        working = self.working.intersection(components)
+        if len(working) > 0:
+            return working
+        return self.uncertain.intersection(components)
diff --git a/src/frequenz/sdk/actor/power_distributing/power_distributing.py b/src/frequenz/sdk/actor/power_distributing/power_distributing.py
@@ -36,7 +36,8 @@
     ComponentCategory,
     InverterData,
 )
-from ._component_pool_status_tracker import ComponentPoolStatusTracker, ComponentStatus
+from ._component_pool_status_tracker import ComponentPoolStatusTracker
+from ._component_status import ComponentPoolStatus
 from ._distribution_algorithm import (
     AggregatedBatteryData,
     DistributionAlgorithm,
@@ -164,7 +165,7 @@ def __init__(
         self,
         requests_receiver: Receiver[Request],
         results_sender: Sender[Result],
-        battery_status_sender: Sender[ComponentStatus],
+        battery_status_sender: Sender[ComponentPoolStatus],
         wait_for_data_sec: float = 2,
         *,
         name: str | None = None,
diff --git a/src/frequenz/sdk/microgrid/_data_pipeline.py b/src/frequenz/sdk/microgrid/_data_pipeline.py
@@ -36,7 +36,7 @@
 if typing.TYPE_CHECKING:
     from ..actor import ComponentMetricRequest, ResamplerConfig, _power_managing
     from ..actor.power_distributing import (  # noqa: F401 (imports used by string type hints)
-        ComponentStatus,
+        ComponentPoolStatus,
         PowerDistributingActor,
         Request,
         Result,
@@ -94,7 +94,7 @@ def __init__(
         self._data_sourcing_actor: _ActorInfo | None = None
         self._resampling_actor: _ActorInfo | None = None
 
-        self._battery_status_channel: Broadcast[ComponentStatus] = Broadcast(
+        self._battery_status_channel: Broadcast[ComponentPoolStatus] = Broadcast(
             "battery-status", resend_latest=True
         )
         self._power_distribution_requests_channel: Broadcast[Request] = Broadcast(
diff --git a/src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py b/src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py
@@ -14,7 +14,7 @@
 
 from ..._internal._asyncio import cancel_and_await
 from ...actor import ComponentMetricRequest, _channel_registry, _power_managing
-from ...actor.power_distributing._component_pool_status_tracker import ComponentStatus
+from ...actor.power_distributing._component_status import ComponentPoolStatus
 from ...microgrid import connection_manager
 from ...microgrid.component import ComponentCategory
 from ..formula_engine._formula_engine_pool import FormulaEnginePool
@@ -38,7 +38,7 @@ def __init__(  # pylint: disable=too-many-arguments
         self,
         channel_registry: _channel_registry.ChannelRegistry,
         resampler_subscription_sender: Sender[ComponentMetricRequest],
-        batteries_status_receiver: Receiver[ComponentStatus],
+        batteries_status_receiver: Receiver[ComponentPoolStatus],
         power_manager_requests_sender: Sender[_power_managing.Proposal],
         power_manager_bounds_subscription_sender: Sender[_power_managing.ReportRequest],
         min_update_interval: timedelta,
@@ -131,7 +131,9 @@ def _get_all_batteries(self) -> frozenset[int]:
             }
         )
 
-    async def _update_battery_status(self, receiver: Receiver[ComponentStatus]) -> None:
+    async def _update_battery_status(
+        self, receiver: Receiver[ComponentPoolStatus]
+    ) -> None:
         async for status in receiver:
             self._working_batteries = status.get_working_components(self._batteries)
             for item in self._active_methods.values():
diff --git a/tests/actor/power_distributing/test_power_distributing.py b/tests/actor/power_distributing/test_power_distributing.py
@@ -16,7 +16,7 @@
 
 from frequenz.sdk import microgrid
 from frequenz.sdk.actor.power_distributing import (
-    ComponentStatus,
+    ComponentPoolStatus,
     PowerDistributingActor,
     Request,
 )
@@ -58,7 +58,7 @@ async def test_constructor(self, mocker: MockerFixture) -> None:
 
         requests_channel = Broadcast[Request]("power_distributor requests")
         results_channel = Broadcast[Result]("power_distributor results")
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -130,7 +130,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -193,7 +193,7 @@ async def test_power_distributor_exclusion_bounds(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -294,7 +294,7 @@ async def test_two_batteries_one_inverters(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -376,7 +376,7 @@ async def test_two_batteries_one_broken_one_inverters(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -450,7 +450,7 @@ async def test_battery_two_inverters(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -528,7 +528,7 @@ async def test_two_batteries_three_inverters(self, mocker: MockerFixture) -> Non
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -617,7 +617,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds_2(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -705,7 +705,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -776,7 +776,7 @@ async def test_connected_but_not_requested_batteries(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -838,7 +838,7 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -902,7 +902,7 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -974,7 +974,7 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1024,7 +1024,7 @@ async def test_power_distributor_invalid_battery_id(
         )
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1074,7 +1074,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1126,7 +1126,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1178,7 +1178,7 @@ async def test_power_distributor_one_user_adjust_power_success(
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1223,7 +1223,7 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
         requests_channel = Broadcast[Request]("power_distributor requests")
         results_channel = Broadcast[Result]("power_distributor results")
 
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1284,7 +1284,7 @@ async def test_partial_failure_result(self, mocker: MockerFixture) -> None:
         requests_channel = Broadcast[Request]("power_distributor requests")
         results_channel = Broadcast[Result]("power_distributor results")
 
-        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
diff --git a/tests/actor/test_battery_pool_status.py b/tests/actor/test_battery_pool_status.py
diff --git a/tests/timeseries/_battery_pool/test_battery_pool.py b/tests/timeseries/_battery_pool/test_battery_pool.py
diff --git a/tests/timeseries/_battery_pool/test_battery_pool_control_methods.py b/tests/timeseries/_battery_pool/test_battery_pool_control_methods.py
