Rename BatteriesStatus to BatteryPoolStatus

Signed-off-by: ela-kotulska-frequenz <[email protected]>

Author: ela-kotulska-frequenz

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

@@ -63,7 +63,7 @@ def __post_init__(self):
         self.sender = channel.new_sender()
 
 
-class BatteriesStatus:
+class BatteryPoolStatus:
     """Track status of the batteries.
 
     Send set of working and uncertain batteries, when the any battery change status.
@@ -75,7 +75,7 @@ def __init__(
         max_data_age_sec: float,
         max_blocking_duration_sec: float,
     ) -> None:
-        """Create BatteriesStatus instance.
+        """Create BatteryPoolStatus instance.
 
         Args:
             battery_ids: set of batteries ids that should be stored in pool.
@@ -141,7 +141,9 @@ async def _run(self) -> None:
             try:
                 await self._update_status(self._battery_status_channel)
             except Exception as err:  # pylint: disable=broad-except
-                _logger.error("BatteriesStatus failed with error: %s. Restarting.", err)
+                _logger.error(
+                    "BatteryPoolStatus failed with error: %s. Restarting.", err
+                )
 
     async def _update_status(self, status_channel: MergeNamed[BatteryStatus]) -> None:
         """Wait for any battery to change status and update status.

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

@@ -44,7 +44,7 @@
     InverterData,
 )
 from ...power import DistributionAlgorithm, DistributionResult, InvBatPair
-from ._battery_pool_status import BatteriesStatus
+from ._battery_pool_status import BatteryPoolStatus
 from .request import Request
 from .result import Error, Ignored, OutOfBound, PartialFailure, Result, Success
 
@@ -183,7 +183,7 @@ def __init__(
         self._users_tasks = self._create_users_tasks()
         self._started = asyncio.Event()
 
-        self._batteries_status = BatteriesStatus(
+        self._all_battery_status = BatteryPoolStatus(
             battery_ids=set(self._bat_inv_map.keys()),
             max_blocking_duration_sec=30.0,
             max_data_age_sec=10.0,
@@ -262,7 +262,7 @@ async def run(self) -> None:
 
             try:
                 pairs_data: List[InvBatPair] = self._get_components_data(
-                    self._batteries_status.get_working_batteries(request.batteries)
+                    self._all_battery_status.get_working_batteries(request.batteries)
                 )
             except KeyError as err:
                 await user.channel.send(Error(request, str(err)))
@@ -319,7 +319,7 @@ async def run(self) -> None:
 
             asyncio.gather(
                 *[
-                    self._batteries_status.update_status(
+                    self._all_battery_status.update_status(
                         succeed_batteries, failed_batteries
                     ),
                     user.channel.send(response),
@@ -652,5 +652,5 @@ async def _cancel_tasks(self, tasks: Iterable[asyncio.Task[Any]]) -> None:
     async def _stop_actor(self) -> None:
         """Stop all running async tasks."""
         await asyncio.gather(*[cancel_and_await(t) for t in self._users_tasks])
-        await self._batteries_status.stop()
+        await self._all_battery_status.stop()
         await self._stop()  # type: ignore # pylint: disable=no-member

tests/actor/test_battery_pool_status.py

@@ -1,22 +1,22 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
-"""Tests for BatteriesStatus."""
+"""Tests for BatteryPoolStatus."""
 
 import asyncio
 from typing import Set
 
 import pytest
 from pytest_mock import MockerFixture
 
-from frequenz.sdk.actor.power_distributing._battery_pool_status import BatteriesStatus
+from frequenz.sdk.actor.power_distributing._battery_pool_status import BatteryPoolStatus
 from frequenz.sdk.microgrid.component import ComponentCategory
 
 from ..utils.mock_microgrid import MockMicrogridClient
 from .test_battery_status import battery_data, component_graph, inverter_data
 
 
-class TestBatteriesStatus:
-    """Tests for BatteriesStatus"""
+class TestBatteryPoolStatus:
+    """Tests for BatteryPoolStatus"""
 
     @pytest.fixture
     async def mock_microgrid(self, mocker: MockerFixture) -> MockMicrogridClient:
@@ -34,7 +34,7 @@ async def mock_microgrid(self, mocker: MockerFixture) -> MockMicrogridClient:
         return microgrid
 
     async def test_batteries_status(self, mock_microgrid: MockMicrogridClient) -> None:
-        """Basic tests for BatteriesStatus.
+        """Basic tests for BatteryPoolStatus.
 
         BatteryStatusTracker is more tested in its own unit tests.
 
@@ -47,7 +47,7 @@ async def test_batteries_status(self, mock_microgrid: MockMicrogridClient) -> No
                 component_category={ComponentCategory.BATTERY}
             )
         }
-        batteries_status = BatteriesStatus(
+        batteries_status = BatteryPoolStatus(
             battery_ids=batteries,
             max_data_age_sec=5,
             max_blocking_duration_sec=30,

tests/actor/test_power_distributing.py

@@ -12,7 +12,7 @@
 from pytest_mock import MockerFixture
 
 from frequenz.sdk.actor.power_distributing import PowerDistributingActor, Request
-from frequenz.sdk.actor.power_distributing._battery_pool_status import BatteriesStatus
+from frequenz.sdk.actor.power_distributing._battery_pool_status import BatteryPoolStatus
 from frequenz.sdk.actor.power_distributing.result import (
     Error,
     Ignored,
@@ -88,8 +88,8 @@ async def test_constructor(self, mocker: MockerFixture) -> None:
 
         attrs = {"get_working_batteries.return_value": {306}}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         channel = Bidirectional[Request, Result]("user1", "power_distributor")
@@ -146,8 +146,8 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
 
         attrs = {"get_working_batteries.return_value": request.batteries}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
@@ -185,8 +185,8 @@ async def test_power_distributor_two_users(self, mocker: MockerFixture) -> None:
 
         attrs = {"get_working_batteries.return_value": {106, 206}}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
@@ -242,8 +242,8 @@ async def test_power_distributor_invalid_battery_id(
 
         attrs = {"get_working_batteries.return_value": request.batteries}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
 
@@ -286,8 +286,8 @@ async def test_power_distributor_overlapping_batteries(
             "get_working_batteries.side_effect": [{106, 206}, {106, 306}, {106, 206}]
         }
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         distributor = PowerDistributingActor(service_channels)
@@ -361,8 +361,8 @@ async def test_power_distributor_one_user_adjust_power_consume(
 
         attrs = {"get_working_batteries.return_value": request.batteries}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
@@ -408,8 +408,8 @@ async def test_power_distributor_one_user_adjust_power_supply(
 
         attrs = {"get_working_batteries.return_value": request.batteries}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
@@ -455,8 +455,8 @@ async def test_power_distributor_one_user_adjust_power_success(
 
         attrs = {"get_working_batteries.return_value": request.batteries}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)
@@ -494,8 +494,8 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
 
         attrs = {"get_working_batteries.return_value": request.batteries - {106}}
         mocker.patch(
-            "frequenz.sdk.actor.power_distributing.power_distributing.BatteriesStatus",
-            return_value=MagicMock(spec=BatteriesStatus, **attrs),
+            "frequenz.sdk.actor.power_distributing.power_distributing.BatteryPoolStatus",
+            return_value=MagicMock(spec=BatteryPoolStatus, **attrs),
         )
 
         mocker.patch("asyncio.sleep", new_callable=AsyncMock)