Add some missing @override

This will help us to make sure all sub-classes are properly updated when
doing changes to method signatures.

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

Author: llucax

src/frequenz/sdk/microgrid/component_graph.py

@@ -35,6 +35,7 @@
     InverterType,
     MicrogridApiClient,
 )
+from typing_extensions import override
 
 _logger = logging.getLogger(__name__)
 
@@ -372,6 +373,7 @@ def __init__(
         self.refresh_from(components, connections)
         self.validate()
 
+    @override
     def components(
         self,
         component_ids: set[ComponentId] | None = None,
@@ -401,6 +403,7 @@ def components(
 
         return set(selection)
 
+    @override
     def connections(
         self,
         start: set[ComponentId] | None = None,
@@ -430,6 +433,7 @@ def connections(
 
         return set(self._graph.edges[i][_DATA_KEY] for i in selection_ids)
 
+    @override
     def predecessors(self, component_id: ComponentId) -> set[Component]:
         """Fetch the graph predecessors of the specified component.
 
@@ -454,6 +458,7 @@ def predecessors(self, component_id: ComponentId) -> set[Component]:
 
         return set(map(lambda idx: self._graph.nodes[idx][_DATA_KEY], predecessors_ids))
 
+    @override
     def successors(self, component_id: ComponentId) -> set[Component]:
         """Fetch the graph successors of the specified component.
 
@@ -567,6 +572,7 @@ def validate(self) -> None:
         self._validate_intermediary_components()
         self._validate_leaf_components()
 
+    @override
     def is_grid_meter(self, component: Component) -> bool:
         """Check if the specified component is a grid meter.
 
@@ -593,6 +599,7 @@ def is_grid_meter(self, component: Component) -> bool:
         grid_successors = self.successors(predecessor.component_id)
         return len(grid_successors) == 1
 
+    @override
     def is_pv_inverter(self, component: Component) -> bool:
         """Check if the specified component is a PV inverter.
 
@@ -607,6 +614,7 @@ def is_pv_inverter(self, component: Component) -> bool:
             and component.type == InverterType.SOLAR
         )
 
+    @override
     def is_pv_meter(self, component: Component) -> bool:
         """Check if the specified component is a PV meter.
 
@@ -630,6 +638,7 @@ def is_pv_meter(self, component: Component) -> bool:
             )
         )
 
+    @override
     def is_pv_chain(self, component: Component) -> bool:
         """Check if the specified component is part of a PV chain.
 
@@ -644,6 +653,7 @@ def is_pv_chain(self, component: Component) -> bool:
         """
         return self.is_pv_inverter(component) or self.is_pv_meter(component)
 
+    @override
     def is_ev_charger(self, component: Component) -> bool:
         """Check if the specified component is an EV charger.
 
@@ -655,6 +665,7 @@ def is_ev_charger(self, component: Component) -> bool:
         """
         return component.category == ComponentCategory.EV_CHARGER
 
+    @override
     def is_ev_charger_meter(self, component: Component) -> bool:
         """Check if the specified component is an EV charger meter.
 
@@ -675,6 +686,7 @@ def is_ev_charger_meter(self, component: Component) -> bool:
             and all(self.is_ev_charger(successor) for successor in successors)
         )
 
+    @override
     def is_ev_charger_chain(self, component: Component) -> bool:
         """Check if the specified component is part of an EV charger chain.
 
@@ -689,6 +701,7 @@ def is_ev_charger_chain(self, component: Component) -> bool:
         """
         return self.is_ev_charger(component) or self.is_ev_charger_meter(component)
 
+    @override
     def is_battery_inverter(self, component: Component) -> bool:
         """Check if the specified component is a battery inverter.
 
@@ -703,6 +716,7 @@ def is_battery_inverter(self, component: Component) -> bool:
             and component.type == InverterType.BATTERY
         )
 
+    @override
     def is_battery_meter(self, component: Component) -> bool:
         """Check if the specified component is a battery meter.
 
@@ -723,6 +737,7 @@ def is_battery_meter(self, component: Component) -> bool:
             and all(self.is_battery_inverter(successor) for successor in successors)
         )
 
+    @override
     def is_battery_chain(self, component: Component) -> bool:
         """Check if the specified component is part of a battery chain.
 
@@ -737,6 +752,7 @@ def is_battery_chain(self, component: Component) -> bool:
         """
         return self.is_battery_inverter(component) or self.is_battery_meter(component)
 
+    @override
     def is_chp(self, component: Component) -> bool:
         """Check if the specified component is a CHP.
 
@@ -748,6 +764,7 @@ def is_chp(self, component: Component) -> bool:
         """
         return component.category == ComponentCategory.CHP
 
+    @override
     def is_chp_meter(self, component: Component) -> bool:
         """Check if the specified component is a CHP meter.
 
@@ -768,6 +785,7 @@ def is_chp_meter(self, component: Component) -> bool:
             and all(self.is_chp(successor) for successor in successors)
         )
 
+    @override
     def is_chp_chain(self, component: Component) -> bool:
         """Check if the specified component is part of a CHP chain.
 
@@ -781,6 +799,7 @@ def is_chp_chain(self, component: Component) -> bool:
         """
         return self.is_chp(component) or self.is_chp_meter(component)
 
+    @override
     def dfs(
         self,
         current_node: Component,
@@ -816,6 +835,7 @@ def dfs(
 
         return component
 
+    @override
     def find_first_descendant_component(
         self,
         *,

src/frequenz/sdk/timeseries/battery_pool/_component_metric_fetcher.py

@@ -82,6 +82,7 @@ class LatestMetricsFetcher(ComponentMetricFetcher, Generic[T], ABC):
     _max_waiting_time: float
 
     @classmethod
+    @override
     async def async_new(
         cls,
         component_id: ComponentId,
@@ -115,6 +116,7 @@ async def async_new(
         # pylint: enable=protected-access
         return self
 
+    @override
     async def fetch_next(self) -> ComponentMetricsData | None:
         """Fetch the latest component metrics.
 
@@ -179,6 +181,7 @@ class LatestBatteryMetricsFetcher(LatestMetricsFetcher[BatteryData]):
     """Subscribe for the latest battery data using MicrogridApiClient."""
 
     @classmethod
+    @override
     async def async_new(  # noqa: DOC502 (ValueError is raised indirectly super.async_new)
         cls,
         component_id: ComponentId,
@@ -204,12 +207,15 @@ async def async_new(  # noqa: DOC502 (ValueError is raised indirectly super.asyn
         )
         return self
 
+    @override
     def _supported_metrics(self) -> set[ComponentMetricId]:
         return set(_BatteryDataMethods.keys())
 
+    @override
     def _extract_metric(self, data: BatteryData, mid: ComponentMetricId) -> float:
         return _BatteryDataMethods[mid](data)
 
+    @override
     async def _subscribe(self) -> Receiver[BatteryData]:
         """Subscribe for this component data.
 
@@ -222,6 +228,7 @@ async def _subscribe(self) -> Receiver[BatteryData]:
         api = connection_manager.get().api_client
         return await api.battery_data(self._component_id, maxsize=1)
 
+    @override
     def _component_category(self) -> ComponentCategory:
         return ComponentCategory.BATTERY
 
@@ -230,6 +237,7 @@ class LatestInverterMetricsFetcher(LatestMetricsFetcher[InverterData]):
     """Subscribe for the latest inverter data using MicrogridApiClient."""
 
     @classmethod
+    @override
     async def async_new(  # noqa: DOC502 (ValueError is raised indirectly by super.async_new)
         cls,
         component_id: ComponentId,
@@ -255,12 +263,15 @@ async def async_new(  # noqa: DOC502 (ValueError is raised indirectly by super.a
         )
         return self
 
+    @override
     def _supported_metrics(self) -> set[ComponentMetricId]:
         return set(_InverterDataMethods.keys())
 
+    @override
     def _extract_metric(self, data: InverterData, mid: ComponentMetricId) -> float:
         return _InverterDataMethods[mid](data)
 
+    @override
     async def _subscribe(self) -> Receiver[InverterData]:
         """Subscribe for this component data.
 
@@ -273,5 +284,6 @@ async def _subscribe(self) -> Receiver[InverterData]:
         api = connection_manager.get().api_client
         return await api.inverter_data(self._component_id, maxsize=1)
 
+    @override
     def _component_category(self) -> ComponentCategory:
         return ComponentCategory.INVERTER

src/frequenz/sdk/timeseries/battery_pool/_metric_calculator.py

@@ -14,6 +14,7 @@
 from frequenz.client.common.microgrid.components import ComponentId
 from frequenz.client.microgrid import ComponentMetricId
 from frequenz.quantities import Energy, Percentage, Power, Temperature
+from typing_extensions import override
 
 from ... import timeseries
 from ..._internal import _math
@@ -137,6 +138,7 @@ def __init__(self, batteries: Set[ComponentId]) -> None:
         ]
 
     @classmethod
+    @override
     def name(cls) -> str:
         """Return name of the calculator.
 
@@ -146,6 +148,7 @@ def name(cls) -> str:
         return "Capacity"
 
     @property
+    @override
     def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each battery.
 
@@ -155,6 +158,7 @@ def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         return {bid: self._metrics for bid in self._batteries}
 
     @property
+    @override
     def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each inverter.
 
@@ -163,6 +167,7 @@ def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """
         return {}
 
+    @override
     def calculate(
         self,
         metrics_data: dict[ComponentId, ComponentMetricsData],
@@ -227,6 +232,7 @@ def __init__(self, batteries: Set[ComponentId]) -> None:
         ]
 
     @classmethod
+    @override
     def name(cls) -> str:
         """Return name of the calculator.
 
@@ -236,6 +242,7 @@ def name(cls) -> str:
         return "temperature"
 
     @property
+    @override
     def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each battery.
 
@@ -245,6 +252,7 @@ def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         return {bid: self._metrics for bid in self._batteries}
 
     @property
+    @override
     def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each inverter.
 
@@ -253,6 +261,7 @@ def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """
         return {}
 
+    @override
     def calculate(
         self,
         metrics_data: dict[ComponentId, ComponentMetricsData],
@@ -317,6 +326,7 @@ def __init__(self, batteries: Set[ComponentId]) -> None:
         ]
 
     @classmethod
+    @override
     def name(cls) -> str:
         """Return name of the calculator.
 
@@ -326,6 +336,7 @@ def name(cls) -> str:
         return "SoC"
 
     @property
+    @override
     def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each battery.
 
@@ -335,6 +346,7 @@ def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         return {bid: self._metrics for bid in self._batteries}
 
     @property
+    @override
     def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each inverter.
 
@@ -343,6 +355,7 @@ def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """
         return {}
 
+    @override
     def calculate(
         self,
         metrics_data: dict[ComponentId, ComponentMetricsData],
@@ -485,6 +498,7 @@ def __init__(
         ]
 
     @classmethod
+    @override
     def name(cls) -> str:
         """Return name of the calculator.
 
@@ -494,6 +508,7 @@ def name(cls) -> str:
         return "PowerBounds"
 
     @property
+    @override
     def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each battery.
 
@@ -503,6 +518,7 @@ def battery_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         return {bid: self._battery_metrics for bid in set(self._bat_inv_map.keys())}
 
     @property
+    @override
     def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         """Return what metrics are needed for each inverter.
 
@@ -516,6 +532,7 @@ def inverter_metrics(self) -> Mapping[ComponentId, list[ComponentMetricId]]:
         }
 
     # pylint: disable=too-many-locals
+    @override
     def calculate(
         self,
         metrics_data: dict[ComponentId, ComponentMetricsData],