Rename properties of power distributor results

Rename properties of Success and PartialFailure to make them more
consistent.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

RELEASE_NOTES.md

@@ -8,6 +8,10 @@
 
 * Update BatteryStatus to mark battery with unknown capacity as not working (#263)
 * The channels dependency was updated to v0.14.0 (#292)
+* Some properties for `PowerDistributingActor` results were renamed to be more consistent between `Success` and `PartialFailure`:
+  * The `Success.used_batteries` property was renamed to `succeeded_batteries`.
+  * The `PartialFailure.success_batteries` property was renamed to `succeeded_batteries`.
+  * The `succeed_power` property was renamed to `succeeded_power` for both `Success` and `PartialFailure`.
 
 ## New Features
 

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

@@ -309,8 +309,8 @@ async def run(self) -> None:
                 succeed_batteries = set(battery_distribution.keys()) - failed_batteries
                 response = PartialFailure(
                     request=request,
-                    succeed_power=distributed_power_value,
-                    succeed_batteries=succeed_batteries,
+                    succeeded_power=distributed_power_value,
+                    succeeded_batteries=succeed_batteries,
                     failed_power=failed_power,
                     failed_batteries=failed_batteries,
                     excess_power=distribution.remaining_power,
@@ -319,8 +319,8 @@ async def run(self) -> None:
                 succeed_batteries = set(battery_distribution.keys())
                 response = Success(
                     request=request,
-                    succeed_power=distributed_power_value,
-                    used_batteries=succeed_batteries,
+                    succeeded_power=distributed_power_value,
+                    succeeded_batteries=succeed_batteries,
                     excess_power=distribution.remaining_power,
                 )
 

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

@@ -27,8 +27,8 @@ class Success(Result):
     def __init__(
         self,
         request: Request,
-        succeed_power: int,
-        used_batteries: Set[int],
+        succeeded_power: int,
+        succeeded_batteries: Set[int],
         excess_power: int,
     ) -> None:
         """Create class instance.
@@ -42,8 +42,8 @@ def __init__(
                 because it was outside available power bounds.
         """
         super().__init__(request)
-        self.succeed_power: int = succeed_power
-        self.used_batteries: Set[int] = used_batteries
+        self.succeed_power: int = succeeded_power
+        self.used_batteries: Set[int] = succeeded_batteries
         self.excess_power: int = excess_power
 
 
@@ -56,8 +56,8 @@ class PartialFailure(Result):
     def __init__(  # pylint: disable=too-many-arguments
         self,
         request: Request,
-        succeed_power: int,
-        succeed_batteries: Set[int],
+        succeeded_power: int,
+        succeeded_batteries: Set[int],
         failed_power: int,
         failed_batteries: Set[int],
         excess_power: int,
@@ -76,8 +76,8 @@ def __init__(  # pylint: disable=too-many-arguments
                 because it was outside available power bounds.
         """
         super().__init__(request)
-        self.succeed_power: int = succeed_power
-        self.succeed_batteries: Set[int] = succeed_batteries
+        self.succeed_power: int = succeeded_power
+        self.succeed_batteries: Set[int] = succeeded_batteries
         self.failed_power: int = failed_power
         self.failed_batteries: Set[int] = failed_batteries
         self.excess_power: int = excess_power

tests/actor/test_power_distributing.py

@@ -179,7 +179,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
 
         result: Result = done.pop().result()
         assert isinstance(result, Success)
-        assert result.succeed_power == 1000
+        assert result.succeeded_power == 1000
         assert result.excess_power == 200
         assert result.request == request
 
@@ -238,8 +238,8 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
 
         result: Result = done.pop().result()
         assert isinstance(result, Success)
-        assert result.used_batteries == {206}
-        assert result.succeed_power == 500
+        assert result.succeeded_batteries == {206}
+        assert result.succeeded_power == 500
         assert result.excess_power == 700
         assert result.request == request
 
@@ -291,8 +291,8 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
 
         result: Result = done.pop().result()
         assert isinstance(result, Success)
-        assert result.used_batteries == {206}
-        assert result.succeed_power == 500
+        assert result.succeeded_batteries == {206}
+        assert result.succeeded_power == 500
         assert result.excess_power == 700
         assert result.request == request
 
@@ -360,8 +360,8 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
 
         result: Result = done.pop().result()
         assert isinstance(result, Success)
-        assert result.used_batteries == {206}
-        assert result.succeed_power == 1000
+        assert result.succeeded_batteries == {206}
+        assert result.succeeded_power == 1000
         assert result.excess_power == 200
         assert result.request == request
 
@@ -695,7 +695,7 @@ async def test_power_distributor_one_user_adjust_power_success(
 
         result = done.pop().result()
         assert isinstance(result, Success)
-        assert result.succeed_power == 1000
+        assert result.succeeded_power == 1000
         assert result.excess_power == 0
         assert result.request == request
 
@@ -739,5 +739,5 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
         result = done.pop().result()
         assert isinstance(result, Success)
         assert result.excess_power == 700
-        assert result.succeed_power == 500
+        assert result.succeeded_power == 500
         assert result.request == request