Accept a in_shifting_group parameter, when creating a *_pool

And propagate it all the way to the power manager.

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

Author: shsms

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

@@ -33,6 +33,9 @@ class ReportRequest:
     priority: int
     """The priority of the actor ."""
 
+    in_shifting_group: bool
+    """Whether the proposal gets sent to the shifting group of the power manager."""
+
     def get_channel_name(self) -> str:
         """Get the channel name for the report request.
 
@@ -216,6 +219,9 @@ class Proposal:
     request_timeout: datetime.timedelta = datetime.timedelta(seconds=5.0)
     """The maximum amount of time to wait for the request to be fulfilled."""
 
+    in_shifting_group: bool
+    """Whether the proposal gets sent to the shifting group of the power manager."""
+
     def __lt__(self, other: Proposal) -> bool:
         """Compare two proposals by their priority.
 

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -199,6 +199,7 @@ def ev_charger_pool(
         priority: int,
         component_ids: abc.Set[int] | None = None,
         name: str | None = None,
+        in_shifting_group: bool = False,
     ) -> EVChargerPool:
         """Return the corresponding EVChargerPool instance for the given ids.
 
@@ -211,6 +212,8 @@ def ev_charger_pool(
                 EVChargerPool.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
 
         Returns:
             An EVChargerPool instance.
@@ -264,6 +267,7 @@ def ev_charger_pool(
             pool_ref_store=self._ev_charger_pool_reference_stores[ref_store_key],
             name=name,
             priority=priority,
+            in_shifting_group=in_shifting_group,
         )
 
     def pv_pool(
@@ -272,6 +276,7 @@ def pv_pool(
         priority: int,
         component_ids: abc.Set[int] | None = None,
         name: str | None = None,
+        in_shifting_group: bool = False,
     ) -> PVPool:
         """Return a new `PVPool` instance for the given ids.
 
