Make stop method of FormulaEngine public

To be able to stop custom formulas outside sdk.

Signed-off-by: Elzbieta Kotulska <[email protected]>

Author: ela-kotulska-frequenz

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

@@ -112,7 +112,7 @@ def __init__(
         self._channel: Broadcast[Sample[QuantityT]] = Broadcast(name=self._name)
         self._task: asyncio.Task[None] | None = None
 
-    async def _stop(self) -> None:
+    async def stop(self) -> None:
         """Stop a running formula engine."""
         if self._task is None:
             return
@@ -428,7 +428,7 @@ def __init__(
             FormulaEngine[QuantityT],
         ] = phase_streams
 
-    async def _stop(self) -> None:
+    async def stop(self) -> None:
         """Stop a running formula engine."""
         if self._task is None:
             return

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

@@ -231,12 +231,12 @@ def from_3_phase_current_formula_generator(
     async def stop(self) -> None:
         """Stop all formula engines in the pool."""
         for string_engine in self._string_engines.values():
-            await string_engine._stop()  # pylint: disable=protected-access
+            await string_engine.stop()
         for power_engine in self._power_engines.values():
-            await power_engine._stop()  # pylint: disable=protected-access
+            await power_engine.stop()
         for power_3_phase_engine in self._power_3_phase_engines.values():
-            await power_3_phase_engine._stop()  # pylint: disable=protected-access
+            await power_3_phase_engine.stop()
         for current_engine in self._current_engines.values():
-            await current_engine._stop()  # pylint: disable=protected-access
+            await current_engine.stop()
         for reactive_power_engine in self._reactive_power_engines.values():
-            await reactive_power_engine._stop()  # pylint: disable=protected-access
+            await reactive_power_engine.stop()

tests/timeseries/_formula_engine/test_formula_composition.py

@@ -56,8 +56,7 @@ async def test_formula_composition(  # pylint: disable=too-many-locals
             pv_power_recv = pv_pool.power.new_receiver()
 
             engine = (pv_pool.power + battery_pool.power).build("inv_power")
-            stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
-
+            stack.push_async_callback(engine.stop)
             inv_calc_recv = engine.new_receiver()
 
             await mockgrid.mock_resampler.send_bat_inverter_power([10.0, 12.0, 14.0])
@@ -126,7 +125,7 @@ async def test_formula_composition_missing_pv(self, mocker: MockerFixture) -> No
             battery_power_recv = battery_pool.power.new_receiver()
             pv_power_recv = pv_pool.power.new_receiver()
             engine = (pv_pool.power + battery_pool.power).build("inv_power")
-            stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
+            stack.push_async_callback(engine.stop)
 
             inv_calc_recv = engine.new_receiver()
 
@@ -168,7 +167,7 @@ async def test_formula_composition_missing_bat(self, mocker: MockerFixture) -> N
             battery_power_recv = battery_pool.power.new_receiver()
             pv_power_recv = pv_pool.power.new_receiver()
             engine = (pv_pool.power + battery_pool.power).build("inv_power")
-            stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
+            stack.push_async_callback(engine.stop)
 
             inv_calc_recv = engine.new_receiver()
 
@@ -203,15 +202,11 @@ async def test_formula_composition_min_max(self, mocker: MockerFixture) -> None:
             stack.push_async_callback(grid.stop)
 
             engine_min = grid.power.min(logical_meter.chp_power).build("grid_power_min")
-            stack.push_async_callback(
-                engine_min._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_min.stop)
             engine_min_rx = engine_min.new_receiver()
 
             engine_max = grid.power.max(logical_meter.chp_power).build("grid_power_max")
-            stack.push_async_callback(
-                engine_max._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_max.stop)
             engine_max_rx = engine_max.new_receiver()
 
             await mockgrid.mock_resampler.send_meter_power([100.0, 200.0])
@@ -265,15 +260,11 @@ async def test_formula_composition_min_max_const(
             stack.push_async_callback(grid.stop)
 
             engine_min = grid.power.min(Power.zero()).build("grid_power_min")
-            stack.push_async_callback(
-                engine_min._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_min.stop)
             engine_min_rx = engine_min.new_receiver()
 
             engine_max = grid.power.max(Power.zero()).build("grid_power_max")
-            stack.push_async_callback(
-                engine_max._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_max.stop)
             engine_max_rx = engine_max.new_receiver()
 
             await mockgrid.mock_resampler.send_meter_power([100.0])
@@ -320,23 +311,15 @@ async def test_formula_composition_constant(  # pylint: disable=too-many-locals
             engine_add = (grid.power + Power.from_watts(50)).build(
                 "grid_power_addition"
             )
-            stack.push_async_callback(
-                engine_add._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_add.stop)
             engine_sub = (grid.power - Power.from_watts(100)).build(
                 "grid_power_subtraction"
             )
-            stack.push_async_callback(
-                engine_sub._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_sub.stop)
             engine_mul = (grid.power * 2.0).build("grid_power_multiplication")
-            stack.push_async_callback(
-                engine_mul._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_mul.stop)
             engine_div = (grid.power / 2.0).build("grid_power_division")
-            stack.push_async_callback(
-                engine_div._stop  # pylint: disable=protected-access
-            )
+            stack.push_async_callback(engine_div.stop)
 
             engine_composite = (
                 (
@@ -435,7 +418,7 @@ async def test_3_phase_formulas(self, mocker: MockerFixture) -> None:
             engine = (grid.current_per_phase - ev_pool.current_per_phase).build(
                 "net_current"
             )
-            stack.push_async_callback(engine._stop)  # pylint: disable=protected-access
+            stack.push_async_callback(engine.stop)
             net_current_recv = engine.new_receiver()
 
             for _ in range(10):

tests/timeseries/test_formula_engine.py

@@ -95,7 +95,7 @@ async def run_test(  # pylint: disable=too-many-locals
                     and next_val.value.base_value == io_output
                 )
             tests_passed += 1
-        await engine._stop()  # pylint: disable=protected-access
+        await engine.stop()
         assert tests_passed == len(io_pairs)
 
     async def test_simple(self) -> None:
@@ -384,7 +384,7 @@ async def run_test(  # pylint: disable=too-many-locals
                     and next_val.value.base_value == io_output
                 )
             tests_passed += 1
-        await engine._stop()  # pylint: disable=protected-access
+        await engine.stop()
         assert tests_passed == len(io_pairs)
 
     async def test_simple(self) -> None: