Rename BatteryStatus → ComponentStatus

Also update its documentation and methods to not say "batteries", and
update all uses of the class to match the new names.

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

Author: shsms

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 (
-    BatteryStatus,
+    ComponentStatus,
     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[BatteryStatus]("battery-status")
+    battery_status_channel = Broadcast[ComponentStatus]("battery-status")
     power_result_channel = Broadcast[Result]("power-result")
     async with PowerDistributingActor(
         requests_receiver=power_request_channel.new_receiver(),

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

@@ -10,7 +10,7 @@
 PowerDistributingActor and send requests for charging or discharging power.
 """
 
-from ._battery_pool_status import BatteryStatus
+from ._battery_pool_status import ComponentStatus
 from .power_distributing import PowerDistributingActor
 from .request import Request
 from .result import Error, OutOfBounds, PartialFailure, Result, Success
@@ -23,5 +23,5 @@
     "Success",
     "OutOfBounds",
     "PartialFailure",
-    "BatteryStatus",
+    "ComponentStatus",
 ]

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

@@ -18,28 +18,28 @@
 
 
 @dataclass
-class BatteryStatus:
-    """Status of the batteries."""
+class ComponentStatus:
+    """Status of all components of a certain category in the microgrid."""
 
     working: set[int]
-    """Set of working battery ids."""
+    """Set of working component ids."""
 
     uncertain: set[int]
-    """Set of batteries that should be used only if there are no working batteries."""
+    """Set of components to be used only when there are none known to be working."""
 
-    def get_working_batteries(self, batteries: abc.Set[int]) -> set[int]:
-        """From the given set of batteries return working batteries.
+    def get_working_components(self, components: abc.Set[int]) -> set[int]:
+        """From the given set of components return the working ones.
 
         Args:
-            batteries: Set of batteries
+            components: Set of components.
 
         Returns:
-            Subset with working batteries.
+            Subset with working components.
         """
-        working = self.working.intersection(batteries)
+        working = self.working.intersection(components)
         if len(working) > 0:
             return working
-        return self.uncertain.intersection(batteries)
+        return self.uncertain.intersection(components)
 
 
 @dataclass
@@ -71,7 +71,7 @@ class BatteryPoolStatus:
     def __init__(  # noqa: DOC502 (RuntimeError is raised indirectly by BatteryStatus)
         self,
         battery_ids: set[int],
-        battery_status_sender: Sender[BatteryStatus],
+        battery_status_sender: Sender[ComponentStatus],
         max_data_age_sec: float,
         max_blocking_duration_sec: float,
     ) -> None:
@@ -93,7 +93,7 @@ def __init__(  # noqa: DOC502 (RuntimeError is raised indirectly by BatteryStatu
         """
         # At first no battery is working, we will get notification when they start
         # working.
-        self._current_status = BatteryStatus(working=set(), uncertain=set())
+        self._current_status = ComponentStatus(working=set(), uncertain=set())
 
         # Channel for sending results of requests to the batteries
         set_power_result_channel = Broadcast[SetPowerResult]("battery_request_status")
@@ -148,7 +148,7 @@ async def stop(self) -> None:
         )
         await self._battery_status_channel.stop()
 
-    async def _run(self, battery_status_sender: Sender[BatteryStatus]) -> None:
+    async def _run(self, battery_status_sender: Sender[ComponentStatus]) -> None:
         """Start tracking batteries status.
 
         Args:
@@ -164,7 +164,7 @@ async def _run(self, battery_status_sender: Sender[BatteryStatus]) -> None:
                 )
 
     async def _update_status(
-        self, battery_status_sender: Sender[BatteryStatus]
+        self, battery_status_sender: Sender[ComponentStatus]
     ) -> None:
         """Wait for any battery to change status and update status.
 
@@ -211,4 +211,4 @@ def get_working_batteries(self, batteries: abc.Set[int]) -> set[int]:
         Returns:
             Subset with working batteries.
         """
-        return self._current_status.get_working_batteries(batteries)
+        return self._current_status.get_working_components(batteries)

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

@@ -36,7 +36,7 @@
     ComponentCategory,
     InverterData,
 )
-from ._battery_pool_status import BatteryPoolStatus, BatteryStatus
+from ._battery_pool_status import BatteryPoolStatus, ComponentStatus
 from ._distribution_algorithm import (
     AggregatedBatteryData,
     DistributionAlgorithm,
@@ -164,7 +164,7 @@ def __init__(
         self,
         requests_receiver: Receiver[Request],
         results_sender: Sender[Result],
-        battery_status_sender: Sender[BatteryStatus],
+        battery_status_sender: Sender[ComponentStatus],
         wait_for_data_sec: float = 2,
         *,
         name: str | None = None,

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)
-        BatteryStatus,
+        ComponentStatus,
         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["BatteryStatus"](
+        self._battery_status_channel = Broadcast["ComponentStatus"](
             "battery-status", resend_latest=True
         )
         self._power_distribution_requests_channel = Broadcast["Request"](

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._battery_pool_status import BatteryStatus
+from ...actor.power_distributing._battery_pool_status import ComponentStatus
 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[BatteryStatus],
+        batteries_status_receiver: Receiver[ComponentStatus],
         power_manager_requests_sender: Sender[_power_managing.Proposal],
         power_manager_bounds_subscription_sender: Sender[_power_managing.ReportRequest],
         min_update_interval: timedelta,
@@ -131,8 +131,8 @@ def _get_all_batteries(self) -> frozenset[int]:
             }
         )
 
-    async def _update_battery_status(self, receiver: Receiver[BatteryStatus]) -> None:
+    async def _update_battery_status(self, receiver: Receiver[ComponentStatus]) -> None:
         async for status in receiver:
-            self._working_batteries = status.get_working_batteries(self._batteries)
+            self._working_batteries = status.get_working_components(self._batteries)
             for item in self._active_methods.values():
                 item.update_working_batteries(self._working_batteries)

tests/actor/power_distributing/test_power_distributing.py

@@ -16,7 +16,7 @@
 
 from frequenz.sdk import microgrid
 from frequenz.sdk.actor.power_distributing import (
-    BatteryStatus,
+    ComponentStatus,
     PowerDistributingActor,
     Request,
 )
@@ -56,7 +56,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[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -128,7 +128,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -191,7 +191,7 @@ async def test_power_distributor_exclusion_bounds(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -292,7 +292,7 @@ async def test_two_batteries_one_inverters(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -374,7 +374,7 @@ async def test_two_batteries_one_broken_one_inverters(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -448,7 +448,7 @@ async def test_battery_two_inverters(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -526,7 +526,7 @@ async def test_two_batteries_three_inverters(self, mocker: MockerFixture) -> Non
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -615,7 +615,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds_2(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -703,7 +703,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -774,7 +774,7 @@ async def test_connected_but_not_requested_batteries(
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
@@ -836,7 +836,7 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -899,7 +899,7 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -971,7 +971,7 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1021,7 +1021,7 @@ async def test_power_distributor_invalid_battery_id(
         )
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1071,7 +1071,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1123,7 +1123,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1175,7 +1175,7 @@ async def test_power_distributor_one_user_adjust_power_success(
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1220,7 +1220,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[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
@@ -1281,7 +1281,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[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),

tests/actor/test_battery_pool_status.py

@@ -9,7 +9,7 @@
 
 from frequenz.sdk.actor.power_distributing._battery_pool_status import (
     BatteryPoolStatus,
-    BatteryStatus,
+    ComponentStatus,
 )
 from frequenz.sdk.microgrid.component import ComponentCategory
 from tests.timeseries.mock_microgrid import MockMicrogrid
@@ -39,7 +39,7 @@ async def test_batteries_status(self, mocker: MockerFixture) -> None:
                 component_category={ComponentCategory.BATTERY}
             )
         }
-        battery_status_channel = Broadcast[BatteryStatus]("battery_status")
+        battery_status_channel = Broadcast[ComponentStatus]("battery_status")
         battery_status_recv = battery_status_channel.new_receiver(maxsize=1)
         batteries_status = BatteryPoolStatus(
             battery_ids=batteries,