@@ -284,6 +289,8 @@ def pv_pool(
                 `PVPool`.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
 
         Returns:
             A `PVPool` instance.
@@ -334,6 +341,7 @@ def pv_pool(
             pool_ref_store=self._pv_pool_reference_stores[ref_store_key],
             name=name,
             priority=priority,
+            in_shifting_group=in_shifting_group,
         )
 
     def battery_pool(
@@ -342,6 +350,7 @@ def battery_pool(
         priority: int,
         component_ids: abc.Set[int] | None = None,
         name: str | None = None,
+        in_shifting_group: bool = False,
     ) -> BatteryPool:
         """Return a new `BatteryPool` instance for the given ids.
 
@@ -354,6 +363,8 @@ def battery_pool(
                 `BatteryPool`.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
 
         Returns:
             A `BatteryPool` instance.
@@ -409,6 +420,7 @@ def battery_pool(
             pool_ref_store=self._battery_pool_reference_stores[ref_store_key],
             name=name,
             priority=priority,
+            in_shifting_group=in_shifting_group,
         )
 
     def _data_sourcing_request_sender(self) -> Sender[ComponentMetricRequest]:
@@ -519,6 +531,7 @@ def ev_charger_pool(
     priority: int,
     component_ids: abc.Set[int] | None = None,
     name: str | None = None,
+    in_shifting_group: bool = False,
 ) -> EVChargerPool:
     """Return a new `EVChargerPool` instance for the given parameters.
 
@@ -544,12 +557,17 @@ def ev_charger_pool(
             component graph are used.
         name: An optional name used to identify this instance of the pool or a
             corresponding actor in the logs.
+        in_shifting_group: Whether the power requests get sent to the shifting group
+            in the PowerManager or not.
 
     Returns:
         An `EVChargerPool` instance.
     """
     return _get().ev_charger_pool(
-        priority=priority, component_ids=component_ids, name=name
+        priority=priority,
+        component_ids=component_ids,
+        name=name,
+        in_shifting_group=in_shifting_group,
     )
 
 
@@ -558,6 +576,7 @@ def battery_pool(
     priority: int,
     component_ids: abc.Set[int] | None = None,
     name: str | None = None,
+    in_shifting_group: bool = False,
 ) -> BatteryPool:
     """Return a new `BatteryPool` instance for the given parameters.
 
@@ -583,12 +602,17 @@ def battery_pool(
             graph are used.
         name: An optional name used to identify this instance of the pool or a
             corresponding actor in the logs.
+        in_shifting_group: Whether the power requests get sent to the shifting group
+            in the PowerManager or not.
 
     Returns:
         A `BatteryPool` instance.
     """
     return _get().battery_pool(
-        priority=priority, component_ids=component_ids, name=name
+        priority=priority,
+        component_ids=component_ids,
+        name=name,
+        in_shifting_group=in_shifting_group,
     )
 
 
@@ -597,6 +621,7 @@ def pv_pool(
     priority: int,
     component_ids: abc.Set[int] | None = None,
     name: str | None = None,
+    in_shifting_group: bool = False,
 ) -> PVPool:
     """Return a new `PVPool` instance for the given parameters.
 
@@ -622,11 +647,18 @@ def pv_pool(
             graph are used.
         name: An optional name used to identify this instance of the pool or a
             corresponding actor in the logs.
+        in_shifting_group: Whether the power requests get sent to the shifting group
+            in the PowerManager or not.
 
     Returns:
         A `PVPool` instance.
     """
-    return _get().pv_pool(priority=priority, component_ids=component_ids, name=name)
+    return _get().pv_pool(
+        priority=priority,
+        component_ids=component_ids,
+        name=name,
+        in_shifting_group=in_shifting_group,
+    )
 
 
 def grid() -> Grid:

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

@@ -59,6 +59,7 @@ def __init__(
         pool_ref_store: BatteryPoolReferenceStore,
         name: str | None,
         priority: int,
+        in_shifting_group: bool,
     ):
         """Create a BatteryPool instance.
 
@@ -72,11 +73,14 @@ def __init__(
             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.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
         """
         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
+        self._in_shifting_group = in_shifting_group
 
     async def propose_power(
         self,
@@ -130,6 +134,7 @@ async def propose_power(
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
+                in_shifting_group=self._in_shifting_group,
             )
         )
 
@@ -176,6 +181,7 @@ async def propose_charge(
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
+                in_shifting_group=self._in_shifting_group,
             )
         )
 
@@ -224,6 +230,7 @@ async def propose_discharge(
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
+                in_shifting_group=self._in_shifting_group,
             )
         )
 
@@ -382,6 +389,7 @@ def power_status(self) -> ReceiverFetcher[BatteryPoolReport]:
             source_id=self._source_id,
             priority=self._priority,
             component_ids=self._pool_ref_store._batteries,
+            in_shifting_group=self._in_shifting_group,
         )
         self._pool_ref_store._power_bounds_subs[sub.get_channel_name()] = (
             asyncio.create_task(

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

@@ -45,6 +45,7 @@ def __init__(  # pylint: disable=too-many-arguments
         pool_ref_store: EVChargerPoolReferenceStore,
         name: str | None,
         priority: int,
+        in_shifting_group: bool,
     ) -> None:
         """Create an `EVChargerPool` instance.
 
@@ -58,11 +59,14 @@ def __init__(  # pylint: disable=too-many-arguments
             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.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
         """
         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
+        self._in_shifting_group = in_shifting_group
 
     async def propose_power(
         self,
@@ -128,6 +132,7 @@ async def propose_power(
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
+                in_shifting_group=self._in_shifting_group,
             )
         )
 
@@ -210,6 +215,7 @@ def power_status(self) -> ReceiverFetcher[EVChargerPoolReport]:
             source_id=self._source_id,
             priority=self._priority,
             component_ids=self._pool_ref_store.component_ids,
+            in_shifting_group=self._in_shifting_group,
         )
         self._pool_ref_store.power_bounds_subs[sub.get_channel_name()] = (
             asyncio.create_task(

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

@@ -38,6 +38,7 @@ def __init__(  # pylint: disable=too-many-arguments
         pool_ref_store: PVPoolReferenceStore,
         name: str | None,
         priority: int,
+        in_shifting_group: bool,
     ) -> None:
         """Initialize the instance.
 
@@ -50,11 +51,14 @@ def __init__(  # pylint: disable=too-many-arguments
             pool_ref_store: The reference store for the PV pool.
             name: The name of the PV pool.
             priority: The priority of the PV pool.
+            in_shifting_group: Whether the power requests get sent to the shifting group
+                in the PowerManager or not.
         """
         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
+        self._in_shifting_group = in_shifting_group
 
     async def propose_power(
         self,
@@ -117,6 +121,7 @@ async def propose_power(
                 priority=self._priority,
                 creation_time=asyncio.get_running_loop().time(),
                 request_timeout=request_timeout,
+                in_shifting_group=self._in_shifting_group,
             )
         )
 
@@ -171,6 +176,7 @@ def power_status(self) -> ReceiverFetcher[PVPoolReport]:
             source_id=self._source_id,
             priority=self._priority,
             component_ids=self._pool_ref_store.component_ids,
+            in_shifting_group=self._in_shifting_group,
         )
         self._pool_ref_store.power_bounds_subs[sub.get_channel_name()] = (
             asyncio.create_task(

tests/actor/_power_managing/test_matryoshka.py

@@ -53,6 +53,7 @@ def tgt_power(  # pylint: disable=too-many-arguments
                     if creation_time is not None
                     else asyncio.get_event_loop().time()
                 ),
+                in_shifting_group=False,
             ),
             self._system_bounds,
             must_send,