Move PowerDistributing file to separate module

Signed-off-by: ela-kotulska-frequenz <[email protected]>

Author: ela-kotulska-frequenz

src/frequenz/sdk/actor/__init__.py

@@ -3,7 +3,6 @@
 
 """A base class for creating simple composable actors."""
 
-from . import power_distributing
 from ._channel_registry import ChannelRegistry
 from ._config_managing import ConfigManagingActor
 from ._data_sourcing import ComponentMetricRequest, DataSourcingActor
@@ -17,5 +16,4 @@
     "ConfigManagingActor",
     "DataSourcingActor",
     "actor",
-    "power_distributing",
 ]

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

@@ -0,0 +1,15 @@
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
+
+"""This module provides feature to set power between many batteries.
+
+Distributing power is very important to keep the microgrid ready
+for the power requirements.
+This module provides PowerDistributingActor that knows how to distribute power.
+It also provides all the secondary features that should be used to communicate with
+PowerDistributingActor and send requests for charging or discharging power.
+"""
+
+from .power_distributing import PowerDistributingActor, Request, Result
+
+__all__ = ["PowerDistributingActor", "Request", "Result"]

…frequenz/sdk/actor/power_distributing.py …power_distributing/power_distributing.pysrc/frequenz/sdk/actor/power_distributing.py renamed to src/frequenz/sdk/actor/power_distributing/power_distributing.py src/frequenz/sdk/actor/power_distributing.py renamed to src/frequenz/sdk/actor/power_distributing/power_distributing.py

@@ -34,16 +34,16 @@
 from frequenz.channels import Bidirectional, Peekable, Receiver
 from google.protobuf.empty_pb2 import Empty  # pylint: disable=no-name-in-module
 
-from ..actor._decorator import actor
-from ..microgrid import ComponentGraph
-from ..microgrid.client import MicrogridApiClient
-from ..microgrid.component import (
+from ...actor._decorator import actor
+from ...microgrid import ComponentGraph
+from ...microgrid.client import MicrogridApiClient
+from ...microgrid.component import (
     BatteryData,
     Component,
     ComponentCategory,
     InverterData,
 )
-from ..power import DistributionAlgorithm, InvBatPair
+from ...power import DistributionAlgorithm, InvBatPair
 
 _logger = logging.getLogger(__name__)
 

tests/actor/test_power_distributing.py

@@ -19,8 +19,8 @@
     PowerDistributingActor,
     Request,
     Result,
-    _BrokenComponents,
 )
+from frequenz.sdk.actor.power_distributing.power_distributing import _BrokenComponents
 from frequenz.sdk.microgrid._graph import _MicrogridComponentGraph
 from frequenz.sdk.microgrid.client import Connection
 from frequenz.sdk.microgrid.component import (
@@ -751,7 +751,9 @@ def test_broken_components(self, mocker: MockerFixture) -> None:
         Args:
             mocker: pytest mocker
         """
-        datetime_mock = mocker.patch("frequenz.sdk.actor.power_distributing.datetime")
+        datetime_mock = mocker.patch(
+            "frequenz.sdk.actor.power_distributing.power_distributing.datetime"
+        )
 
         expected_datetime = [
             datetime.fromisoformat("2001-01-01T00:00:00+00:00"),