Rename microgrid.pv_pool → microgrid.new_pv_pool

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

Author: shsms

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

@@ -184,7 +184,7 @@ def _add_system_bounds_tracker(self, component_ids: frozenset[int]) -> None:
             self._component_category is ComponentCategory.INVERTER
             and self._component_type is InverterType.SOLAR
         ):
-            pv_pool = microgrid.pv_pool(
+            pv_pool = microgrid.new_pv_pool(
                 priority=-sys.maxsize - 1, component_ids=component_ids
             )
             bounds_receiver = pv_pool._system_power_bounds.new_receiver()

src/frequenz/sdk/microgrid/__init__.py

@@ -85,7 +85,7 @@
 ## PV Arrays
 
 The total PV power production is available through
-[`pv_pool`][frequenz.sdk.microgrid.pv_pool]'s
+[`pv_pool`][frequenz.sdk.microgrid.new_pv_pool]'s
 [`power`][frequenz.sdk.timeseries.pv_pool.PVPool.power].  The PV pool by default uses
 all PV inverters available at a location, but PV pool instances can be created for
 subsets of PV inverters if necessary, by specifying the inverter ids.
@@ -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.
 
-* [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]
+* [PV pool][frequenz.sdk.microgrid.new_pv_pool]
 
 All of them provide support for streaming aggregated data and for setting the
 power values of the components.
@@ -232,8 +232,8 @@
     logical_meter,
     new_battery_pool,
     new_ev_charger_pool,
+    new_pv_pool,
     producer,
-    pv_pool,
     voltage,
 )
 
@@ -261,7 +261,7 @@ async def initialize(server_url: str, resampler_config: ResamplerConfig) -> None
     "logical_meter",
     "new_battery_pool",
     "new_ev_charger_pool",
+    "new_pv_pool",
     "producer",
-    "pv_pool",
     "voltage",
 ]

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -270,7 +270,7 @@ def new_ev_charger_pool(
             set_operating_point=set_operating_point,
         )
 
-    def pv_pool(
+    def new_pv_pool(
         self,
         *,
         priority: int,
@@ -616,7 +616,7 @@ def new_battery_pool(
     )
 
 
-def pv_pool(
+def new_pv_pool(
     *,
     priority: int,
     component_ids: abc.Set[int] | None = None,
@@ -653,7 +653,7 @@ def pv_pool(
     Returns:
         A `PVPool` instance.
     """
-    return _get().pv_pool(
+    return _get().new_pv_pool(
         priority=priority,
         component_ids=component_ids,
         name=name,

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

@@ -41,7 +41,7 @@ class LogicalMeter:
         )
 
         logical_meter = microgrid.logical_meter()
-        pv_pool = microgrid.pv_pool(priority=5)
+        pv_pool = microgrid.new_pv_pool(priority=5)
         grid = microgrid.grid()
 
         # Get a receiver for a builtin formula

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

@@ -44,8 +44,8 @@ def __init__(  # pylint: disable=too-many-arguments
 
         !!! note
             `PVPool` instances are not meant to be created directly by users. Use the
-            [`microgrid.pv_pool`][frequenz.sdk.microgrid.pv_pool] method for creating
-            `PVPool` instances.
+            [`microgrid.new_pv_pool`][frequenz.sdk.microgrid.new_pv_pool] method for
+            creating `PVPool` instances.
 
         Args:
             pool_ref_store: The reference store for the PV pool.

tests/timeseries/_formula_engine/test_formula_composition.py

@@ -38,7 +38,7 @@ async def test_formula_composition(  # pylint: disable=too-many-locals
             battery_pool = microgrid.new_battery_pool(priority=5)
             stack.push_async_callback(battery_pool.stop)
 
-            pv_pool = microgrid.pv_pool(priority=5)
+            pv_pool = microgrid.new_pv_pool(priority=5)
             stack.push_async_callback(pv_pool.stop)
 
             grid = microgrid.grid()
@@ -116,7 +116,7 @@ async def test_formula_composition_missing_pv(self, mocker: MockerFixture) -> No
             battery_pool = microgrid.new_battery_pool(priority=5)
             stack.push_async_callback(battery_pool.stop)
 
-            pv_pool = microgrid.pv_pool(priority=5)
+            pv_pool = microgrid.new_pv_pool(priority=5)
             stack.push_async_callback(pv_pool.stop)
 
             logical_meter = microgrid.logical_meter()
@@ -158,7 +158,7 @@ async def test_formula_composition_missing_bat(self, mocker: MockerFixture) -> N
             battery_pool = microgrid.new_battery_pool(priority=5)
             stack.push_async_callback(battery_pool.stop)
 
-            pv_pool = microgrid.pv_pool(priority=5)
+            pv_pool = microgrid.new_pv_pool(priority=5)
             stack.push_async_callback(pv_pool.stop)
 
             logical_meter = microgrid.logical_meter()

tests/timeseries/_pv_pool/test_pv_pool_control_methods.py

@@ -131,7 +131,7 @@ async def test_setting_power(  # pylint: disable=too-many-statements
         )
 
         await self._init_pv_inverters(mocks)
-        pv_pool = microgrid.pv_pool(priority=5)
+        pv_pool = microgrid.new_pv_pool(priority=5)
         bounds_rx = pv_pool.power_status.new_receiver()
         await self._recv_reports_until(
             bounds_rx,

tests/timeseries/test_formula_formatter.py

@@ -123,7 +123,7 @@ async def test_higher_order_formula(self, mocker: MockerFixture) -> None:
             logical_meter = microgrid.logical_meter()
             stack.push_async_callback(logical_meter.stop)
 
-            pv_pool = microgrid.pv_pool(priority=5)
+            pv_pool = microgrid.new_pv_pool(priority=5)
             stack.push_async_callback(pv_pool.stop)
 
             grid = microgrid.grid()

tests/timeseries/test_logical_meter.py

@@ -44,7 +44,7 @@ async def test_pv_power(self, mocker: MockerFixture) -> None:
         mockgrid.add_solar_inverters(2)
 
         async with mockgrid, AsyncExitStack() as stack:
-            pv_pool = microgrid.pv_pool(priority=5)
+            pv_pool = microgrid.new_pv_pool(priority=5)
             stack.push_async_callback(pv_pool.stop)
             pv_power_receiver = pv_pool.power.new_receiver()
 
@@ -57,7 +57,7 @@ async def test_pv_power_no_meter(self, mocker: MockerFixture) -> None:
         mockgrid.add_solar_inverters(2, no_meter=True)
 
         async with mockgrid, AsyncExitStack() as stack:
-            pv_pool = microgrid.pv_pool(priority=5)
+            pv_pool = microgrid.new_pv_pool(priority=5)
             stack.push_async_callback(pv_pool.stop)
             pv_power_receiver = pv_pool.power.new_receiver()
 
@@ -70,7 +70,7 @@ async def test_pv_power_no_pv_components(self, mocker: MockerFixture) -> None:
             MockMicrogrid(grid_meter=True, mocker=mocker) as mockgrid,
             AsyncExitStack() as stack,
         ):
-            pv_pool = microgrid.pv_pool(priority=5)
+            pv_pool = microgrid.new_pv_pool(priority=5)
             stack.push_async_callback(pv_pool.stop)
             pv_power_receiver = pv_pool.power.new_receiver()