Replace Bounds classes in BatteryPool/PowerManager with a single one

The new `Bounds` class is generic over quantities, and is defined in
the `frequenz.sdk.timeseries` package.

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

Author: shsms

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

@@ -3,12 +3,11 @@
 
 """A power manager implementation."""
 
-from ._base_classes import Algorithm, Bounds, Proposal, Report, ReportRequest
+from ._base_classes import Algorithm, Proposal, Report, ReportRequest
 from ._power_managing_actor import PowerManagingActor
 
 __all__ = [
     "Algorithm",
-    "Bounds",
     "PowerManagingActor",
     "Proposal",
     "Report",

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

@@ -11,6 +11,7 @@
 import enum
 import typing
 
+from ... import timeseries
 from ...timeseries import Power
 
 if typing.TYPE_CHECKING:
@@ -40,25 +41,14 @@ def get_channel_name(self) -> str:
         return f"power_manager.report.{self.battery_ids=}.{self.priority=}"
 
 
-@dataclasses.dataclass(frozen=True)
-class Bounds:
-    """Lower and upper bound values."""
-
-    lower: Power
-    """Lower bound."""
-
-    upper: Power
-    """Upper bound."""
-
-
 @dataclasses.dataclass(frozen=True)
 class Report:
     """Current PowerManager report for a set of batteries."""
 
     target_power: Power | None
     """The currently set power for the batteries."""
 
-    inclusion_bounds: Bounds | None
+    inclusion_bounds: timeseries.Bounds[Power] | None
     """The available inclusion bounds for the batteries, for the actor's priority.
 
     These bounds are adjusted to any restrictions placed by actors with higher

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

@@ -10,8 +10,9 @@
 
 from typing_extensions import override
 
+from ... import timeseries
 from ...timeseries import Power
-from ._base_classes import BaseAlgorithm, Bounds, Proposal, Report
+from ._base_classes import BaseAlgorithm, Proposal, Report
 from ._sorted_set import SortedSet
 
 if typing.TYPE_CHECKING:
@@ -173,5 +174,7 @@ def get_status(
 
         return Report(
             target_power,
-            inclusion_bounds=Bounds(lower=lower_bound, upper=upper_bound),
+            inclusion_bounds=timeseries.Bounds[Power](
+                lower=lower_bound, upper=upper_bound
+            ),
         )

src/frequenz/sdk/timeseries/__init__.py

@@ -35,7 +35,7 @@
     ```
 """
 
-from ._base_types import UNIX_EPOCH, Sample, Sample3Phase
+from ._base_types import UNIX_EPOCH, Bounds, Sample, Sample3Phase
 from ._moving_window import MovingWindow
 from ._periodic_feature_extractor import PeriodicFeatureExtractor
 from ._quantities import (
@@ -51,6 +51,7 @@
 from ._resampling import ResamplerConfig
 
 __all__ = [
+    "Bounds",
     "MovingWindow",
     "PeriodicFeatureExtractor",
     "ResamplerConfig",

src/frequenz/sdk/timeseries/_base_types.py

@@ -135,3 +135,14 @@ def map(
             value_p2=default if self.value_p2 is None else function(self.value_p2),
             value_p3=default if self.value_p3 is None else function(self.value_p3),
         )
+
+
+@dataclass(frozen=True)
+class Bounds(Generic[QuantityT]):
+    """Lower and upper bound values."""
+
+    lower: QuantityT
+    """Lower bound."""
+
+    upper: QuantityT
+    """Upper bound."""

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

@@ -3,11 +3,10 @@
 
 """Manage a pool of batteries."""
 
-from ._result_types import Bounds, PowerMetrics
+from ._result_types import PowerMetrics
 from .battery_pool import BatteryPool
 
 __all__ = [
     "BatteryPool",
     "PowerMetrics",
-    "Bounds",
 ]

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

@@ -10,12 +10,13 @@
 from datetime import datetime, timezone
 from typing import Generic, TypeVar
 
+from ... import timeseries
 from ...microgrid import connection_manager
 from ...microgrid.component import ComponentCategory, ComponentMetricId, InverterType
 from ...timeseries import Sample
 from .._quantities import Energy, Percentage, Power, Temperature
 from ._component_metrics import ComponentMetricsData
-from ._result_types import Bounds, PowerMetrics
+from ._result_types import PowerMetrics
 
 _logger = logging.getLogger(__name__)
 
@@ -653,11 +654,11 @@ def calculate(
 
         return PowerMetrics(
             timestamp=timestamp,
-            inclusion_bounds=Bounds(
+            inclusion_bounds=timeseries.Bounds(
                 Power.from_watts(inclusion_bounds_lower),
                 Power.from_watts(inclusion_bounds_upper),
             ),
-            exclusion_bounds=Bounds(
+            exclusion_bounds=timeseries.Bounds(
                 Power.from_watts(exclusion_bounds_lower),
                 Power.from_watts(exclusion_bounds_upper),
             ),

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

@@ -6,20 +6,10 @@
 from dataclasses import dataclass, field
 from datetime import datetime
 
+from .. import _base_types
 from .._quantities import Power
 
 
-@dataclass
-class Bounds:
-    """Lower and upper bound values."""
-
-    lower: Power
-    """Lower bound."""
-
-    upper: Power
-    """Upper bound."""
-
-
 @dataclass
 class PowerMetrics:
     """Power bounds metrics."""
@@ -29,7 +19,7 @@ class PowerMetrics:
     """Timestamp of the metrics."""
 
     # pylint: disable=line-too-long
-    inclusion_bounds: Bounds | None
+    inclusion_bounds: _base_types.Bounds[Power] | None
     """Inclusion power bounds for all batteries in the battery pool instance.
 
     This is the range within which power requests are allowed by the battery pool.
@@ -42,7 +32,7 @@ class PowerMetrics:
     details.
     """
 
-    exclusion_bounds: Bounds | None
+    exclusion_bounds: _base_types.Bounds[Power] | None
     """Exclusion power bounds for all batteries in the battery pool instance.
 
     This is the range within which power requests are NOT allowed by the battery pool.

tests/actor/_power_managing/test_matryoshka.py

@@ -5,6 +5,7 @@
 
 from datetime import datetime, timezone
 
+from frequenz.sdk import timeseries
 from frequenz.sdk.actor._power_managing import Proposal
 from frequenz.sdk.actor._power_managing._matryoshka import Matryoshka
 from frequenz.sdk.timeseries import Power, battery_pool
@@ -17,10 +18,10 @@ async def test_matryoshka_algorithm() -> None:  # pylint: disable=too-many-state
     algorithm = Matryoshka()
     system_bounds = battery_pool.PowerMetrics(
         timestamp=datetime.now(tz=timezone.utc),
-        inclusion_bounds=battery_pool.Bounds(
+        inclusion_bounds=timeseries.Bounds(
             lower=Power.from_watts(-200.0), upper=Power.from_watts(200.0)
         ),
-        exclusion_bounds=battery_pool.Bounds(lower=Power.zero(), upper=Power.zero()),
+        exclusion_bounds=timeseries.Bounds(lower=Power.zero(), upper=Power.zero()),
     )
 
     call_count = 0

tests/timeseries/_battery_pool/test_battery_pool.py

@@ -28,8 +28,15 @@
 from frequenz.sdk.actor import ResamplerConfig
 from frequenz.sdk.actor.power_distributing import BatteryStatus
 from frequenz.sdk.microgrid.component import ComponentCategory
-from frequenz.sdk.timeseries import Energy, Percentage, Power, Sample, Temperature
-from frequenz.sdk.timeseries.battery_pool import BatteryPool, Bounds, PowerMetrics
+from frequenz.sdk.timeseries import (
+    Bounds,
+    Energy,
+    Percentage,
+    Power,
+    Sample,
+    Temperature,
+)
+from frequenz.sdk.timeseries.battery_pool import BatteryPool, PowerMetrics
 from frequenz.sdk.timeseries.battery_pool._metric_calculator import (
     battery_inverter_mapping,
 )