Update ReceiverFetcher to be compatible with Broadcast channels

The channel package recently renamed the `maxsize` parameter to
`limit`.  That is now done with the `ReceiverFetcher` and all classes
that implement the `ReceiverFetcher`.

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

Author: shsms

examples/battery_pool.py

@@ -30,10 +30,10 @@ async def main() -> None:
 
     battery_pool = microgrid.battery_pool()
     receivers = [
-        battery_pool.soc.new_receiver(maxsize=1),
-        battery_pool.capacity.new_receiver(maxsize=1),
+        battery_pool.soc.new_receiver(limit=1),
+        battery_pool.capacity.new_receiver(limit=1),
         # pylint: disable=protected-access
-        battery_pool._system_power_bounds.new_receiver(maxsize=1),
+        battery_pool._system_power_bounds.new_receiver(limit=1),
         # pylint: enable=protected-access
     ]
 

src/frequenz/sdk/_internal/_channels.py

@@ -16,11 +16,11 @@ class ReceiverFetcher(typing.Generic[T_co], typing.Protocol):
     """An interface that just exposes a `new_receiver` method."""
 
     @abc.abstractmethod
-    def new_receiver(self, *, maxsize: int = 50) -> Receiver[T_co]:
+    def new_receiver(self, *, limit: int = 50) -> Receiver[T_co]:
         """Get a receiver from the channel.
 
         Args:
-            maxsize: The maximum size of the receiver.
+            limit: The maximum size of the receiver.
 
         Returns:
             A receiver instance.

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

@@ -40,11 +40,11 @@ def update_working_batteries(self, new_working_batteries: set[int]) -> None:
         """
 
     @abstractmethod
-    def new_receiver(self, maxsize: int | None = RECEIVER_MAX_SIZE) -> Receiver[T]:
+    def new_receiver(self, limit: int | None = RECEIVER_MAX_SIZE) -> Receiver[T]:
         """Return new receiver for the aggregated metric results.
 
         Args:
-            maxsize: Buffer size of the receiver
+            limit: Buffer size of the receiver
 
         Returns:
             Receiver for the metric results.
@@ -119,18 +119,18 @@ def name(cls) -> str:
         """
         return "SendOnUpdate"
 
-    def new_receiver(self, maxsize: int | None = RECEIVER_MAX_SIZE) -> Receiver[T]:
+    def new_receiver(self, limit: int | None = RECEIVER_MAX_SIZE) -> Receiver[T]:
         """Return new receiver for the aggregated metric results.
 
         Args:
-            maxsize: Buffer size of the receiver
+            limit: Buffer size of the receiver
 
         Returns:
             Receiver for the metric results.
         """
-        if maxsize is None:
+        if limit is None:
             return self._result_channel.new_receiver()
-        return self._result_channel.new_receiver(limit=maxsize)
+        return self._result_channel.new_receiver(limit=limit)
 
     def update_working_batteries(self, new_working_batteries: set[int]) -> None:
         """Update set of the working batteries.

tests/timeseries/_battery_pool/test_battery_pool.py

@@ -644,7 +644,7 @@ async def run_capacity_test(  # pylint: disable=too-many-locals
             sampling_rate=0.05,
         )
 
-    capacity_receiver = battery_pool.capacity.new_receiver(maxsize=50)
+    capacity_receiver = battery_pool.capacity.new_receiver(limit=50)
 
     # First metrics delivers slower because of the startup delay in the pool.
     msg = await asyncio.wait_for(
@@ -838,7 +838,7 @@ async def run_soc_test(setup_args: SetupArgs) -> None:
             sampling_rate=0.05,
         )
 
-    receiver = battery_pool.soc.new_receiver(maxsize=50)
+    receiver = battery_pool.soc.new_receiver(limit=50)
 
     # First metrics delivers slower because of the startup delay in the pool.
     msg = await asyncio.wait_for(
@@ -992,7 +992,7 @@ async def run_power_bounds_test(  # pylint: disable=too-many-locals
             )
 
     # pylint: disable=protected-access
-    receiver = battery_pool._system_power_bounds.new_receiver(maxsize=50)
+    receiver = battery_pool._system_power_bounds.new_receiver(limit=50)
     # pylint: enable=protected-access
 
     # First metrics delivers slower because of the startup delay in the pool.