Rename Algorithm to PowerManagerAlgorithm

This makes it easier to expose publicly.

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

Author: shsms

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -20,13 +20,12 @@
 from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid.component import Battery, EvCharger, SolarInverter
 
-from frequenz.sdk.microgrid._power_managing._base_classes import Algorithm, DefaultPower
-
 from .._internal._channels import ChannelRegistry
 from ..actor._actor import Actor
 from ..timeseries import ResamplerConfig
 from ..timeseries._voltage_streamer import VoltageStreamer
 from ._data_sourcing import ComponentMetricRequest, DataSourcingActor
+from ._power_managing._base_classes import DefaultPower, PowerManagerAlgorithm
 from ._power_wrapper import PowerWrapper
 
 # A number of imports had to be done inside functions where they are used, to break
@@ -104,21 +103,21 @@ def __init__(
         self._battery_power_wrapper = PowerWrapper(
             self._channel_registry,
             api_power_request_timeout=api_power_request_timeout,
-            power_manager_algorithm=Algorithm.SHIFTING_MATRYOSHKA,
+            power_manager_algorithm=PowerManagerAlgorithm.SHIFTING_MATRYOSHKA,
             default_power=DefaultPower.ZERO,
             component_class=Battery,
         )
         self._ev_power_wrapper = PowerWrapper(
             self._channel_registry,
             api_power_request_timeout=api_power_request_timeout,
-            power_manager_algorithm=Algorithm.MATRYOSHKA,
+            power_manager_algorithm=PowerManagerAlgorithm.MATRYOSHKA,
             default_power=DefaultPower.MAX,
             component_class=EvCharger,
         )
         self._pv_power_wrapper = PowerWrapper(
             self._channel_registry,
             api_power_request_timeout=api_power_request_timeout,
-            power_manager_algorithm=Algorithm.MATRYOSHKA,
+            power_manager_algorithm=PowerManagerAlgorithm.MATRYOSHKA,
             default_power=DefaultPower.MIN,
             # Using SolarInverter might be too specific, maybe we need to also pass
             # HybridInverter, see

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

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

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

@@ -213,7 +213,7 @@ class DefaultPower(enum.Enum):
     """The default power is the maximum power of the component."""
 
 
-class Algorithm(enum.Enum):
+class PowerManagerAlgorithm(enum.Enum):
     """The available algorithms for the power manager."""
 
     MATRYOSHKA = "matryoshka"

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

@@ -23,9 +23,9 @@
 from ...timeseries._base_types import SystemBounds
 from .. import _data_pipeline, _power_distributing
 from ._base_classes import (
-    Algorithm,
     BaseAlgorithm,
     DefaultPower,
+    PowerManagerAlgorithm,
     Proposal,
     ReportRequest,
     _Report,
@@ -47,7 +47,7 @@ def __init__(  # pylint: disable=too-many-arguments
         power_distributing_requests_sender: Sender[_power_distributing.Request],
         power_distributing_results_receiver: Receiver[_power_distributing.Result],
         channel_registry: ChannelRegistry,
-        algorithm: Algorithm,
+        algorithm: PowerManagerAlgorithm,
         default_power: DefaultPower,
         component_class: type[Battery | EvCharger | SolarInverter],
     ):
@@ -80,12 +80,12 @@ def __init__(  # pylint: disable=too-many-arguments
         ] = {}
 
         match algorithm:
-            case Algorithm.MATRYOSHKA:
+            case PowerManagerAlgorithm.MATRYOSHKA:
                 self._algorithm: BaseAlgorithm = Matryoshka(
                     max_proposal_age=timedelta(seconds=60.0),
                     default_power=default_power,
                 )
-            case Algorithm.SHIFTING_MATRYOSHKA:
+            case PowerManagerAlgorithm.SHIFTING_MATRYOSHKA:
                 self._algorithm = ShiftingMatryoshka(
                     max_proposal_age=timedelta(seconds=60.0),
                     default_power=default_power,

src/frequenz/sdk/microgrid/_power_wrapper.py

@@ -25,7 +25,7 @@
     Request,
     Result,
 )
-from ._power_managing._base_classes import Algorithm, DefaultPower
+from ._power_managing._base_classes import DefaultPower, PowerManagerAlgorithm
 
 _logger = logging.getLogger(__name__)
 
@@ -38,7 +38,7 @@ def __init__(  # pylint: disable=too-many-arguments
         channel_registry: ChannelRegistry,
         *,
         api_power_request_timeout: timedelta,
-        power_manager_algorithm: Algorithm,
+        power_manager_algorithm: PowerManagerAlgorithm,
         default_power: DefaultPower,
         component_class: type[Battery | EvCharger | SolarInverter],
     ):