Move the data sourcing actor to the microgrid module

shsms · shsms · commit 8cc765f1b058 · 2024-08-12T10:26:41.000+02:00
Signed-off-by: Sahas Subramanian &lt;sahas.subramanian@proton.me&gt;
diff --git a/benchmarks/timeseries/benchmark_datasourcing.py b/benchmarks/timeseries/benchmark_datasourcing.py
@@ -21,7 +21,10 @@
 
 from frequenz.sdk import microgrid
 from frequenz.sdk._internal._channels import ChannelRegistry
-from frequenz.sdk.actor import ComponentMetricRequest, DataSourcingActor
+from frequenz.sdk.microgrid._data_sourcing import (
+    ComponentMetricRequest,
+    DataSourcingActor,
+)
 
 try:
     from tests.timeseries.mock_microgrid import MockMicrogrid
diff --git a/src/frequenz/sdk/actor/__init__.py b/src/frequenz/sdk/actor/__init__.py
@@ -599,15 +599,11 @@ async def main() -> None:  # (6)!
 from ..timeseries._resampling import ResamplerConfig
 from ._actor import Actor
 from ._background_service import BackgroundService
-from ._data_sourcing import ComponentMetricId, ComponentMetricRequest, DataSourcingActor
 from ._run_utils import run
 
 __all__ = [
     "Actor",
     "BackgroundService",
-    "ComponentMetricId",
-    "ComponentMetricRequest",
-    "DataSourcingActor",
     "ResamplerConfig",
     "run",
 ]
diff --git a/src/frequenz/sdk/microgrid/_data_pipeline.py b/src/frequenz/sdk/microgrid/_data_pipeline.py
@@ -21,19 +21,20 @@
 
 from .._internal._channels import ChannelRegistry
 from ..actor._actor import Actor
+from ..timeseries import ResamplerConfig
 from ..timeseries._grid_frequency import GridFrequency
 from ..timeseries._voltage_streamer import VoltageStreamer
 from ..timeseries.grid import Grid
 from ..timeseries.grid import get as get_grid
 from ..timeseries.grid import initialize as initialize_grid
+from ._data_sourcing import ComponentMetricRequest, DataSourcingActor
 from ._power_wrapper import PowerWrapper
 
 # A number of imports had to be done inside functions where they are used, to break
 # import cycles.
 #
 # pylint: disable=import-outside-toplevel
 if typing.TYPE_CHECKING:
-    from ..actor import ComponentMetricRequest, ResamplerConfig
     from ..timeseries.battery_pool import BatteryPool
     from ..timeseries.battery_pool._battery_pool_reference_store import (
         BatteryPoolReferenceStore,
@@ -448,8 +449,6 @@ def _data_sourcing_request_sender(self) -> Sender[ComponentMetricRequest]:
         Returns:
             A Sender for sending requests to the data sourcing actor.
         """
-        from ..actor import DataSourcingActor
-
         if self._data_sourcing_actor is None:
             channel: Broadcast[ComponentMetricRequest] = Broadcast(
                 name="Data Pipeline: Data Sourcing Actor Request Channel"
diff --git a/src/frequenz/sdk/microgrid/_data_sourcing/__init__.py b/src/frequenz/sdk/microgrid/_data_sourcing/__init__.py
diff --git a/src/frequenz/sdk/microgrid/_data_sourcing/_component_metric_request.py b/src/frequenz/sdk/microgrid/_data_sourcing/_component_metric_request.py
diff --git a/src/frequenz/sdk/microgrid/_data_sourcing/data_sourcing.py b/src/frequenz/sdk/microgrid/_data_sourcing/data_sourcing.py
@@ -6,7 +6,7 @@
 from frequenz.channels import Receiver
 
 from ..._internal._channels import ChannelRegistry
-from .._actor import Actor
+from ...actor import Actor
 from ._component_metric_request import ComponentMetricRequest
 from .microgrid_api_source import MicrogridApiSource
 
diff --git a/src/frequenz/sdk/microgrid/_data_sourcing/microgrid_api_source.py b/src/frequenz/sdk/microgrid/_data_sourcing/microgrid_api_source.py
diff --git a/src/frequenz/sdk/microgrid/_resampling.py b/src/frequenz/sdk/microgrid/_resampling.py
@@ -13,10 +13,10 @@
 from .._internal._asyncio import cancel_and_await
 from .._internal._channels import ChannelRegistry
 from ..actor import Actor
-from ..actor._data_sourcing import ComponentMetricRequest
 from ..timeseries import Sample
 from ..timeseries._quantities import Quantity
 from ..timeseries._resampling import Resampler, ResamplerConfig, ResamplingError
+from ._data_sourcing import ComponentMetricRequest
 
 _logger = logging.getLogger(__name__)
 
diff --git a/src/frequenz/sdk/timeseries/_grid_frequency.py b/src/frequenz/sdk/timeseries/_grid_frequency.py
@@ -7,20 +7,16 @@
 
 import asyncio
 import logging
-from typing import TYPE_CHECKING
 
 from frequenz.channels import Receiver, Sender
 from frequenz.client.microgrid import Component, ComponentCategory, ComponentMetricId
 
 from .._internal._channels import ChannelRegistry
 from ..microgrid import connection_manager
+from ..microgrid._data_sourcing import ComponentMetricRequest
 from ..timeseries._base_types import Sample
 from ..timeseries._quantities import Frequency, Quantity
 
-if TYPE_CHECKING:
-    # Imported here to avoid a circular import.
-    from ..actor import ComponentMetricRequest
-
 _logger = logging.getLogger(__name__)
 
 
@@ -33,10 +29,6 @@ def create_request(component_id: int) -> ComponentMetricRequest:
     Returns:
         A component metric request for grid frequency.
     """
-    # Imported here to avoid a circular import.
-    # pylint: disable=import-outside-toplevel
-    from ..actor import ComponentMetricRequest
-
     return ComponentMetricRequest(
         "grid-frequency", component_id, ComponentMetricId.FREQUENCY, None
     )
diff --git a/src/frequenz/sdk/timeseries/_voltage_streamer.py b/src/frequenz/sdk/timeseries/_voltage_streamer.py
@@ -17,13 +17,12 @@
 from frequenz.client.microgrid import Component, ComponentCategory, ComponentMetricId
 
 from .._internal._channels import ChannelRegistry
-from ..microgrid import connection_manager
 from ..timeseries._base_types import Sample, Sample3Phase
 from ..timeseries._quantities import Quantity, Voltage
 
 if TYPE_CHECKING:
     # Imported here to avoid a circular import.
-    from ..actor import ComponentMetricRequest
+    from ..microgrid._data_sourcing import ComponentMetricRequest
 
 _logger = logging.getLogger(__name__)
 
@@ -75,6 +74,10 @@ def __init__(
         self._channel_registry = channel_registry
         """The channel registry for the phase-to-neutral voltage streaming."""
 
+        from ..microgrid import (  # pylint: disable=import-outside-toplevel
+            connection_manager,
+        )
+
         if not source_component:
             component_graph = connection_manager.get().component_graph
             source_component = component_graph.find_first_descendant_component(
@@ -131,7 +134,7 @@ def new_receiver(self) -> Receiver[Sample3Phase[Voltage]]:
     async def _send_request(self) -> None:
         """Send the request to fetch each voltage phase and stream 3-phase voltage."""
         # Imported here to avoid a circular import.
-        from ..actor import (  # pylint: disable=import-outside-toplevel
+        from ..microgrid._data_sourcing import (  # pylint: disable=import-outside-toplevel
             ComponentMetricRequest,
         )
 
diff --git a/src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py b/src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py
@@ -15,8 +15,8 @@
 
 from ..._internal._asyncio import cancel_and_await
 from ..._internal._channels import ChannelRegistry, ReceiverFetcher
-from ...actor._data_sourcing._component_metric_request import ComponentMetricRequest
 from ...microgrid import connection_manager
+from ...microgrid._data_sourcing import ComponentMetricRequest
 from ...microgrid._power_distributing import Result
 from ...microgrid._power_distributing._component_status import ComponentPoolStatus
 from ...microgrid._power_managing._base_classes import Proposal, ReportRequest
diff --git a/src/frequenz/sdk/timeseries/battery_pool/_component_metric_fetcher.py b/src/frequenz/sdk/timeseries/battery_pool/_component_metric_fetcher.py
@@ -24,11 +24,11 @@
 
 from ..._internal._asyncio import AsyncConstructible
 from ..._internal._constants import MAX_BATTERY_DATA_AGE_SEC
-from ...actor._data_sourcing.microgrid_api_source import (
+from ...microgrid import connection_manager
+from ...microgrid._data_sourcing.microgrid_api_source import (
     _BatteryDataMethods,
     _InverterDataMethods,
 )
-from ...microgrid import connection_manager
 from ._component_metrics import ComponentMetricsData
 
 _logger = logging.getLogger(__name__)
diff --git a/src/frequenz/sdk/timeseries/consumer.py b/src/frequenz/sdk/timeseries/consumer.py
@@ -8,7 +8,7 @@
 from frequenz.channels import Sender
 
 from .._internal._channels import ChannelRegistry
-from ..actor import ComponentMetricRequest
+from ..microgrid._data_sourcing import ComponentMetricRequest
 from ._quantities import Power
 from .formula_engine import FormulaEngine
 from .formula_engine._formula_engine_pool import FormulaEnginePool
diff --git a/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool_reference_store.py b/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool_reference_store.py
@@ -11,8 +11,8 @@
 from frequenz.client.microgrid import ComponentCategory
 
 from ..._internal._channels import ChannelRegistry, ReceiverFetcher
-from ...actor import ComponentMetricRequest
 from ...microgrid import connection_manager
+from ...microgrid._data_sourcing import ComponentMetricRequest
 from ...microgrid._power_distributing import ComponentPoolStatus, Result
 from ...microgrid._power_managing._base_classes import Proposal, ReportRequest
 from .._base_types import SystemBounds
diff --git a/src/frequenz/sdk/timeseries/formula_engine/_formula_engine_pool.py b/src/frequenz/sdk/timeseries/formula_engine/_formula_engine_pool.py
@@ -11,6 +11,7 @@
 from frequenz.client.microgrid import ComponentMetricId
 
 from ..._internal._channels import ChannelRegistry
+from ...microgrid._data_sourcing import ComponentMetricRequest
 from .._quantities import Current, Power, Quantity
 from ._formula_generators._formula_generator import (
     FormulaGenerator,
@@ -20,7 +21,6 @@
 
 if TYPE_CHECKING:
     # Break circular import
-    from ...actor import ComponentMetricRequest
     from ..formula_engine import FormulaEngine, FormulaEngine3Phase
 
 
diff --git a/src/frequenz/sdk/timeseries/formula_engine/_formula_generators/_formula_generator.py b/src/frequenz/sdk/timeseries/formula_engine/_formula_generators/_formula_generator.py
@@ -10,21 +10,18 @@
 from collections import abc
 from collections.abc import Callable
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Generic
+from typing import Generic
 
 from frequenz.channels import Sender
 from frequenz.client.microgrid import Component, ComponentCategory, ComponentMetricId
 
 from ...._internal._channels import ChannelRegistry
 from ....microgrid import connection_manager
+from ....microgrid._data_sourcing import ComponentMetricRequest
 from ..._quantities import QuantityT
 from .._formula_engine import FormulaEngine, FormulaEngine3Phase
 from .._resampled_formula_builder import ResampledFormulaBuilder
 
-if TYPE_CHECKING:
-    # Break circular import
-    from ....actor import ComponentMetricRequest
-
 
 class FormulaGenerationError(Exception):
     """An error encountered during formula generation from the component graph."""
diff --git a/src/frequenz/sdk/timeseries/formula_engine/_resampled_formula_builder.py b/src/frequenz/sdk/timeseries/formula_engine/_resampled_formula_builder.py
@@ -6,21 +6,17 @@
 from __future__ import annotations
 
 from collections.abc import Callable
-from typing import TYPE_CHECKING
 
 from frequenz.channels import Receiver, Sender
 from frequenz.client.microgrid import ComponentMetricId
 
 from ..._internal._channels import ChannelRegistry
+from ...microgrid._data_sourcing import ComponentMetricRequest
 from .. import Sample
 from .._quantities import Quantity, QuantityT
 from ._formula_engine import FormulaBuilder, FormulaEngine
 from ._tokenizer import Tokenizer, TokenType
 
-if TYPE_CHECKING:
-    # Break circular import
-    from ...actor import ComponentMetricRequest
-
 
 class ResampledFormulaBuilder(FormulaBuilder[QuantityT]):
     """Provides a way to build a FormulaEngine from resampled data streams."""
@@ -70,9 +66,6 @@ def _get_resampled_receiver(
         Returns:
             A receiver to stream resampled data for the given component id.
         """
-        # pylint: disable=import-outside-toplevel
-        from frequenz.sdk.actor import ComponentMetricRequest
-
         request = ComponentMetricRequest(self._namespace, component_id, metric_id, None)
         self._resampler_requests.append(request)
         resampled_channel = self._channel_registry.get_or_create(
diff --git a/src/frequenz/sdk/timeseries/grid.py b/src/frequenz/sdk/timeseries/grid.py
@@ -11,13 +11,13 @@
 import logging
 import uuid
 from dataclasses import dataclass
-from typing import TYPE_CHECKING
 
 from frequenz.channels import Sender
 from frequenz.client.microgrid._component import ComponentCategory
 
 from .._internal._channels import ChannelRegistry
 from ..microgrid import connection_manager
+from ..microgrid._data_sourcing import ComponentMetricRequest
 from ._fuse import Fuse
 from ._quantities import Current, Power
 from .formula_engine import FormulaEngine, FormulaEngine3Phase
@@ -28,10 +28,6 @@
     GridPowerFormula,
 )
 
-if TYPE_CHECKING:
-    # Break circular import
-    from ..actor import ComponentMetricRequest
-
 _logger = logging.getLogger(__name__)
 
 
diff --git a/src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py b/src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py
@@ -9,7 +9,7 @@
 from frequenz.channels import Sender
 
 from ..._internal._channels import ChannelRegistry
-from ...actor import ComponentMetricId, ComponentMetricRequest
+from ...microgrid._data_sourcing import ComponentMetricId, ComponentMetricRequest
 from .._quantities import Power, Quantity
 from ..formula_engine import FormulaEngine
 from ..formula_engine._formula_engine_pool import FormulaEnginePool
diff --git a/src/frequenz/sdk/timeseries/producer.py b/src/frequenz/sdk/timeseries/producer.py
@@ -8,7 +8,7 @@
 from frequenz.channels import Sender
 
 from .._internal._channels import ChannelRegistry
-from ..actor import ComponentMetricRequest
+from ..microgrid._data_sourcing import ComponentMetricRequest
 from ._quantities import Power
 from .formula_engine import FormulaEngine
 from .formula_engine._formula_engine_pool import FormulaEnginePool
diff --git a/src/frequenz/sdk/timeseries/pv_pool/_pv_pool_reference_store.py b/src/frequenz/sdk/timeseries/pv_pool/_pv_pool_reference_store.py
@@ -12,8 +12,8 @@
 from frequenz.client.microgrid import ComponentCategory, InverterType
 
 from ..._internal._channels import ChannelRegistry, ReceiverFetcher
-from ...actor import ComponentMetricRequest
 from ...microgrid import connection_manager
+from ...microgrid._data_sourcing import ComponentMetricRequest
 from ...microgrid._power_distributing import ComponentPoolStatus, Result
 from ...microgrid._power_managing._base_classes import Proposal, ReportRequest
 from .._base_types import SystemBounds
diff --git a/tests/actor/test_data_sourcing.py b/tests/actor/test_data_sourcing.py
@@ -29,7 +29,10 @@
 )
 
 from frequenz.sdk._internal._channels import ChannelRegistry
-from frequenz.sdk.actor import ComponentMetricRequest, DataSourcingActor
+from frequenz.sdk.microgrid._data_sourcing import (
+    ComponentMetricRequest,
+    DataSourcingActor,
+)
 from frequenz.sdk.timeseries import Quantity, Sample
 
 T = TypeVar("T", bound=ComponentData)
@@ -54,7 +57,8 @@ def mock_connection_manager(mocker: pytest_mock.MockFixture) -> mock.Mock:
     mock_client.ev_charger_data = _new_ev_charger_data_mock(12, starting_value=-13.0)
     mock_conn_manager = mock.MagicMock(name="connection_manager")
     mocker.patch(
-        "frequenz.sdk.actor._data_sourcing.microgrid_api_source.connection_manager.get",
+        "frequenz.sdk.microgrid._data_sourcing"
+        ".microgrid_api_source.connection_manager.get",
         return_value=mock_conn_manager,
     )
     mock_conn_manager.api_client = mock_client
diff --git a/tests/actor/test_resampling.py b/tests/actor/test_resampling.py
@@ -13,7 +13,7 @@
 from frequenz.client.microgrid import ComponentMetricId
 
 from frequenz.sdk._internal._channels import ChannelRegistry
-from frequenz.sdk.actor import ComponentMetricRequest
+from frequenz.sdk.microgrid._data_sourcing import ComponentMetricRequest
 from frequenz.sdk.microgrid._resampling import ComponentMetricsResamplingActor
 from frequenz.sdk.timeseries import ResamplerConfig, Sample
 from frequenz.sdk.timeseries._quantities import Quantity
diff --git a/tests/timeseries/mock_resampler.py b/tests/timeseries/mock_resampler.py
@@ -13,9 +13,9 @@
 from pytest_mock import MockerFixture
 
 from frequenz.sdk._internal._asyncio import cancel_and_await
-from frequenz.sdk.actor import ComponentMetricRequest, ResamplerConfig
 from frequenz.sdk.microgrid._data_pipeline import _DataPipeline
-from frequenz.sdk.timeseries import Sample
+from frequenz.sdk.microgrid._data_sourcing import ComponentMetricRequest
+from frequenz.sdk.timeseries import ResamplerConfig, Sample
 from frequenz.sdk.timeseries._quantities import Quantity
 from frequenz.sdk.timeseries.formula_engine._formula_generators._formula_generator import (
     NON_EXISTING_COMPONENT_ID,
