Specify priority and kw arguments in calls to *_pool methods

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

Author: shsms

benchmarks/power_distribution/power_distributor.py

@@ -50,7 +50,7 @@ async def send_requests(batteries: set[int], request_num: int) -> list[Result]:
     Returns:
         List of the results from the PowerDistributingActor.
     """
-    battery_pool = microgrid.battery_pool(batteries)
+    battery_pool = microgrid.battery_pool(priority=5, component_ids=batteries)
     results_rx = battery_pool.power_status.new_receiver()
     result: list[Any] = []
     for _ in range(request_num):

examples/battery_pool.py

@@ -28,7 +28,7 @@ async def main() -> None:
         resampler_config=ResamplerConfig(resampling_period=timedelta(seconds=1.0)),
     )
 
-    battery_pool = microgrid.battery_pool()
+    battery_pool = microgrid.battery_pool(priority=5)
     receivers = [
         battery_pool.soc.new_receiver(limit=1),
         battery_pool.capacity.new_receiver(limit=1),

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

@@ -7,6 +7,7 @@
 
 import asyncio
 import logging
+import sys
 import typing
 from datetime import datetime, timedelta, timezone
 
@@ -146,16 +147,22 @@ def _add_bounds_tracker(self, component_ids: frozenset[int]) -> None:
         bounds_receiver: Receiver[SystemBounds]
         # pylint: disable=protected-access
         if self._component_category is ComponentCategory.BATTERY:
-            battery_pool = microgrid.battery_pool(component_ids)
+            battery_pool = microgrid.battery_pool(
+                priority=-sys.maxsize - 1, component_ids=component_ids
+            )
             bounds_receiver = battery_pool._system_power_bounds.new_receiver()
         elif self._component_category is ComponentCategory.EV_CHARGER:
-            ev_charger_pool = microgrid.ev_charger_pool(component_ids)
+            ev_charger_pool = microgrid.ev_charger_pool(
+                priority=-sys.maxsize - 1, component_ids=component_ids
+            )
             bounds_receiver = ev_charger_pool._system_power_bounds.new_receiver()
         elif (
             self._component_category is ComponentCategory.INVERTER
             and self._component_type is InverterType.SOLAR
         ):
-            pv_pool = microgrid.pv_pool(component_ids)
+            pv_pool = microgrid.pv_pool(
+                priority=-sys.maxsize - 1, component_ids=component_ids
+            )
             bounds_receiver = pv_pool._system_power_bounds.new_receiver()
         # pylint: enable=protected-access
         else:

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

@@ -66,7 +66,9 @@ def adjust_to_bounds(self, power: Power) -> tuple[Power | None, Power | None]:
             ```python
             from frequenz.sdk import microgrid
 
-            power_status_rx = microgrid.battery_pool().power_status.new_receiver()
+            power_status_rx = microgrid.battery_pool(
+                priority=5,
+            ).power_status.new_receiver()
             power_status = await power_status_rx.receive()
             desired_power = Power.from_watts(1000.0)
 

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

@@ -253,7 +253,7 @@ class FormulaEngine(
     ```python
     from frequenz.sdk import microgrid
 
-    battery_pool = microgrid.battery_pool()
+    battery_pool = microgrid.battery_pool(priority=5)
 
     async for power in battery_pool.power.new_receiver():
         print(f"{power=}")
@@ -277,8 +277,8 @@ class FormulaEngine(
     from frequenz.sdk import microgrid
 
     logical_meter = microgrid.logical_meter()
-    battery_pool = microgrid.battery_pool()
-    ev_charger_pool = microgrid.ev_charger_pool()
+    battery_pool = microgrid.battery_pool(priority=5)
+    ev_charger_pool = microgrid.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()
+    ev_charger_pool = microgrid.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()
+    ev_charger_pool = microgrid.ev_charger_pool(priority=5)
     grid = microgrid.grid()
 
     # Calculate grid consumption current that's not used by the EV chargers

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

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

tests/microgrid/test_datapipeline.py

@@ -71,7 +71,7 @@ async def test_actors_started(
     )
     mock_client.initialize(mocker)
 
-    datapipeline.battery_pool()
+    datapipeline.battery_pool(priority=5)
 
     assert datapipeline._battery_power_wrapper._power_distributing_actor is not None
     await asyncio.sleep(1)

tests/timeseries/_battery_pool/test_battery_pool.py

@@ -158,7 +158,7 @@ async def setup_all_batteries(mocker: MockerFixture) -> AsyncIterator[SetupArgs]
     # the scope of this tests. This tests should cover BatteryPool only.
     # We use our own battery status channel, where we easily control set of working
     # batteries.
-    battery_pool = microgrid.battery_pool()
+    battery_pool = microgrid.battery_pool(priority=5)
 
     dp = microgrid._data_pipeline._DATA_PIPELINE
     assert dp is not None
@@ -212,7 +212,9 @@ async def setup_batteries_pool(mocker: MockerFixture) -> AsyncIterator[SetupArgs
     # batteries.
     all_batteries = list(get_components(mock_microgrid, ComponentCategory.BATTERY))
 
-    battery_pool = microgrid.battery_pool(set(all_batteries[:2]))
+    battery_pool = microgrid.battery_pool(
+        priority=5, component_ids=set(all_batteries[:2])
+    )
 
     dp = microgrid._data_pipeline._DATA_PIPELINE
     assert dp is not None
@@ -548,7 +550,7 @@ async def test_batter_pool_power_no_batteries(mocker: MockerFixture) -> None:
         )
     )
     await mockgrid.start(mocker)
-    battery_pool = microgrid.battery_pool()
+    battery_pool = microgrid.battery_pool(priority=5)
     power_receiver = battery_pool.power.new_receiver()
 
     await mockgrid.mock_resampler.send_non_existing_component_value()
@@ -565,7 +567,7 @@ async def test_battery_pool_power_with_no_inverters(mocker: MockerFixture) -> No
     await mockgrid.start(mocker)
 
     with pytest.raises(RuntimeError):
-        microgrid.battery_pool()
+        microgrid.battery_pool(priority=5)
 
 
 async def test_battery_pool_power_incomplete_bat_request(mocker: MockerFixture) -> None:
@@ -588,7 +590,7 @@ async def test_battery_pool_power_incomplete_bat_request(mocker: MockerFixture)
     with pytest.raises(FormulaGenerationError):
         # Request only two of the three batteries behind the inverters
         battery_pool = microgrid.battery_pool(
-            component_ids=set([bats[1].component_id, bats[0].component_id])
+            priority=5, component_ids=set([bats[1].component_id, bats[0].component_id])
         )
         power_receiver = battery_pool.power.new_receiver()
         await mockgrid.mock_resampler.send_bat_inverter_power([2.0])
@@ -597,7 +599,7 @@ async def test_battery_pool_power_incomplete_bat_request(mocker: MockerFixture)
 
 async def _test_battery_pool_power(mockgrid: MockMicrogrid) -> None:
     async with mockgrid:
-        battery_pool = microgrid.battery_pool()
+        battery_pool = microgrid.battery_pool(priority=5)
         power_receiver = battery_pool.power.new_receiver()
 
         await mockgrid.mock_resampler.send_bat_inverter_power([2.0, 3.0])

tests/timeseries/_battery_pool/test_battery_pool_control_methods.py

@@ -188,7 +188,7 @@ async def test_case_1(
         await self._init_data_for_batteries(mocks)
         await self._init_data_for_inverters(mocks)
 
-        battery_pool = microgrid.battery_pool()
+        battery_pool = microgrid.battery_pool(priority=5)
 
         bounds_rx = battery_pool.power_status.new_receiver()
 
@@ -283,9 +283,13 @@ async def test_case_2(self, mocks: Mocks, mocker: MockerFixture) -> None:
         await self._init_data_for_batteries(mocks)
         await self._init_data_for_inverters(mocks)
 
-        battery_pool_1 = microgrid.battery_pool(set(mocks.microgrid.battery_ids[:2]))
+        battery_pool_1 = microgrid.battery_pool(
+            priority=5, component_ids=set(mocks.microgrid.battery_ids[:2])
+        )
         bounds_1_rx = battery_pool_1.power_status.new_receiver()
-        battery_pool_2 = microgrid.battery_pool(set(mocks.microgrid.battery_ids[2:]))
+        battery_pool_2 = microgrid.battery_pool(
+            priority=5, component_ids=set(mocks.microgrid.battery_ids[2:])
+        )
         bounds_2_rx = battery_pool_2.power_status.new_receiver()
 
         self._assert_report(
@@ -389,7 +393,7 @@ async def test_case_4(self, mocks: Mocks, mocker: MockerFixture) -> None:
         await self._init_data_for_batteries(mocks, exclusion_bounds=(-100.0, 100.0))
         await self._init_data_for_inverters(mocks)
 
-        battery_pool = microgrid.battery_pool()
+        battery_pool = microgrid.battery_pool(priority=5)
         bounds_rx = battery_pool.power_status.new_receiver()
 
         self._assert_report(

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()
+            ev_pool = microgrid.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])