Update power distributing Result to Power type

Using the Power type enhances code clarity and flexibility,
as it supports various power units, power arithmetic operations,
and precise logging, which improves code readability and error
prevention.

Signed-off-by: Daniel Zullo <[email protected]>

Author: daniel-zullo-frequenz

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

@@ -26,6 +26,8 @@
 import grpc
 from frequenz.channels import Peekable, Receiver, Sender
 
+from frequenz.sdk.timeseries._quantities import Power
+
 from ..._internal._math import is_close_to_zero
 from ...actor import ChannelRegistry
 from ...actor._actor import Actor
@@ -291,19 +293,19 @@ async def _run(self) -> None:
                 succeed_batteries = set(battery_distribution.keys()) - failed_batteries
                 response = PartialFailure(
                     request=request,
-                    succeeded_power=distributed_power_value,
+                    succeeded_power=Power.from_watts(distributed_power_value),
                     succeeded_batteries=succeed_batteries,
-                    failed_power=failed_power,
+                    failed_power=Power.from_watts(failed_power),
                     failed_batteries=failed_batteries,
-                    excess_power=distribution.remaining_power,
+                    excess_power=Power.from_watts(distribution.remaining_power),
                 )
             else:
                 succeed_batteries = set(battery_distribution.keys())
                 response = Success(
                     request=request,
-                    succeeded_power=distributed_power_value,
+                    succeeded_power=Power.from_watts(distributed_power_value),
                     succeeded_batteries=succeed_batteries,
-                    excess_power=distribution.remaining_power,
+                    excess_power=Power.from_watts(distribution.remaining_power),
                 )
 
             asyncio.gather(

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

@@ -7,6 +7,8 @@
 
 import dataclasses
 
+from frequenz.sdk.timeseries._quantities import Power
+
 from .request import Request
 
 
@@ -34,13 +36,13 @@ class Result(_BaseResultMixin):
 class _BaseSuccessMixin:
     """Result returned when setting the power succeed for all batteries."""
 
-    succeeded_power: float
+    succeeded_power: Power
     """The part of the requested power that was successfully set."""
 
     succeeded_batteries: set[int]
     """The subset of batteries for which power was set successfully."""
 
-    excess_power: float
+    excess_power: Power
     """The part of the requested power that could not be fulfilled.
 
     This happens when the requested power is outside the available power bounds.
@@ -62,7 +64,7 @@ class Success(_BaseSuccessMixin, Result):  # Order matters here. See above.
 class PartialFailure(_BaseSuccessMixin, Result):
     """Result returned when any battery failed to perform the request."""
 
-    failed_power: float
+    failed_power: Power
     """The part of the requested power that failed to be set."""
 
     failed_batteries: set[int]

tests/actor/power_distributing/test_power_distributing.py

@@ -12,7 +12,6 @@
 from unittest.mock import AsyncMock, MagicMock
 
 from frequenz.channels import Broadcast
-from pytest import approx
 from pytest_mock import MockerFixture
 
 from frequenz.sdk import microgrid
@@ -31,6 +30,7 @@
     Success,
 )
 from frequenz.sdk.microgrid.component import ComponentCategory
+from frequenz.sdk.timeseries._quantities import Power
 from tests.timeseries.mock_microgrid import MockMicrogrid
 
 from ...conftest import SAFETY_TIMEOUT
@@ -143,8 +143,8 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
 
         result: Result = done.pop().result()
         assert isinstance(result, Success)
-        assert result.succeeded_power == approx(1000.0)
-        assert result.excess_power == approx(200.0)
+        assert result.succeeded_power.isclose(Power.from_kilowatts(1.0))
+        assert result.excess_power.isclose(Power.from_watts(200.0))
         assert result.request == request
 
     async def test_power_distributor_exclusion_bounds(
@@ -212,8 +212,8 @@ async def test_power_distributor_exclusion_bounds(
 
             result: Result = done.pop().result()
             assert isinstance(result, Success)
-            assert result.succeeded_power == approx(0.0)
-            assert result.excess_power == approx(0.0)
+            assert result.succeeded_power.isclose(Power.zero(), abs_tol=1e-9)
+            assert result.excess_power.isclose(Power.zero(), abs_tol=1e-9)
             assert result.request == request
 
             ## non-zero power requests that fall within the exclusion bounds should be
@@ -300,8 +300,8 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
         result: Result = done.pop().result()
         assert isinstance(result, Success)
         assert result.succeeded_batteries == {19}
-        assert result.succeeded_power == approx(500.0)
-        assert result.excess_power == approx(700.0)
+        assert result.succeeded_power.isclose(Power.from_watts(500.0))
+        assert result.excess_power.isclose(Power.from_watts(700.0))
         assert result.request == request
 
     async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
@@ -356,8 +356,8 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
         result: Result = done.pop().result()
         assert isinstance(result, Success)
         assert result.succeeded_batteries == {19}
-        assert result.succeeded_power == approx(500.0)
-        assert result.excess_power == approx(700.0)
+        assert result.succeeded_power.isclose(Power.from_watts(500.0))
+        assert result.excess_power.isclose(Power.from_watts(700.0))
         assert result.request == request
 
     async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
@@ -428,8 +428,8 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
         result: Result = done.pop().result()
         assert isinstance(result, Success)
         assert result.succeeded_batteries == {19}
-        assert result.succeeded_power == approx(1000.0)
-        assert result.excess_power == approx(200.0)
+        assert result.succeeded_power.isclose(Power.from_kilowatts(1.0))
+        assert result.excess_power.isclose(Power.from_watts(200.0))
         assert result.request == request
 
     async def test_power_distributor_invalid_battery_id(
@@ -627,8 +627,8 @@ async def test_power_distributor_one_user_adjust_power_success(
 
         result = done.pop().result()
         assert isinstance(result, Success)
-        assert result.succeeded_power == approx(1000.0)
-        assert result.excess_power == approx(0.0)
+        assert result.succeeded_power.isclose(Power.from_kilowatts(1.0))
+        assert result.excess_power.isclose(Power.zero(), abs_tol=1e-9)
         assert result.request == request
 
     async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> None:
@@ -676,8 +676,8 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
             result = done.pop().result()
             assert isinstance(result, Success)
             assert result.succeeded_batteries == {19}
-            assert result.excess_power == approx(700.0)
-            assert result.succeeded_power == approx(500.0)
+            assert result.excess_power.isclose(Power.from_watts(700.0))
+            assert result.succeeded_power.isclose(Power.from_watts(500.0))
             assert result.request == request
 
     async def test_use_all_batteries_none_is_working(
@@ -726,8 +726,8 @@ async def test_use_all_batteries_none_is_working(
             result = done.pop().result()
             assert isinstance(result, Success)
             assert result.succeeded_batteries == {9, 19}
-            assert result.excess_power == approx(200.0)
-            assert result.succeeded_power == approx(1000.0)
+            assert result.excess_power.isclose(Power.from_watts(200.0))
+            assert result.succeeded_power.isclose(Power.from_kilowatts(1.0))
             assert result.request == request
 
     async def test_force_request_a_battery_is_not_working(
@@ -778,8 +778,8 @@ async def test_force_request_a_battery_is_not_working(
             result = done.pop().result()
             assert isinstance(result, Success)
             assert result.succeeded_batteries == {9, 19}
-            assert result.excess_power == approx(200.0)
-            assert result.succeeded_power == approx(1000.0)
+            assert result.excess_power.isclose(Power.from_watts(200.0))
+            assert result.succeeded_power.isclose(Power.from_kilowatts(1.0))
             assert result.request == request
 
     async def test_force_request_battery_nan_value_non_cached(
@@ -849,8 +849,8 @@ async def test_force_request_battery_nan_value_non_cached(
             result: Result = done.pop().result()
             assert isinstance(result, Success)
             assert result.succeeded_batteries == batteries
-            assert result.succeeded_power == approx(1199.9999)
-            assert result.excess_power == approx(0.0)
+            assert result.succeeded_power.isclose(Power.from_kilowatts(1.2))
+            assert result.excess_power.isclose(Power.zero(), abs_tol=1e-9)
             assert result.request == request
 
     async def test_force_request_batteries_nan_values_cached(
@@ -900,8 +900,8 @@ async def test_result() -> None:
                 result: Result = done.pop().result()
                 assert isinstance(result, Success)
                 assert result.succeeded_batteries == batteries
-                assert result.succeeded_power == approx(1199.9999)
-                assert result.excess_power == approx(0.0)
+                assert result.succeeded_power.isclose(Power.from_kilowatts(1.2))
+                assert result.excess_power.isclose(Power.zero(), abs_tol=1e-9)
                 assert result.request == request
 
             batteries_data = (