Update power Request attribute to Power type

The power Request is exposed through the power distributing
Result in the BatteryPool.
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

@@ -273,7 +273,9 @@ async def _run(self) -> None:
                 )
                 continue
 
-            distributed_power_value = request.power - distribution.remaining_power
+            distributed_power_value = (
+                request.power.as_watts() - distribution.remaining_power
+            )
             battery_distribution = {
                 self._inv_bat_map[bat_id]: dist
                 for bat_id, dist in distribution.distribution.items()
@@ -369,11 +371,11 @@ def _get_power_distribution(
 
         if request.include_broken_batteries and not available_bat_ids:
             return self.distribution_algorithm.distribute_power_equally(
-                request.power, unavailable_inv_ids
+                request.power.as_watts(), unavailable_inv_ids
             )
 
         result = self.distribution_algorithm.distribute_power(
-            request.power, inv_bat_pairs
+            request.power.as_watts(), inv_bat_pairs
         )
 
         if request.include_broken_batteries and unavailable_inv_ids:
@@ -414,9 +416,11 @@ def _check_request(
 
         bounds = self._get_bounds(pairs_data)
 
+        power = request.power.as_watts()
+
         # Zero power requests are always forwarded to the microgrid API, even if they
         # are outside the exclusion bounds.
-        if is_close_to_zero(request.power):
+        if is_close_to_zero(power):
             return None
 
         if request.adjust_power:
@@ -425,15 +429,11 @@ def _check_request(
             #
             # If the requested power is in the exclusion bounds, it is NOT possible to
             # increase it so that it is outside the exclusion bounds.
-            if bounds.exclusion_lower < request.power < bounds.exclusion_upper:
+            if bounds.exclusion_lower < power < bounds.exclusion_upper:
                 return OutOfBounds(request=request, bounds=bounds)
         else:
-            in_lower_range = (
-                bounds.inclusion_lower <= request.power <= bounds.exclusion_lower
-            )
-            in_upper_range = (
-                bounds.exclusion_upper <= request.power <= bounds.inclusion_upper
-            )
+            in_lower_range = bounds.inclusion_lower <= power <= bounds.exclusion_lower
+            in_upper_range = bounds.exclusion_upper <= power <= bounds.inclusion_upper
             if not (in_lower_range or in_upper_range):
                 return OutOfBounds(request=request, bounds=bounds)
 

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

@@ -8,6 +8,8 @@
 from collections import abc
 from datetime import timedelta
 
+from ...timeseries._quantities import Power
+
 
 @dataclasses.dataclass
 class Request:
@@ -20,8 +22,8 @@ class Request:
     channel registry.
     """
 
-    power: float
-    """The requested power in watts."""
+    power: Power
+    """The requested power."""
 
     batteries: abc.Set[int]
     """The component ids of the batteries to be used for this request."""

src/frequenz/sdk/timeseries/battery_pool/battery_pool.py

@@ -143,7 +143,7 @@ async def set_power(
         await self._power_distributing_sender.send(
             Request(
                 namespace=self._power_distributing_namespace,
-                power=power.as_watts(),
+                power=power,
                 batteries=self._batteries,
                 adjust_power=adjust_power,
                 request_timeout=request_timeout,
@@ -184,13 +184,12 @@ async def charge(
         Raises:
             ValueError: If the given power is negative.
         """
-        as_watts = power.as_watts()
-        if as_watts < 0.0:
+        if power < Power.zero():
             raise ValueError("Charge power must be positive.")
         await self._power_distributing_sender.send(
             Request(
                 namespace=self._power_distributing_namespace,
-                power=as_watts,
+                power=power,
                 batteries=self._batteries,
                 adjust_power=adjust_power,
                 request_timeout=request_timeout,
@@ -231,13 +230,12 @@ async def discharge(
         Raises:
             ValueError: If the given power is negative.
         """
-        as_watts = power.as_watts()
-        if as_watts < 0.0:
+        if power < Power.zero():
             raise ValueError("Discharge power must be positive.")
         await self._power_distributing_sender.send(
             Request(
                 namespace=self._power_distributing_namespace,
-                power=-as_watts,
+                power=-power,
                 batteries=self._batteries,
                 adjust_power=adjust_power,
                 request_timeout=request_timeout,

tests/actor/power_distributing/test_power_distributing.py

@@ -112,7 +112,7 @@ async def test_power_distributor_one_user(self, mocker: MockerFixture) -> None:
 
         request = Request(
             namespace=self._namespace,
-            power=1200.0,
+            power=Power.from_kilowatts(1.2),
             batteries={9, 19},
             request_timeout=SAFETY_TIMEOUT,
         )
@@ -194,7 +194,7 @@ async def test_power_distributor_exclusion_bounds(
             ## zero power requests should pass through despite the exclusion bounds.
             request = Request(
                 namespace=self._namespace,
-                power=0.0,
+                power=Power.zero(),
                 batteries={9, 19},
                 request_timeout=SAFETY_TIMEOUT,
             )
@@ -220,7 +220,7 @@ async def test_power_distributor_exclusion_bounds(
             ## rejected.
             request = Request(
                 namespace=self._namespace,
-                power=300.0,
+                power=Power.from_watts(300.0),
                 batteries={9, 19},
                 request_timeout=SAFETY_TIMEOUT,
             )
@@ -262,7 +262,7 @@ async def test_battery_soc_nan(self, mocker: MockerFixture) -> None:
 
         request = Request(
             namespace=self._namespace,
-            power=1200.0,
+            power=Power.from_kilowatts(1.2),
             batteries={9, 19},
             request_timeout=SAFETY_TIMEOUT,
         )
@@ -325,7 +325,7 @@ async def test_battery_capacity_nan(self, mocker: MockerFixture) -> None:
 
         request = Request(
             namespace=self._namespace,
-            power=1200.0,
+            power=Power.from_kilowatts(1.2),
             batteries={9, 19},
             request_timeout=SAFETY_TIMEOUT,
         )
@@ -397,7 +397,7 @@ async def test_battery_power_bounds_nan(self, mocker: MockerFixture) -> None:
 
         request = Request(
             namespace=self._namespace,
-            power=1200.0,
+            power=Power.from_kilowatts(1.2),
             batteries={9, 19},
             request_timeout=SAFETY_TIMEOUT,
         )
@@ -445,7 +445,7 @@ async def test_power_distributor_invalid_battery_id(
         channel_registry = ChannelRegistry(name="power_distributor")
         request = Request(
             namespace=self._namespace,
-            power=1200.0,
+            power=Power.from_kilowatts(1.2),
             batteries={9, 100},
             request_timeout=SAFETY_TIMEOUT,
         )
@@ -492,7 +492,7 @@ async def test_power_distributor_one_user_adjust_power_consume(
 
         request = Request(
             namespace=self._namespace,
-            power=1200.0,
+            power=Power.from_kilowatts(1.2),
             batteries={9, 19},
             request_timeout=SAFETY_TIMEOUT,
             adjust_power=False,
@@ -543,7 +543,7 @@ async def test_power_distributor_one_user_adjust_power_supply(
 
         request = Request(
             namespace=self._namespace,
-            power=-1200.0,
+            power=-Power.from_kilowatts(1.2),
             batteries={9, 19},
             request_timeout=SAFETY_TIMEOUT,
             adjust_power=False,
@@ -594,7 +594,7 @@ async def test_power_distributor_one_user_adjust_power_success(
 
         request = Request(
             namespace=self._namespace,
-            power=1000.0,
+            power=Power.from_kilowatts(1.0),
             batteries={9, 19},
             request_timeout=SAFETY_TIMEOUT,
             adjust_power=False,
@@ -658,7 +658,7 @@ async def test_not_all_batteries_are_working(self, mocker: MockerFixture) -> Non
         ):
             request = Request(
                 namespace=self._namespace,
-                power=1200.0,
+                power=Power.from_kilowatts(1.2),
                 batteries=batteries,
                 request_timeout=SAFETY_TIMEOUT,
             )
@@ -707,7 +707,7 @@ async def test_use_all_batteries_none_is_working(
         ):
             request = Request(
                 namespace=self._namespace,
-                power=1200.0,
+                power=Power.from_kilowatts(1.2),
                 batteries={9, 19},
                 request_timeout=SAFETY_TIMEOUT,
                 include_broken_batteries=True,
@@ -759,7 +759,7 @@ async def test_force_request_a_battery_is_not_working(
         ):
             request = Request(
                 namespace=self._namespace,
-                power=1200.0,
+                power=Power.from_kilowatts(1.2),
                 batteries=batteries,
                 request_timeout=SAFETY_TIMEOUT,
                 include_broken_batteries=True,
@@ -812,7 +812,7 @@ async def test_force_request_battery_nan_value_non_cached(
         ):
             request = Request(
                 namespace=self._namespace,
-                power=1200.0,
+                power=Power.from_kilowatts(1.2),
                 batteries=batteries,
                 request_timeout=SAFETY_TIMEOUT,
                 include_broken_batteries=True,
@@ -882,7 +882,7 @@ async def test_force_request_batteries_nan_values_cached(
         ):
             request = Request(
                 namespace=self._namespace,
-                power=1200.0,
+                power=Power.from_kilowatts(1.2),
                 batteries=batteries,
                 request_timeout=SAFETY_TIMEOUT,
                 include_broken_batteries=True,