Expose ComponentGraph from its own module (#738)

The `ComponentGraph` is a (relatively) low-level interface, but was
exposed as a member of the `frequenz.sdk.microgrid` package, and was
available from the documentation of the `microgrid` package.

Moving it to its own package cleans up the docs page, showing just the
high level functions like `initialize`, `logical_meter`,
`battery_pool`, etc. as members of the `microgrid` package.

Author: shsms

RELEASE_NOTES.md

@@ -23,6 +23,8 @@ This version ships an experimental version of the **Power Manager**, adds prelim
     + the latest target power for the set of batteries
     + the results from the power distributor for the last request
 
+- Move `microgrid.ComponentGraph` class to `microgrid.component_graph.ComponentGraph`, exposing only the high level interface functions through the `microgrid` package.
+
 ## New Features
 
 - New and improved documentation.

src/frequenz/sdk/microgrid/__init__.py

@@ -125,7 +125,6 @@
 from ..actor import ResamplerConfig
 from . import _data_pipeline, client, component, connection_manager, fuse, grid
 from ._data_pipeline import battery_pool, ev_charger_pool, frequency, logical_meter
-from ._graph import ComponentGraph
 
 
 async def initialize(host: str, port: int, resampler_config: ResamplerConfig) -> None:
@@ -146,7 +145,6 @@ async def initialize(host: str, port: int, resampler_config: ResamplerConfig) ->
 
 
 __all__ = [
-    "ComponentGraph",
     "initialize",
     "client",
     "component",

src/frequenz/sdk/microgrid/_graph.py …requenz/sdk/microgrid/component_graph.pysrc/frequenz/sdk/microgrid/_graph.py renamed to src/frequenz/sdk/microgrid/component_graph.py src/frequenz/sdk/microgrid/_graph.py renamed to src/frequenz/sdk/microgrid/component_graph.py

@@ -13,9 +13,9 @@
 
 import grpc.aio as grpcaio
 
-from ._graph import ComponentGraph, _MicrogridComponentGraph
 from .client import MicrogridApiClient
 from .client._client import MicrogridGrpcClient
+from .component_graph import ComponentGraph, _MicrogridComponentGraph
 
 # Not public default host and port
 _DEFAULT_MICROGRID_HOST = "[::1]"

src/frequenz/sdk/microgrid/connection_manager.py

@@ -13,7 +13,7 @@
 import grpc
 import pytest
 
-import frequenz.sdk.microgrid._graph as gr
+import frequenz.sdk.microgrid.component_graph as gr
 from frequenz.sdk.microgrid.client import Connection, MicrogridGrpcClient
 from frequenz.sdk.microgrid.component import (
     Component,

tests/microgrid/test_graph.py

@@ -15,7 +15,6 @@
 from frequenz.sdk._internal._asyncio import cancel_and_await
 from frequenz.sdk.actor import ResamplerConfig
 from frequenz.sdk.microgrid import _data_pipeline
-from frequenz.sdk.microgrid._graph import _MicrogridComponentGraph
 from frequenz.sdk.microgrid.client import Connection
 from frequenz.sdk.microgrid.component import (
     Component,
@@ -25,6 +24,7 @@
     EVChargerComponentState,
     InverterType,
 )
+from frequenz.sdk.microgrid.component_graph import _MicrogridComponentGraph
 
 from ..utils import MockMicrogridClient
 from ..utils.component_data_wrapper import (

tests/timeseries/mock_microgrid.py

@@ -6,10 +6,10 @@
 from dataclasses import replace
 from typing import Any, overload
 
-from frequenz.sdk.microgrid._graph import _MicrogridComponentGraph
 from frequenz.sdk.microgrid.client import Connection
 from frequenz.sdk.microgrid.component import Component, ComponentCategory, InverterType
 from frequenz.sdk.microgrid.component._component import ComponentType
+from frequenz.sdk.microgrid.component_graph import _MicrogridComponentGraph
 
 
 class GraphGenerator:

tests/utils/graph_generator.py

@@ -11,7 +11,6 @@
 from pytest_mock import MockerFixture
 
 from frequenz.sdk._internal._constants import RECEIVER_MAX_SIZE
-from frequenz.sdk.microgrid._graph import ComponentGraph, _MicrogridComponentGraph
 from frequenz.sdk.microgrid.client import Connection
 from frequenz.sdk.microgrid.component import (
     BatteryData,
@@ -22,6 +21,10 @@
     InverterData,
     MeterData,
 )
+from frequenz.sdk.microgrid.component_graph import (
+    ComponentGraph,
+    _MicrogridComponentGraph,
+)
 from frequenz.sdk.microgrid.connection_manager import ConnectionManager