Cleanup frequenz.sdk.microgrid

The module `frequenz.sdk.microgrid` was restructured so:

* All component-related symbols (`.component`, `.component_data`,
  `.component_states`) were moved to the sub-module
  `frequenz.sdk.microgrid.component`.

* All API client-related symbols (`.client`, `.connection`, `.retry`)
  were moved to the sub-module `frequenz.sdk.microgrid.client`.

* The `ComponentGraph` is exposed directly in the main module (and only
  there).

* The `microgrid_api` module is now exposed via the main module directly
  (and thus indirectly renamed to `microgrid`, so instead of using `from
  frequenz.sdk.microgrid import microgrid_api;
  microgrid_api.initialize()` (for example) you should use `from
  frequenz.sdk.microgrid import microgridi; microgrid.initialize()`.

* The `MicrogridApi` class was renamed to `Microgrid` to make it clear
  it is not exclusively about the API.

* The `Microgrid.microgrid_api_client` attribute was renamed to
  `Microgrid.api_client` to avoid the redundancy.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

benchmarks/data_ingestion/benchmark_microgrid_data.py

@@ -21,14 +21,18 @@
 from frequenz.channels.util import MergeNamed, Select
 from google.protobuf.timestamp_pb2 import Timestamp  # pylint:disable=no-name-in-module
 
-import frequenz.sdk.microgrid.graph as gr
+import frequenz.sdk.microgrid._graph as gr
 from frequenz.sdk._data_handling.time_series import TimeSeriesEntry, TimeSeriesFormula
 from frequenz.sdk._data_ingestion.formula_calculator import FormulaCalculator
 from frequenz.sdk._data_ingestion.microgrid_data import MicrogridData
-from frequenz.sdk.microgrid import BatteryData, InverterData, MeterData
-from frequenz.sdk.microgrid.client import MicrogridGrpcClient
-from frequenz.sdk.microgrid.component import Component, ComponentCategory
-from frequenz.sdk.microgrid.connection import Connection
+from frequenz.sdk.microgrid.client import Connection, MicrogridGrpcClient
+from frequenz.sdk.microgrid.component import (
+    BatteryData,
+    Component,
+    ComponentCategory,
+    InverterData,
+    MeterData,
+)
 
 
 def gen_market_data(component_id: int) -> MeterData:

benchmarks/power_distribution/power_distributor.py

@@ -18,9 +18,10 @@
     Request,
     Result,
 )
+from frequenz.sdk.microgrid import ComponentGraph
+from frequenz.sdk.microgrid._graph import _MicrogridComponentGraph
 from frequenz.sdk.microgrid.client import MicrogridApiClient, MicrogridGrpcClient
 from frequenz.sdk.microgrid.component import Component, ComponentCategory
-from frequenz.sdk.microgrid.graph import ComponentGraph, _MicrogridComponentGraph
 
 HOST = "157.90.243.180"
 PORT = 61060

examples/sdk_resampling_example.py

@@ -8,21 +8,22 @@
 from frequenz.channels import Broadcast
 from frequenz.channels.util import MergeNamed
 
+from frequenz.sdk import microgrid
 from frequenz.sdk.actor import (
     ChannelRegistry,
     ComponentMetricRequest,
     ComponentMetricsResamplingActor,
     DataSourcingActor,
 )
-from frequenz.sdk.microgrid import ComponentCategory, ComponentMetricId, microgrid_api
+from frequenz.sdk.microgrid.component import ComponentCategory, ComponentMetricId
 
 HOST = "microgrid.sandbox.api.frequenz.io"
 PORT = 61060
 
 
 async def run() -> None:  # pylint: disable=too-many-locals
     """Run main functions that initializes and creates everything."""
-    await microgrid_api.initialize(HOST, PORT)
+    await microgrid.initialize(HOST, PORT)
 
     channel_registry = ChannelRegistry(name="Microgrid Channel Registry")
 
@@ -52,7 +53,7 @@ async def run() -> None:  # pylint: disable=too-many-locals
         resampling_period_s=1.0,
     )
 
-    components = await microgrid_api.get().microgrid_api_client.components()
+    components = await microgrid.get().api_client.components()
     battery_ids = [
         comp.component_id
         for comp in components

examples/sdk_usage_example.py

@@ -18,6 +18,7 @@
 
 from frequenz.channels import Bidirectional, Broadcast, Receiver, Sender
 
+from frequenz.sdk import microgrid
 from frequenz.sdk._data_handling import TimeSeriesEntry
 from frequenz.sdk._data_ingestion import MicrogridData
 from frequenz.sdk._data_ingestion.formula_calculator import FormulaCalculator
@@ -27,12 +28,7 @@
     Request,
     Result,
 )
-from frequenz.sdk.microgrid import (
-    Component,
-    ComponentCategory,
-    MicrogridApi,
-    microgrid_api,
-)
+from frequenz.sdk.microgrid.component import Component, ComponentCategory
 
 _logger = logging.getLogger(__name__)
 HOST = "microgrid.sandbox.api.frequenz.io"  # it should be the host name.
@@ -157,10 +153,9 @@ async def run() -> None:
     logging.basicConfig(
         level=logging.DEBUG, format="%(asctime)s %(name)s %(levelname)s:%(message)s"
     )
-    await microgrid_api.initialize(HOST, PORT)
+    await microgrid.initialize(HOST, PORT)
 
     # await initialize(HOST, PORT) # in v0.8.0
-    api: MicrogridApi = microgrid_api.get()
 
     # Create MicrogridData
     microgrid_data_channels = {
@@ -169,11 +164,11 @@ async def run() -> None:
         ),
     }
 
