Remove distribution_result field from Report classes

This should reduce the number of `Report`s sent out by the
PowerManager.

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

Author: shsms

src/frequenz/sdk/actor/_power_managing/_base_classes.py

@@ -16,7 +16,6 @@
 
 if typing.TYPE_CHECKING:
     from ...timeseries._base_types import SystemBounds
-    from .. import power_distributing
 
 
 @dataclasses.dataclass(frozen=True, kw_only=True)
@@ -52,12 +51,6 @@ class _Report:
     target_power: Power | None
     """The currently set power for the components."""
 
-    distribution_result: power_distributing.Result | None
-    """The result of the last power distribution.
-
-    This is `None` if no power distribution has been performed yet.
-    """
-
     _inclusion_bounds: timeseries.Bounds[Power] | None
     """The available inclusion bounds for the components, for the actor's priority.
 
@@ -266,15 +259,13 @@ def get_status(
         component_ids: frozenset[int],
         priority: int,
         system_bounds: SystemBounds,
-        distribution_result: power_distributing.Result | None,
     ) -> _Report:
         """Get the bounds for a set of components, for the given priority.
 
         Args:
             component_ids: The IDs of the components to get the bounds for.
             priority: The priority of the actor for which the bounds are requested.
             system_bounds: The system bounds for the components.
-            distribution_result: The result of the last power distribution.
 
         Returns:
             The bounds for the components.

src/frequenz/sdk/actor/_power_managing/_matryoshka.py

@@ -32,7 +32,6 @@
 
 if typing.TYPE_CHECKING:
     from ...timeseries._base_types import SystemBounds
-    from .. import power_distributing
 
 _logger = logging.getLogger(__name__)
 
@@ -225,15 +224,13 @@ def get_status(
         component_ids: frozenset[int],
         priority: int,
         system_bounds: SystemBounds,
-        distribution_result: power_distributing.Result | None,
     ) -> _Report:
         """Get the bounds for the algorithm.
 
         Args:
             component_ids: The IDs of the components to get the bounds for.
             priority: The priority of the actor for which the bounds are requested.
             system_bounds: The system bounds for the components.
-            distribution_result: The result of the last power distribution.
 
         Returns:
             The target power and the available bounds for the given components, for
@@ -245,7 +242,6 @@ def get_status(
                 target_power=target_power,
                 _inclusion_bounds=None,
                 _exclusion_bounds=system_bounds.exclusion_bounds,
-                distribution_result=distribution_result,
             )
 
         lower_bound = system_bounds.inclusion_bounds.lower
@@ -284,7 +280,6 @@ def get_status(
                 lower=lower_bound, upper=upper_bound
             ),
             _exclusion_bounds=system_bounds.exclusion_bounds,
-            distribution_result=distribution_result,
         )
 
     @override

src/frequenz/sdk/actor/_power_managing/_power_managing_actor.py

@@ -91,7 +91,6 @@ def __init__(  # pylint: disable=too-many-arguments
         self._set_op_power_subscriptions: dict[
             frozenset[int], dict[int, Sender[_Report]]
         ] = {}
-        self._distribution_results: dict[frozenset[int], power_distributing.Result] = {}
 
         self._set_power_group: BaseAlgorithm = Matryoshka(
             max_proposal_age=timedelta(seconds=60.0)
@@ -120,7 +119,6 @@ async def _send_reports(self, component_ids: frozenset[int]) -> None:
                 component_ids,
                 priority,
                 bounds,
-                self._distribution_results.get(component_ids),
             )
             await sender.send(status)
         for priority, sender in self._set_power_subscriptions.get(
@@ -133,7 +131,6 @@ async def _send_reports(self, component_ids: frozenset[int]) -> None:
                     bounds,
                     self._set_op_power_group.get_target_power(component_ids),
                 ),
-                self._distribution_results.get(component_ids),
             )
             await sender.send(status)
 
@@ -403,9 +400,6 @@ async def _run(self) -> None:
                 )
 
                 result = selected.message
-                self._distribution_results[frozenset(result.request.component_ids)] = (
-                    result
-                )
                 if not isinstance(result, power_distributing.Success):
                     _logger.warning(
                         "PowerManagingActor: PowerDistributing failed: %s", result

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

@@ -6,7 +6,6 @@
 import abc
 import typing
 
-from ...actor import power_distributing
 from .._base_types import Bounds
 from .._quantities import Power
 
@@ -20,13 +19,6 @@ class BatteryPoolReport(typing.Protocol):
     def target_power(self) -> Power | None:
         """The currently set power for the batteries."""
 
-    @property
-    def distribution_result(self) -> power_distributing.Result | None:
-        """The result of the last power distribution.
-
-        This is `None` if no power distribution has been performed yet.
-        """
-
     @property
     def bounds(self) -> Bounds[Power] | None:
         """The usable bounds for the batteries.

src/frequenz/sdk/timeseries/ev_charger_pool/_result_types.py

@@ -5,7 +5,6 @@
 
 import typing
 
-from ...actor import power_distributing
 from .._base_types import Bounds
 from .._quantities import Power
 
@@ -17,13 +16,6 @@ class EVChargerPoolReport(typing.Protocol):
     def target_power(self) -> Power | None:
         """The currently set power for the EV chargers."""
 
-    @property
-    def distribution_result(self) -> power_distributing.Result | None:
-        """The result of the last power distribution.
-
-        This is `None` if no power distribution has been performed yet.
-        """
-
     @property
     def bounds(self) -> Bounds[Power] | None:
         """The usable bounds for the EV chargers.

src/frequenz/sdk/timeseries/pv_pool/_result_types.py

@@ -5,7 +5,6 @@
 
 import typing
 
-from ...actor import power_distributing
 from .._base_types import Bounds
 from .._quantities import Power
 
@@ -17,13 +16,6 @@ class PVPoolReport(typing.Protocol):
     def target_power(self) -> Power | None:
         """The currently set power for the PV inverters."""
 
-    @property
-    def distribution_result(self) -> power_distributing.Result | None:
-        """The result of the last power distribution.
-
-        This is `None` if no power distribution has been performed yet.
-        """
-
     @property
     def bounds(self) -> Bounds[Power] | None:
         """The usable bounds for the PV inverters.

tests/actor/_power_managing/test_matryoshka.py

@@ -70,7 +70,7 @@ def bounds(
     ) -> None:
         """Test the status report."""
         report = self.algorithm.get_status(
-            self._batteries, priority, self._system_bounds, None
+            self._batteries, priority, self._system_bounds
         )
         if expected_power is None:
             assert report.target_power is None

tests/actor/_power_managing/test_report.py

@@ -34,7 +34,6 @@ def __init__(
                 if exclusion_bounds is not None
                 else None
             ),
-            distribution_result=None,
         )
 
     def case(