Convert generated formula methods into properties

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

examples/power_distribution.py

@@ -230,7 +230,7 @@ async def run() -> None:
 
     client_actor = DataCollectingActor(
         request_channel=power_dist_req_chan.new_sender(),
-        active_power_data=logical_meter.grid_power().new_receiver(),
+        active_power_data=logical_meter.grid_power.new_receiver(),
     )
 
     await actor.run(service_actor, client_actor, power_distributor)

src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py

@@ -104,6 +104,7 @@ def component_ids(self) -> abc.Set[int]:
         """
         return self._component_ids
 
+    @property
     def current(self) -> FormulaEngine3Phase:
         """Fetch the total current for the EV Chargers in the pool.
 
@@ -123,6 +124,7 @@ def current(self) -> FormulaEngine3Phase:
             FormulaGeneratorConfig(component_ids=self._component_ids),
         )  # type: ignore[return-value]
 
+    @property
     def power(self) -> FormulaEngine:
         """Fetch the total power for the EV Chargers in the pool.
 

src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py

@@ -140,6 +140,7 @@ def start_formula(
             formula, component_metric_id, nones_are_zeros
         )
 
+    @property
     def grid_power(self) -> FormulaEngine:
         """Fetch the grid power for the microgrid.
 
@@ -157,6 +158,7 @@ def grid_power(self) -> FormulaEngine:
             GridPowerFormula,
         )  # type: ignore[return-value]
 
+    @property
     def grid_current(self) -> FormulaEngine3Phase:
         """Fetch the grid power for the microgrid.
 
@@ -174,6 +176,7 @@ def grid_current(self) -> FormulaEngine3Phase:
             GridCurrentFormula,
         )  # type: ignore[return-value]
 
+    @property
     def battery_power(self) -> FormulaEngine:
         """Fetch the cumulative battery power in the microgrid.
 
@@ -191,6 +194,7 @@ def battery_power(self) -> FormulaEngine:
             BatteryPowerFormula,
         )  # type: ignore[return-value]
 
+    @property
     def pv_power(self) -> FormulaEngine:
         """Fetch the PV power production in the microgrid.
 

tests/timeseries/_formula_engine/test_formula_composition.py

@@ -33,11 +33,11 @@ async def test_formula_composition(  # pylint: disable=too-many-locals
             4,
             ComponentMetricId.ACTIVE_POWER,
         )
-        grid_power_recv = logical_meter.grid_power().new_receiver()
-        battery_power_recv = logical_meter.battery_power().new_receiver()
-        pv_power_recv = logical_meter.pv_power().new_receiver()
+        grid_power_recv = logical_meter.grid_power.new_receiver()
+        battery_power_recv = logical_meter.battery_power.new_receiver()
+        pv_power_recv = logical_meter.pv_power.new_receiver()
 
-        engine = (logical_meter.pv_power() + logical_meter.battery_power()).build(
+        engine = (logical_meter.pv_power + logical_meter.battery_power).build(
             "inv_power"
         )
         inv_calc_recv = engine.new_receiver()
@@ -71,9 +71,9 @@ async def test_formula_composition_missing_pv(self, mocker: MockerFixture) -> No
         await mockgrid.start(mocker)
         logical_meter = microgrid.logical_meter()
 
-        battery_power_recv = logical_meter.battery_power().new_receiver()
-        pv_power_recv = logical_meter.pv_power().new_receiver()
-        engine = (logical_meter.pv_power() + logical_meter.battery_power()).build(
+        battery_power_recv = logical_meter.battery_power.new_receiver()
+        pv_power_recv = logical_meter.pv_power.new_receiver()
+        engine = (logical_meter.pv_power + logical_meter.battery_power).build(
             "inv_power"
         )
         inv_calc_recv = engine.new_receiver()
@@ -100,9 +100,9 @@ async def test_formula_composition_missing_bat(self, mocker: MockerFixture) -> N
         await mockgrid.start(mocker)
         logical_meter = microgrid.logical_meter()
 
-        battery_power_recv = logical_meter.battery_power().new_receiver()
-        pv_power_recv = logical_meter.pv_power().new_receiver()
-        engine = (logical_meter.pv_power() + logical_meter.battery_power()).build(
+        battery_power_recv = logical_meter.battery_power.new_receiver()
+        pv_power_recv = logical_meter.pv_power.new_receiver()
+        engine = (logical_meter.pv_power + logical_meter.battery_power).build(
             "inv_power"
         )
         inv_calc_recv = engine.new_receiver()
@@ -131,10 +131,10 @@ async def test_3_phase_formulas(self, mocker: MockerFixture) -> None:
         logical_meter = microgrid.logical_meter()
         ev_pool = microgrid.ev_charger_pool()
 
-        grid_current_recv = logical_meter.grid_current().new_receiver()
-        ev_current_recv = ev_pool.current().new_receiver()
+        grid_current_recv = logical_meter.grid_current.new_receiver()
+        ev_current_recv = ev_pool.current.new_receiver()
 
-        engine = (logical_meter.grid_current() - ev_pool.current()).build("net_current")
+        engine = (logical_meter.grid_current - ev_pool.current).build("net_current")
         net_current_recv = engine.new_receiver()
 
         await synchronize_receivers(

tests/timeseries/test_ev_charger_pool.py

@@ -96,8 +96,8 @@ async def test_ev_power(  # pylint: disable=too-many-locals
             mockgrid.main_meter_id,
             ComponentMetricId.ACTIVE_POWER,
         )
-        grid_power_recv = logical_meter.grid_power().new_receiver()
-        ev_power_recv = ev_pool.power().new_receiver()
+        grid_power_recv = logical_meter.grid_power.new_receiver()
+        ev_power_recv = ev_pool.power.new_receiver()
 
         await synchronize_receivers([grid_power_recv, main_meter_recv, ev_power_recv])
 

tests/timeseries/test_logical_meter.py

@@ -31,7 +31,7 @@ async def test_grid_power_1(self, mocker: MockerFixture) -> None:
         await mockgrid.start(mocker)
         logical_meter = microgrid.logical_meter()
 
-        grid_power_recv = logical_meter.grid_power().new_receiver()
+        grid_power_recv = logical_meter.grid_power.new_receiver()
 
         main_meter_recv = get_resampled_stream(
             mockgrid.main_meter_id,
@@ -63,7 +63,7 @@ async def test_grid_power_2(
         await mockgrid.start(mocker)
         logical_meter = microgrid.logical_meter()
 
-        grid_power_recv = logical_meter.grid_power().new_receiver()
+        grid_power_recv = logical_meter.grid_power.new_receiver()
 
         meter_receivers = [
             get_resampled_stream(
@@ -105,8 +105,8 @@ async def test_battery_and_pv_power(  # pylint: disable=too-many-locals
         await mockgrid.start(mocker)
         logical_meter = microgrid.logical_meter()
 
-        battery_power_recv = logical_meter.battery_power().new_receiver()
-        pv_power_recv = logical_meter.pv_power().new_receiver()
+        battery_power_recv = logical_meter.battery_power.new_receiver()
+        pv_power_recv = logical_meter.pv_power.new_receiver()
 
         bat_inv_receivers = [
             get_resampled_stream(