-    formula_calculator = FormulaCalculator(api.component_graph)
+    formula_calculator = FormulaCalculator(microgrid.get().component_graph)
     microgrid_data = MicrogridData(
-        microgrid_client=api.microgrid_api_client,
+        microgrid_client=microgrid.get().api_client,
         # microgrid_client=microgrid_api.microgrid_api,  # in v0.8.0
-        component_graph=api.component_graph,
+        component_graph=microgrid.get().component_graph,
         outputs={
             key: channel.new_sender()
             for key, channel in microgrid_data_channels.items()
@@ -190,9 +185,9 @@ async def run() -> None:
     }
 
     power_distributor = PowerDistributingActor(
-        microgrid_api=api.microgrid_api_client,
+        microgrid_api=microgrid.get().api_client,
         # microgrid_api=microgrid_api.microgrid_api, in v0.8.0
-        component_graph=api.component_graph,
+        component_graph=microgrid.get().component_graph,
         users_channels={
             key: channel.service_handle
             for key, channel in power_distributor_channels.items()
@@ -204,7 +199,7 @@ async def run() -> None:
 
     # You should get components from ComponentGraph, not from the api.
     # It is faster and and non blocking approach.
-    batteries: Set[Component] = api.component_graph.components(
+    batteries: Set[Component] = microgrid.get().component_graph.components(
         # component_type=set(ComponentType.BATTERY) in v0.8.0
         component_category={ComponentCategory.BATTERY}
     )

src/frequenz/sdk/_data_ingestion/component_info.py

@@ -7,8 +7,8 @@
 from dataclasses import dataclass
 from typing import Dict, List, Optional, Tuple
 
+from ..microgrid import ComponentGraph
 from ..microgrid.component import ComponentCategory
-from ..microgrid.graph import ComponentGraph
 
 logger = logging.Logger(__name__)
 

src/frequenz/sdk/_data_ingestion/formula_calculator.py

@@ -22,7 +22,8 @@
     TimeSeriesEntry,
     TimeSeriesFormula,
 )
-from ..microgrid import ComponentCategory, ComponentGraph
+from ..microgrid import ComponentGraph
+from ..microgrid.component import ComponentCategory
 from .component_info import infer_microgrid_config
 from .constants import (
     METRIC_BATTERIES_ACTIVE_POWER,

src/frequenz/sdk/_data_ingestion/gen_component_receivers.py

@@ -9,9 +9,9 @@
 from frequenz.channels.util import Merge
 
 from ..microgrid import client
-from ..microgrid.component import ComponentCategory
-from ..microgrid.component_data import (
+from ..microgrid.component import (
     BatteryData,
+    ComponentCategory,
     EVChargerData,
     InverterData,
     MeterData,

src/frequenz/sdk/_data_ingestion/microgrid_data.py

@@ -21,8 +21,8 @@
 from .._data_handling.time_series import TimeSeriesEntry
 from ..actor import actor
 from ..config import Config
+from ..microgrid import ComponentGraph
 from ..microgrid.client import MicrogridApiClient
-from ..microgrid.graph import ComponentGraph
 from .component_info import infer_microgrid_config
 from .formula_calculator import FormulaCalculator
 from .gen_component_receivers import gen_component_receivers

src/frequenz/sdk/actor/_data_sourcing/microgrid_api_source.py

@@ -11,14 +11,14 @@
 
 from frequenz.channels import Receiver, Sender
 
-from ...microgrid import (
+from ... import microgrid
+from ...microgrid.component import (
     BatteryData,
     ComponentCategory,
     ComponentMetricId,
     EVChargerData,
     InverterData,
     MeterData,
-    microgrid_api,
 )
 from ...timeseries import Sample
 from .._channel_registry import ChannelRegistry
@@ -138,7 +138,7 @@ async def _get_component_category(
         if comp_id in self._comp_categories_cache:
             return self._comp_categories_cache[comp_id]
 
-        api = microgrid_api.get().microgrid_api_client
+        api = microgrid.get().api_client
         for comp in await api.components():
             self._comp_categories_cache[comp.component_id] = comp.category
 
@@ -168,7 +168,7 @@ async def _check_battery_request(
         if comp_id not in self.comp_data_receivers:
             self.comp_data_receivers[
                 comp_id
-            ] = await microgrid_api.get().microgrid_api_client.battery_data(comp_id)
+            ] = await microgrid.get().api_client.battery_data(comp_id)
 
     async def _check_ev_charger_request(
         self,
@@ -191,7 +191,7 @@ async def _check_ev_charger_request(
         if comp_id not in self.comp_data_receivers:
             self.comp_data_receivers[
                 comp_id
-            ] = await microgrid_api.get().microgrid_api_client.ev_charger_data(comp_id)
+            ] = await microgrid.get().api_client.ev_charger_data(comp_id)
 
     async def _check_inverter_request(
         self,
@@ -214,7 +214,7 @@ async def _check_inverter_request(
         if comp_id not in self.comp_data_receivers:
             self.comp_data_receivers[
                 comp_id
-            ] = await microgrid_api.get().microgrid_api_client.inverter_data(comp_id)
+            ] = await microgrid.get().api_client.inverter_data(comp_id)
 
     async def _check_meter_request(
         self,
@@ -237,7 +237,7 @@ async def _check_meter_request(
         if comp_id not in self.comp_data_receivers:
             self.comp_data_receivers[
                 comp_id
-            ] = await microgrid_api.get().microgrid_api_client.meter_data(comp_id)
+            ] = await microgrid.get().api_client.meter_data(comp_id)
 
     async def _check_requested_component_and_metrics(
         self,

src/frequenz/sdk/actor/power_distributing.py

@@ -35,10 +35,14 @@
 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 Component, ComponentCategory
-from ..microgrid.component_data import BatteryData, InverterData
-from ..microgrid.graph import ComponentGraph
+from ..microgrid.component import (
+    BatteryData,
+    Component,
+    ComponentCategory,
+    InverterData,
+)
 from ..power import DistributionAlgorithm, InvBatPair
 
 _logger = logging.getLogger(__name__)