Rename PowerDistributor's {battery → component_pool}_status_sender

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

Author: shsms

benchmarks/power_distribution/power_distributor.py

@@ -117,7 +117,7 @@ async def run_test(  # pylint: disable=too-many-locals
     async with PowerDistributingActor(
         requests_receiver=power_request_channel.new_receiver(),
         results_sender=power_result_channel.new_sender(),
-        battery_status_sender=battery_status_channel.new_sender(),
+        component_pool_status_sender=battery_status_channel.new_sender(),
     ):
         tasks: list[Coroutine[Any, Any, list[Result]]] = []
         tasks.append(send_requests(batteries, num_requests))

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

@@ -166,18 +166,19 @@ def __init__(
         self,
         requests_receiver: Receiver[Request],
         results_sender: Sender[Result],
-        battery_status_sender: Sender[ComponentPoolStatus],
+        component_pool_status_sender: Sender[ComponentPoolStatus],
         wait_for_data_sec: float = 2,
         *,
         name: str | None = None,
     ) -> None:
         """Create class instance.
 
         Args:
-            requests_receiver: Receiver for receiving power requests from the power manager.
+            requests_receiver: Receiver for receiving power requests from the power
+                manager.
             results_sender: Sender for sending results to the power manager.
-            battery_status_sender: Channel for sending information which batteries are
-                working.
+            component_pool_status_sender: Channel for sending information about which
+                components are expected to be working.
             wait_for_data_sec: How long actor should wait before processing first
                 request. It is a time needed to collect first components data.
             name: The name of the actor. If `None`, `str(id(self))` will be used. This
@@ -221,7 +222,7 @@ def __init__(
 
         self._component_pool_status_tracker = ComponentPoolStatusTracker(
             component_ids=set(self._bat_invs_map.keys()),
-            component_status_sender=battery_status_sender,
+            component_status_sender=component_pool_status_sender,
             max_blocking_duration_sec=30.0,
             max_data_age_sec=10.0,
             component_status_tracker_type=BatteryStatusTracker,

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -315,7 +315,7 @@ def _start_power_distributing_actor(self) -> None:
         self._power_distributing_actor = PowerDistributingActor(
             requests_receiver=self._power_distribution_requests_channel.new_receiver(),
             results_sender=self._power_distribution_results_channel.new_sender(),
-            battery_status_sender=self._battery_status_channel.new_sender(),
+            component_pool_status_sender=self._battery_status_channel.new_sender(),
         )
         self._power_distributing_actor.start()
 

tests/actor/power_distributing/test_power_distributing.py

@@ -62,7 +62,7 @@ async def test_constructor(self, mocker: MockerFixture) -> None:
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ) as distributor:
             assert distributor._bat_invs_map == {9: {8}, 19: {18}, 29: {28}}
             assert distributor._inv_bats_map == {8: {9}, 18: {19}, 28: {29}}
@@ -76,7 +76,7 @@ async def test_constructor(self, mocker: MockerFixture) -> None:
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ) as distributor:
             assert distributor._bat_invs_map == {9: {8}, 19: {18}, 29: {28}}
             assert distributor._inv_bats_map == {8: {9}, 18: {19}, 28: {29}}
@@ -134,7 +134,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
             result_rx = results_channel.new_receiver()
@@ -197,7 +197,7 @@ async def test_power_distributor_exclusion_bounds(
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             # zero power requests should pass through despite the exclusion bounds.
             request = Request(
@@ -298,7 +298,7 @@ async def test_two_batteries_one_inverters(self, mocker: MockerFixture) -> None:
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
             results_sender=results_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
@@ -380,7 +380,7 @@ async def test_two_batteries_one_broken_one_inverters(
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
             results_sender=results_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
@@ -454,7 +454,7 @@ async def test_battery_two_inverters(self, mocker: MockerFixture) -> None:
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
             results_sender=results_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
@@ -532,7 +532,7 @@ async def test_two_batteries_three_inverters(self, mocker: MockerFixture) -> Non
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
             results_sender=results_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
@@ -621,7 +621,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds_2(
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
             results_sender=results_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
@@ -709,7 +709,7 @@ async def test_two_batteries_one_inverter_different_exclusion_bounds(
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
             results_sender=results_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
@@ -780,7 +780,7 @@ async def test_connected_but_not_requested_batteries(
 
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
             results_sender=results_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
@@ -842,7 +842,7 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             attrs = {"get_working_components.return_value": request.component_ids}
             mocker.patch(
@@ -906,7 +906,7 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
             result_rx = results_channel.new_receiver()
@@ -978,7 +978,7 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
             result_rx = results_channel.new_receiver()
@@ -1028,7 +1028,7 @@ async def test_power_distributor_invalid_battery_id(
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
             result_rx = results_channel.new_receiver()
@@ -1078,7 +1078,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
             result_rx = results_channel.new_receiver()
@@ -1130,7 +1130,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
             result_rx = results_channel.new_receiver()
@@ -1182,7 +1182,7 @@ async def test_power_distributor_one_user_adjust_power_success(
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             await requests_channel.new_sender().send(request)
             result_rx = results_channel.new_receiver()
@@ -1227,7 +1227,7 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             request = Request(
                 power=Power.from_kilowatts(1.2),
@@ -1288,7 +1288,7 @@ async def test_partial_failure_result(self, mocker: MockerFixture) -> None:
         async with PowerDistributingActor(
             requests_receiver=requests_channel.new_receiver(),
             results_sender=results_channel.new_sender(),
-            battery_status_sender=battery_status_channel.new_sender(),
+            component_pool_status_sender=battery_status_channel.new_sender(),
         ):
             request = Request(
                 power=Power.from_kilowatts(1.70),