Rename *_pool_ref *Pool ctor parameters to pool_ref_store

This allows all `*Pool` classes to have the same signature.

This commit also renames the corresponding private variable in all the
`*Pool` classes to `self._pool_ref_store`.

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

Author: shsms

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

@@ -55,7 +55,7 @@ class BatteryPool:
 
     def __init__(
         self,
-        battery_pool_ref: BatteryPoolReferenceStore,
+        pool_ref_store: BatteryPoolReferenceStore,
         name: str | None,
         priority: int,
     ):
@@ -67,12 +67,12 @@ def __init__(
             for creating `BatteryPool` instances.
 
         Args:
-            battery_pool_ref: The battery pool reference store instance.
+            pool_ref_store: The battery pool reference store instance.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
             priority: The priority of the actor using this wrapper.
         """
-        self._battery_pool = battery_pool_ref
+        self._pool_ref_store = pool_ref_store
         unique_id = str(uuid.uuid4())
         self._source_id = unique_id if name is None else f"{name}-{unique_id}"
         self._priority = priority
@@ -120,12 +120,12 @@ async def propose_power(
                 to the maximum power of the batteries in the pool.  This is currently
                 and experimental feature.
         """
-        await self._battery_pool._power_manager_requests_sender.send(
+        await self._pool_ref_store._power_manager_requests_sender.send(
             _power_managing.Proposal(
                 source_id=self._source_id,
                 preferred_power=power,
                 bounds=bounds,
-                component_ids=self._battery_pool._batteries,
+                component_ids=self._pool_ref_store._batteries,
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
@@ -166,12 +166,12 @@ async def propose_charge(
         """
         if power and power < Power.zero():
             raise ValueError("Charge power must be positive.")
-        await self._battery_pool._power_manager_requests_sender.send(
+        await self._pool_ref_store._power_manager_requests_sender.send(
             _power_managing.Proposal(
                 source_id=self._source_id,
                 preferred_power=power,
                 bounds=timeseries.Bounds(None, None),
-                component_ids=self._battery_pool._batteries,
+                component_ids=self._pool_ref_store._batteries,
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
@@ -214,12 +214,12 @@ async def propose_discharge(
             if power < Power.zero():
                 raise ValueError("Discharge power must be positive.")
             power = -power
-        await self._battery_pool._power_manager_requests_sender.send(
+        await self._pool_ref_store._power_manager_requests_sender.send(
             _power_managing.Proposal(
                 source_id=self._source_id,
                 preferred_power=power,
                 bounds=timeseries.Bounds(None, None),
-                component_ids=self._battery_pool._batteries,
+                component_ids=self._pool_ref_store._batteries,
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
@@ -233,7 +233,7 @@ def component_ids(self) -> abc.Set[int]:
         Returns:
             Ids of the batteries in the pool
         """
-        return self._battery_pool._batteries
+        return self._pool_ref_store._batteries
 
     @property
     def power(self) -> FormulaEngine[Power]:
@@ -251,11 +251,11 @@ def power(self) -> FormulaEngine[Power]:
             A FormulaEngine that will calculate and stream the total power of all
                 batteries in the pool.
         """
-        engine = self._battery_pool._formula_pool.from_power_formula_generator(
+        engine = self._pool_ref_store._formula_pool.from_power_formula_generator(
             "battery_pool_power",
             BatteryPowerFormula,
             FormulaGeneratorConfig(
-                component_ids=self._battery_pool._batteries,
+                component_ids=self._pool_ref_store._batteries,
             ),
         )
         assert isinstance(engine, FormulaEngine)
@@ -298,15 +298,15 @@ def soc(self) -> ReceiverFetcher[Sample[Percentage]]:
         """
         method_name = SendOnUpdate.name() + "_" + SoCCalculator.name()
 
-        if method_name not in self._battery_pool._active_methods:
-            calculator = SoCCalculator(self._battery_pool._batteries)
-            self._battery_pool._active_methods[method_name] = SendOnUpdate(
+        if method_name not in self._pool_ref_store._active_methods:
+            calculator = SoCCalculator(self._pool_ref_store._batteries)
+            self._pool_ref_store._active_methods[method_name] = SendOnUpdate(
                 metric_calculator=calculator,
-                working_batteries=self._battery_pool._working_batteries,
-                min_update_interval=self._battery_pool._min_update_interval,
+                working_batteries=self._pool_ref_store._working_batteries,
+                min_update_interval=self._pool_ref_store._min_update_interval,
             )
 
-        return self._battery_pool._active_methods[method_name]
+        return self._pool_ref_store._active_methods[method_name]
 
     @property
     def temperature(self) -> ReceiverFetcher[Sample[Temperature]]:
@@ -317,14 +317,14 @@ def temperature(self) -> ReceiverFetcher[Sample[Temperature]]:
                 of all batteries in the pool.
         """
         method_name = SendOnUpdate.name() + "_" + TemperatureCalculator.name()
-        if method_name not in self._battery_pool._active_methods:
-            calculator = TemperatureCalculator(self._battery_pool._batteries)
-            self._battery_pool._active_methods[method_name] = SendOnUpdate(
+        if method_name not in self._pool_ref_store._active_methods:
+            calculator = TemperatureCalculator(self._pool_ref_store._batteries)
+            self._pool_ref_store._active_methods[method_name] = SendOnUpdate(
                 metric_calculator=calculator,
-                working_batteries=self._battery_pool._working_batteries,
-                min_update_interval=self._battery_pool._min_update_interval,
+                working_batteries=self._pool_ref_store._working_batteries,
+                min_update_interval=self._pool_ref_store._min_update_interval,
             )
-        return self._battery_pool._active_methods[method_name]
+        return self._pool_ref_store._active_methods[method_name]
 
     @property
     def capacity(self) -> ReceiverFetcher[Sample[Energy]]:
@@ -355,15 +355,15 @@ def capacity(self) -> ReceiverFetcher[Sample[Energy]]:
         """
         method_name = SendOnUpdate.name() + "_" + CapacityCalculator.name()
 
-        if method_name not in self._battery_pool._active_methods:
-            calculator = CapacityCalculator(self._battery_pool._batteries)
-            self._battery_pool._active_methods[method_name] = SendOnUpdate(
+        if method_name not in self._pool_ref_store._active_methods:
+            calculator = CapacityCalculator(self._pool_ref_store._batteries)
+            self._pool_ref_store._active_methods[method_name] = SendOnUpdate(
                 metric_calculator=calculator,
-                working_batteries=self._battery_pool._working_batteries,
-                min_update_interval=self._battery_pool._min_update_interval,
+                working_batteries=self._pool_ref_store._working_batteries,
+                min_update_interval=self._pool_ref_store._min_update_interval,
             )
 
-        return self._battery_pool._active_methods[method_name]
+        return self._pool_ref_store._active_methods[method_name]
 
     @property
     def power_status(self) -> ReceiverFetcher[BatteryPoolReport]:
@@ -380,14 +380,14 @@ def power_status(self) -> ReceiverFetcher[BatteryPoolReport]:
         sub = _power_managing.ReportRequest(
             source_id=self._source_id,
             priority=self._priority,
-            component_ids=self._battery_pool._batteries,
+            component_ids=self._pool_ref_store._batteries,
         )
-        self._battery_pool._power_bounds_subs[sub.get_channel_name()] = (
+        self._pool_ref_store._power_bounds_subs[sub.get_channel_name()] = (
             asyncio.create_task(
-                self._battery_pool._power_manager_bounds_subscription_sender.send(sub)
+                self._pool_ref_store._power_manager_bounds_subscription_sender.send(sub)
             )
         )
-        channel = self._battery_pool._channel_registry.get_or_create(
+        channel = self._pool_ref_store._channel_registry.get_or_create(
             _power_managing._Report, sub.get_channel_name()
         )
         channel.resend_latest = True
@@ -415,16 +415,16 @@ def _system_power_bounds(self) -> ReceiverFetcher[SystemBounds]:
         """
         method_name = SendOnUpdate.name() + "_" + PowerBoundsCalculator.name()
 
-        if method_name not in self._battery_pool._active_methods:
-            calculator = PowerBoundsCalculator(self._battery_pool._batteries)
-            self._battery_pool._active_methods[method_name] = SendOnUpdate(
+        if method_name not in self._pool_ref_store._active_methods:
+            calculator = PowerBoundsCalculator(self._pool_ref_store._batteries)
+            self._pool_ref_store._active_methods[method_name] = SendOnUpdate(
                 metric_calculator=calculator,
-                working_batteries=self._battery_pool._working_batteries,
-                min_update_interval=self._battery_pool._min_update_interval,
+                working_batteries=self._pool_ref_store._working_batteries,
+                min_update_interval=self._pool_ref_store._min_update_interval,
             )
 
-        return self._battery_pool._active_methods[method_name]
+        return self._pool_ref_store._active_methods[method_name]
 
     async def stop(self) -> None:
         """Stop all tasks and channels owned by the BatteryPool."""
-        await self._battery_pool.stop()
+        await self._pool_ref_store.stop()

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

@@ -41,7 +41,7 @@ class EVChargerPool:
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
-        ev_charger_pool_ref: EVChargerPoolReferenceStore,
+        pool_ref_store: EVChargerPoolReferenceStore,
         name: str | None,
         priority: int,
     ) -> None:
@@ -53,12 +53,12 @@ def __init__(  # pylint: disable=too-many-arguments
             method for creating `EVChargerPool` instances.
 
         Args:
-            ev_charger_pool_ref: The EV charger pool reference store instance.
+            pool_ref_store: The EV charger pool reference store instance.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
             priority: The priority of the actor using this wrapper.
         """
-        self._ev_charger_pool = ev_charger_pool_ref
+        self._pool_ref_store = pool_ref_store
         unique_id = str(uuid.uuid4())
         self._source_id = unique_id if name is None else f"{name}-{unique_id}"
         self._priority = priority
@@ -118,12 +118,12 @@ async def propose_power(
             raise EVChargerPoolError(
                 "Discharging from EV chargers is currently not supported."
             )
-        await self._ev_charger_pool.power_manager_requests_sender.send(
+        await self._pool_ref_store.power_manager_requests_sender.send(
             _power_managing.Proposal(
                 source_id=self._source_id,
                 preferred_power=power,
                 bounds=bounds,
-                component_ids=self._ev_charger_pool.component_ids,
+                component_ids=self._pool_ref_store.component_ids,
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
@@ -137,7 +137,7 @@ def component_ids(self) -> abc.Set[int]:
         Returns:
             Set of managed component IDs.
         """
-        return self._ev_charger_pool.component_ids
+        return self._pool_ref_store.component_ids
 
     @property
     def current(self) -> FormulaEngine3Phase[Current]:
@@ -156,11 +156,11 @@ def current(self) -> FormulaEngine3Phase[Current]:
                 Chargers.
         """
         engine = (
-            self._ev_charger_pool.formula_pool.from_3_phase_current_formula_generator(
+            self._pool_ref_store.formula_pool.from_3_phase_current_formula_generator(
                 "ev_charger_total_current",
                 EVChargerCurrentFormula,
                 FormulaGeneratorConfig(
-                    component_ids=self._ev_charger_pool.component_ids
+                    component_ids=self._pool_ref_store.component_ids
                 ),
             )
         )
@@ -183,11 +183,11 @@ def power(self) -> FormulaEngine[Power]:
             A FormulaEngine that will calculate and stream the total power of all EV
                 Chargers.
         """
-        engine = self._ev_charger_pool.formula_pool.from_power_formula_generator(
+        engine = self._pool_ref_store.formula_pool.from_power_formula_generator(
             "ev_charger_power",
             EVChargerPowerFormula,
             FormulaGeneratorConfig(
-                component_ids=self._ev_charger_pool.component_ids,
+                component_ids=self._pool_ref_store.component_ids,
             ),
         )
         assert isinstance(engine, FormulaEngine)
@@ -208,14 +208,14 @@ def power_status(self) -> ReceiverFetcher[EVChargerPoolReport]:
         sub = _power_managing.ReportRequest(
             source_id=self._source_id,
             priority=self._priority,
-            component_ids=self._ev_charger_pool.component_ids,
+            component_ids=self._pool_ref_store.component_ids,
         )
-        self._ev_charger_pool.power_bounds_subs[sub.get_channel_name()] = (
+        self._pool_ref_store.power_bounds_subs[sub.get_channel_name()] = (
             asyncio.create_task(
-                self._ev_charger_pool.power_manager_bounds_subs_sender.send(sub)
+                self._pool_ref_store.power_manager_bounds_subs_sender.send(sub)
             )
         )
-        channel = self._ev_charger_pool.channel_registry.get_or_create(
+        channel = self._pool_ref_store.channel_registry.get_or_create(
             _power_managing._Report,  # pylint: disable=protected-access
             sub.get_channel_name(),
         )
@@ -227,9 +227,9 @@ def power_status(self) -> ReceiverFetcher[EVChargerPoolReport]:
 
     async def stop(self) -> None:
         """Stop all tasks and channels owned by the EVChargerPool."""
-        await self._ev_charger_pool.stop()
+        await self._pool_ref_store.stop()
 
     @property
     def _system_power_bounds(self) -> ReceiverFetcher[SystemBounds]:
         """Return a receiver fetcher for the system power bounds."""
-        return self._ev_charger_pool.bounds_channel
+        return self._pool_ref_store.bounds_channel

src/frequenz/sdk/timeseries/pv_pool/_pv_pool.py

@@ -34,7 +34,7 @@ class PVPool:
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
-        pv_pool_ref: PVPoolReferenceStore,
+        pool_ref_store: PVPoolReferenceStore,
         name: str | None,
         priority: int,
     ) -> None:
@@ -46,11 +46,11 @@ def __init__(  # pylint: disable=too-many-arguments
             `PVPool` instances.
 
         Args:
-            pv_pool_ref: The reference store for the PV pool.
+            pool_ref_store: The reference store for the PV pool.
             name: The name of the PV pool.
             priority: The priority of the PV pool.
         """
-        self._pv_pool_ref = pv_pool_ref
+        self._pool_ref_store = pool_ref_store
         unique_id = uuid.uuid4()
         self._source_id = str(unique_id) if name is None else f"{name}-{unique_id}"
         self._priority = priority
@@ -107,12 +107,12 @@ async def propose_power(
         """
         if power is not None and power > Power.zero():
             raise PVPoolError("Charge powers for PV inverters is not supported.")
-        await self._pv_pool_ref.power_manager_requests_sender.send(
+        await self._pool_ref_store.power_manager_requests_sender.send(
             _power_managing.Proposal(
                 source_id=self._source_id,
                 preferred_power=power,
                 bounds=bounds,
-                component_ids=self._pv_pool_ref.component_ids,
+                component_ids=self._pool_ref_store.component_ids,
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
@@ -126,7 +126,7 @@ def component_ids(self) -> abc.Set[int]:
         Returns:
             Set of managed component IDs.
         """
-        return self._pv_pool_ref.component_ids
+        return self._pool_ref_store.component_ids
 
     @property
     def power(self) -> FormulaEngine[Power]:
@@ -144,11 +144,11 @@ def power(self) -> FormulaEngine[Power]:
             A FormulaEngine that will calculate and stream the total power of all PV
                 Inverters.
         """
-        engine = self._pv_pool_ref.formula_pool.from_power_formula_generator(
+        engine = self._pool_ref_store.formula_pool.from_power_formula_generator(
             "pv_power",
             PVPowerFormula,
             FormulaGeneratorConfig(
-                component_ids=self._pv_pool_ref.component_ids,
+                component_ids=self._pool_ref_store.component_ids,
             ),
         )
         assert isinstance(engine, FormulaEngine)
@@ -169,14 +169,14 @@ def power_status(self) -> ReceiverFetcher[PVPoolReport]:
         sub = _power_managing.ReportRequest(
             source_id=self._source_id,
             priority=self._priority,
-            component_ids=self._pv_pool_ref.component_ids,
+            component_ids=self._pool_ref_store.component_ids,
         )
-        self._pv_pool_ref.power_bounds_subs[sub.get_channel_name()] = (
+        self._pool_ref_store.power_bounds_subs[sub.get_channel_name()] = (
             asyncio.create_task(
-                self._pv_pool_ref.power_manager_bounds_subs_sender.send(sub)
+                self._pool_ref_store.power_manager_bounds_subs_sender.send(sub)
             )
         )
-        channel = self._pv_pool_ref.channel_registry.get_or_create(
+        channel = self._pool_ref_store.channel_registry.get_or_create(
             _power_managing._Report,  # pylint: disable=protected-access
             sub.get_channel_name(),
         )
@@ -188,9 +188,9 @@ def power_status(self) -> ReceiverFetcher[PVPoolReport]:
 
     async def stop(self) -> None:
         """Stop all tasks and channels owned by the PVPool."""
-        await self._pv_pool_ref.stop()
+        await self._pool_ref_store.stop()
 
     @property
     def _system_power_bounds(self) -> ReceiverFetcher[SystemBounds]:
         """Return a receiver fetcher for the system power bounds."""
-        return self._pv_pool_ref.bounds_channel
+        return self._pool_ref_store.bounds_channel