Move Fuse to timeseries module (#781)

The Grid class is the only class that uses `Fuse` as it is used to
represent the fuse of a grid. It is not a microgrid-specific class.
Therefore, it is moved to the timeseries module.

Fixes #771

Author: daniel-zullo-frequenz

RELEASE_NOTES.md

@@ -18,6 +18,8 @@
     + `Result.failed_components`
 
 
+- The `Fuse` class has been moved to the `frequenz.sdk.timeseries` module.
+
 ## New Features
 
 <!-- Here goes the main new features and examples or instructions on how to use them -->

pyproject.toml

@@ -166,6 +166,9 @@ max-attributes = 12
 testpaths = ["tests", "src"]
 asyncio_mode = "auto"
 required_plugins = ["pytest-asyncio", "pytest-mock"]
+markers = [
+  "integration: integration tests (deselect with '-m \"not integration\"')",
+]
 
 [tool.mypy]
 explicit_package_bases = true

src/frequenz/sdk/microgrid/__init__.py

@@ -124,7 +124,7 @@
 
 from ..actor import ResamplerConfig
 from ..timeseries.grid import initialize as initialize_grid
-from . import _data_pipeline, client, component, connection_manager, fuse, metadata
+from . import _data_pipeline, client, component, connection_manager, metadata
 from ._data_pipeline import (
     battery_pool,
     ev_charger_pool,
@@ -157,7 +157,6 @@ async def initialize(host: str, port: int, resampler_config: ResamplerConfig) ->
     "component",
     "battery_pool",
     "ev_charger_pool",
-    "fuse",
     "grid",
     "frequency",
     "logical_meter",

src/frequenz/sdk/microgrid/component/_component.py

@@ -2,16 +2,19 @@
 # Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
 """Defines the components that can be used in a microgrid."""
+from __future__ import annotations
 
 from dataclasses import dataclass
 from enum import Enum
+from typing import TYPE_CHECKING
 
 import frequenz.api.common.components_pb2 as components_pb
 import frequenz.api.microgrid.grid_pb2 as grid_pb
 import frequenz.api.microgrid.inverter_pb2 as inverter_pb
 
-from ...timeseries import Current
-from ..fuse import Fuse
+if TYPE_CHECKING:
+    # Break circular import
+    from ...timeseries import Fuse
 
 
 class ComponentType(Enum):
@@ -140,6 +143,8 @@ def _component_metadata_from_protobuf(
     component_category: components_pb.ComponentCategory.ValueType,
     component_metadata: grid_pb.Metadata,
 ) -> GridMetadata | None:
+    from ...timeseries import Current, Fuse  # pylint: disable=import-outside-toplevel
+
     if component_category == components_pb.ComponentCategory.COMPONENT_CATEGORY_GRID:
         max_current = Current.from_amperes(component_metadata.rated_fuse_current)
         fuse = Fuse(max_current)

src/frequenz/sdk/timeseries/__init__.py

@@ -37,6 +37,7 @@
 
 from .._internal._channels import ReceiverFetcher
 from ._base_types import UNIX_EPOCH, Bounds, Sample, Sample3Phase
+from ._fuse import Fuse
 from ._moving_window import MovingWindow
 from ._periodic_feature_extractor import PeriodicFeatureExtractor
 from ._quantities import (
@@ -53,6 +54,7 @@
 
 __all__ = [
     "Bounds",
+    "Fuse",
     "MovingWindow",
     "PeriodicFeatureExtractor",
     "ResamplerConfig",

src/frequenz/sdk/microgrid/fuse.py src/frequenz/sdk/timeseries/_fuse.pysrc/frequenz/sdk/microgrid/fuse.py renamed to src/frequenz/sdk/timeseries/_fuse.py

@@ -2,10 +2,14 @@
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
 """Fuse data class."""
+from __future__ import annotations
 
 from dataclasses import dataclass
+from typing import TYPE_CHECKING
 
-from ..timeseries import Current
+if TYPE_CHECKING:
+    # Break circular import
+    from . import Current
 
 
 @dataclass(frozen=True)

src/frequenz/sdk/timeseries/formula_engine/_formula_engine_pool.py

@@ -19,7 +19,7 @@
 from ._resampled_formula_builder import ResampledFormulaBuilder
 
 if TYPE_CHECKING:
-    # Break circular import by enclosing these type hints in a `TYPE_CHECKING` block.
+    # Break circular import
     from ..formula_engine import FormulaEngine, FormulaEngine3Phase
 
 

src/frequenz/sdk/timeseries/grid.py

@@ -13,7 +13,7 @@
 
 from ..microgrid.component import Component
 from ..microgrid.component._component import ComponentCategory
-from ..microgrid.fuse import Fuse
+from . import Fuse
 
 _logger = logging.getLogger(__name__)
 

tests/microgrid/test_client.py

@@ -26,8 +26,7 @@
     InverterType,
     MeterData,
 )
-from frequenz.sdk.microgrid.fuse import Fuse
-from frequenz.sdk.timeseries import Current
+from frequenz.sdk.timeseries import Current, Fuse
 
 from . import mock_api
 

tests/microgrid/test_graph.py

@@ -21,8 +21,7 @@
     GridMetadata,
     InverterType,
 )
-from frequenz.sdk.microgrid.fuse import Fuse
-from frequenz.sdk.timeseries import Current
+from frequenz.sdk.timeseries import Current, Fuse
 
 from .mock_api import MockGrpcServer, MockMicrogridServicer