Rename microgrid.ev_charger_pool → microgrid.new_ev_charger_pool

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

Author: shsms

src/frequenz/sdk/actor/_power_managing/_power_managing_actor.py

@@ -176,7 +176,7 @@ def _add_system_bounds_tracker(self, component_ids: frozenset[int]) -> None:
             )
             bounds_receiver = battery_pool._system_power_bounds.new_receiver()
         elif self._component_category is ComponentCategory.EV_CHARGER:
-            ev_charger_pool = microgrid.ev_charger_pool(
+            ev_charger_pool = microgrid.new_ev_charger_pool(
                 priority=-sys.maxsize - 1, component_ids=component_ids
             )
             bounds_receiver = ev_charger_pool._system_power_bounds.new_receiver()

src/frequenz/sdk/microgrid/__init__.py

@@ -123,7 +123,7 @@
 
 ## EV Chargers
 
-The [`ev_charger_pool`][frequenz.sdk.microgrid.ev_charger_pool] offers a
+The [`ev_charger_pool`][frequenz.sdk.microgrid.new_ev_charger_pool] offers a
 [`power`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.power] method that
 streams the total power measured for all the {{glossary("ev-charger", "EV Chargers")}}
 at a site.
@@ -143,9 +143,9 @@
 The SDK provides a unified interface for interacting with sets of Batteries, EV
 chargers and PV arrays, through their corresponding `Pool`s.
 
-* [EV charger pool][frequenz.sdk.microgrid.ev_charger_pool]
 * [PV pool][frequenz.sdk.microgrid.pv_pool]
 * [Battery pool][frequenz.sdk.microgrid.new_battery_pool]
+* [EV charger pool][frequenz.sdk.microgrid.new_ev_charger_pool]
 
 All of them provide support for streaming aggregated data and for setting the
 power values of the components.
@@ -227,11 +227,11 @@
 from . import _data_pipeline, connection_manager
 from ._data_pipeline import (
     consumer,
-    ev_charger_pool,
     frequency,
     grid,
     logical_meter,
     new_battery_pool,
+    new_ev_charger_pool,
     producer,
     pv_pool,
     voltage,
@@ -256,11 +256,11 @@ async def initialize(server_url: str, resampler_config: ResamplerConfig) -> None
 __all__ = [
     "initialize",
     "consumer",
-    "ev_charger_pool",
     "grid",
     "frequency",
     "logical_meter",
     "new_battery_pool",
+    "new_ev_charger_pool",
     "producer",
     "pv_pool",
     "voltage",

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -193,7 +193,7 @@ def grid(self) -> Grid:
 
         return self._grid
 
-    def ev_charger_pool(
+    def new_ev_charger_pool(
         self,
         *,
         priority: int,
@@ -526,7 +526,7 @@ def producer() -> Producer:
     return _get().producer()
 
 
-def ev_charger_pool(
+def new_ev_charger_pool(
     *,
     priority: int,
     component_ids: abc.Set[int] | None = None,
@@ -563,7 +563,7 @@ def ev_charger_pool(
     Returns:
         An `EVChargerPool` instance.
     """
-    return _get().ev_charger_pool(
+    return _get().new_ev_charger_pool(
         priority=priority,
         component_ids=component_ids,
         name=name,

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

@@ -50,8 +50,10 @@ def __init__(  # pylint: disable=too-many-arguments
         """Create an `EVChargerPool` instance.
 
         !!! note
+
             `EVChargerPool` instances are not meant to be created directly by users. Use
-            the [`microgrid.ev_charger_pool`][frequenz.sdk.microgrid.ev_charger_pool]
+            the
+            [`microgrid.new_ev_charger_pool`][frequenz.sdk.microgrid.new_ev_charger_pool]
             method for creating `EVChargerPool` instances.
 
         Args:

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

@@ -266,8 +266,8 @@ class FormulaEngine(
 
     For example, if you're interested in a particular composite metric that can be
     calculated by subtracting
-    [`battery_pool().power`][frequenz.sdk.timeseries.battery_pool.BatteryPool.power] and
-    [`ev_charger_pool().power`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool]
+    [`new_battery_pool().power`][frequenz.sdk.timeseries.battery_pool.BatteryPool.power] and
+    [`new_ev_charger_pool().power`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool]
     from the
     [`grid().power`][frequenz.sdk.timeseries.grid.Grid.power],
     we can build a `FormulaEngine` that provides a stream of this calculated metric as
@@ -277,8 +277,8 @@ class FormulaEngine(
     from frequenz.sdk import microgrid
 
     logical_meter = microgrid.logical_meter()
-    ev_charger_pool = microgrid.ev_charger_pool(priority=5)
     battery_pool = microgrid.new_battery_pool(priority=5)
+    ev_charger_pool = microgrid.new_ev_charger_pool(priority=5)
     grid = microgrid.grid()
 
     # apply operations on formula engines to create a formula engine that would
@@ -459,7 +459,7 @@ class FormulaEngine3Phase(
     ```python
     from frequenz.sdk import microgrid
 
-    ev_charger_pool = microgrid.ev_charger_pool(priority=5)
+    ev_charger_pool = microgrid.new_ev_charger_pool(priority=5)
 
     async for sample in ev_charger_pool.current.new_receiver():
         print(f"Current: {sample}")
@@ -474,7 +474,7 @@ class FormulaEngine3Phase(
     from frequenz.sdk import microgrid
 
     logical_meter = microgrid.logical_meter()
-    ev_charger_pool = microgrid.ev_charger_pool(priority=5)
+    ev_charger_pool = microgrid.new_ev_charger_pool(priority=5)
     grid = microgrid.grid()
 
     # Calculate grid consumption current that's not used by the EV chargers

tests/timeseries/_ev_charger_pool/test_ev_charger_pool.py

@@ -23,7 +23,7 @@ async def test_ev_power(  # pylint: disable=too-many-locals
         mockgrid.add_ev_chargers(3)
 
         async with mockgrid:
-            ev_pool = microgrid.ev_charger_pool(priority=5)
+            ev_pool = microgrid.new_ev_charger_pool(priority=5)
             power_receiver = ev_pool.power.new_receiver()
 
             await mockgrid.mock_resampler.send_evc_power([2.0, 4.0, 10.0])

tests/timeseries/_ev_charger_pool/test_ev_charger_pool_control_methods.py

@@ -206,7 +206,7 @@ async def test_setting_power(
         )
 
         await self._init_ev_chargers(mocks)
-        ev_charger_pool = microgrid.ev_charger_pool(priority=5)
+        ev_charger_pool = microgrid.new_ev_charger_pool(priority=5)
         await self._patch_ev_pool_status(mocks, mocker)
         await self._patch_power_distributing_actor(mocker)
 

tests/timeseries/_formula_engine/test_formula_composition.py

@@ -395,7 +395,7 @@ async def test_3_phase_formulas(self, mocker: MockerFixture) -> None:
             logical_meter = microgrid.logical_meter()
             stack.push_async_callback(logical_meter.stop)
 
-            ev_pool = microgrid.ev_charger_pool(priority=5)
+            ev_pool = microgrid.new_ev_charger_pool(priority=5)
             stack.push_async_callback(ev_pool.stop)
 
             grid = microgrid.grid()