Rename BatteryPool -> BatteryPoolReferenceStore

Also make it a private module.  In a subsequent commit, the current
`BatteryPoolWrapper` will be renamed to `BatteryPool`, as the only
public interface.

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

Author: shsms

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -38,7 +38,10 @@
         Request,
         Result,
     )
-    from ..timeseries.battery_pool import BatteryPool, BatteryPoolWrapper
+    from ..timeseries.battery_pool import BatteryPoolWrapper
+    from ..timeseries.battery_pool._battery_pool_reference_store import (
+        BatteryPoolReferenceStore,
+    )
     from ..timeseries.ev_charger_pool import EVChargerPool
     from ..timeseries.logical_meter import LogicalMeter
 
@@ -110,7 +113,7 @@ def __init__(
 
         self._logical_meter: LogicalMeter | None = None
         self._ev_charger_pools: dict[frozenset[int], EVChargerPool] = {}
-        self._battery_pools: dict[frozenset[int], BatteryPool] = {}
+        self._battery_pools: dict[frozenset[int], BatteryPoolReferenceStore] = {}
         self._frequency_pool: dict[int, GridFrequency] = {}
 
     def frequency(self, component: Component | None = None) -> GridFrequency:
@@ -206,7 +209,10 @@ def battery_pool(
         Returns:
             A BatteryPoolWrapper instance.
         """
-        from ..timeseries.battery_pool import BatteryPool, BatteryPoolWrapper
+        from ..timeseries.battery_pool import BatteryPoolWrapper
+        from ..timeseries.battery_pool._battery_pool_reference_store import (
+            BatteryPoolReferenceStore,
+        )
 
         if not self._power_managing_actor:
             self._start_power_managing_actor()
@@ -217,7 +223,7 @@ def battery_pool(
             key = frozenset(battery_ids)
 
         if key not in self._battery_pools:
-            self._battery_pools[key] = BatteryPool(
+            self._battery_pools[key] = BatteryPoolReferenceStore(
                 channel_registry=self._channel_registry,
                 resampler_subscription_sender=self._resampling_request_sender(),
                 batteries_status_receiver=self._battery_status_channel.new_receiver(

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

@@ -5,10 +5,8 @@
 
 from ._battery_pool_wrapper import BatteryPoolWrapper
 from ._result_types import PowerMetrics
-from .battery_pool import BatteryPool
 
 __all__ = [
-    "BatteryPool",
     "BatteryPoolWrapper",
     "PowerMetrics",
 ]

…/timeseries/battery_pool/battery_pool.py …ry_pool/_battery_pool_reference_store.pysrc/frequenz/sdk/timeseries/battery_pool/battery_pool.py renamed to src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py src/frequenz/sdk/timeseries/battery_pool/battery_pool.py renamed to src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py

@@ -21,8 +21,15 @@
 from ._methods import MetricAggregator
 
 
-class BatteryPool:  # pylint: disable=too-many-instance-attributes
-    """A class for maintaining the state/tasks for a set of pool of batteries.
+class BatteryPoolReferenceStore:  # pylint: disable=too-many-instance-attributes
+    """A class for maintaining the shared state/tasks for a set of pool of batteries.
+
+    This includes ownership of
+    - the formula engine pool and metric calculators.
+    - the tasks for updating the battery status for the metric calculators.
+
+    These are independent of the priority of the actors, and can be shared between
+    multiple users of the same set of batteries.
 
     They are exposed through the BatteryPoolWrapper class.
     """

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

@@ -23,6 +23,7 @@
     FormulaGeneratorConfig,
     FormulaType,
 )
+from ._battery_pool_reference_store import BatteryPoolReferenceStore
 from ._methods import SendOnUpdate
 from ._metric_calculator import (
     CapacityCalculator,
@@ -31,29 +32,33 @@
     TemperatureCalculator,
 )
 from ._result_types import PowerMetrics
-from .battery_pool import BatteryPool
 
 # pylint: disable=protected-access
 
 
 class BatteryPoolWrapper:
     """The BatteryPoolWrapper is the external interface for the BatteryPool.
 
-    BatteryPool instances are unique to a set of batteries.  The BatteryPoolWrapper
-    provides an abstraction over actor priorities when multiple actors want to use the
-    same set of batteries.
+    BatteryPoolReferenceStore instances are unique to a set of batteries.  The
+    BatteryPoolWrapper provides an abstraction over actor priorities when multiple
+    actors want to use the same set of batteries.
     """
 
-    def __init__(self, battery_pool: BatteryPool, name: str | None, priority: int):
+    def __init__(
+        self,
+        battery_pool_ref: BatteryPoolReferenceStore,
+        name: str | None,
+        priority: int,
+    ):
         """Create a BatteryPoolWrapper instance.
 
         Args:
-            battery_pool: The battery pool to wrap.
+            battery_pool_ref: 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
+        self._battery_pool = battery_pool_ref
         unique_id = str(uuid.uuid4())
         self._source_id = unique_id if name is None else f"{name}-{unique_id}"
         self._priority = priority