Update components retrival functions

Signed-off-by: Flora <[email protected]>

Author: flora-hofmann-frequenz

RELEASE_NOTES.md

@@ -7,6 +7,8 @@
 ## Upgrading
 
 * Change 'start_dt' and 'end_dt' to 'start_time' and 'end_time' respectively.
+* Rename 'list' to 'receive' in component data retrival functions
+* Return the receiver directly in '_recieve_microgrid_components_data_batch'
 
 ## New Features
 

src/frequenz/client/reporting/_client.py

@@ -234,7 +234,7 @@ def stub(self) -> ReportingStub:
         return self._stub
 
     # pylint: disable=too-many-arguments
-    async def list_single_component_data(
+    async def receive_single_component_data(
         self,
         *,
         microgrid_id: int,
@@ -263,20 +263,21 @@ async def list_single_component_data(
             * timestamp: The timestamp of the metric sample.
             * value: The metric value.
         """
-        async for batch in self._list_microgrid_components_data_batch(
+        receiver = await self._receive_microgrid_components_data_batch(
             microgrid_components=[(microgrid_id, [component_id])],
             metrics=[metrics] if isinstance(metrics, Metric) else metrics,
             start_time=start_time,
             end_time=end_time,
             resampling_period=resampling_period,
             include_states=include_states,
             include_bounds=include_bounds,
-        ):
+        )
+        async for batch in receiver:
             for entry in batch:
                 yield entry
 
     # pylint: disable=too-many-arguments
-    async def list_microgrid_components_data(
+    async def receive_microgrid_components_data(
         self,
         *,
         microgrid_components: list[tuple[int, list[int]]],
@@ -307,21 +308,22 @@ async def list_microgrid_components_data(
             * timestamp: The timestamp of the metric sample.
             * value: The metric value.
         """
-        async for batch in self._list_microgrid_components_data_batch(
+        receiver = await self._receive_microgrid_components_data_batch(
             microgrid_components=microgrid_components,
             metrics=[metrics] if isinstance(metrics, Metric) else metrics,
             start_time=start_time,
             end_time=end_time,
             resampling_period=resampling_period,
             include_states=include_states,
             include_bounds=include_bounds,
-        ):
+        )
+        async for batch in receiver:
             for entry in batch:
                 yield entry
 
     # pylint: disable=too-many-arguments
     # pylint: disable=too-many-locals
-    async def _list_microgrid_components_data_batch(
+    async def _receive_microgrid_components_data_batch(
         self,
         *,
         microgrid_components: list[tuple[int, list[int]]],
@@ -343,7 +345,7 @@ async def _list_microgrid_components_data_batch(
             include_states: Whether to include the state data.
             include_bounds: Whether to include the bound data.
 
-        Yields:
+        Returns:
             A ComponentsDataBatch object of microgrid components data.
         """
         microgrid_components_pb = [
@@ -426,9 +428,7 @@ async def stream_method() -> (
             retry_strategy=None,
         )
 
-        receiver = broadcaster.new_receiver()
-        async for data in receiver:
-            yield data
+        return broadcaster.new_receiver()
 
     # pylint: disable=too-many-arguments
     async def receive_single_sensor_data(

src/frequenz/client/reporting/cli/__main__.py

@@ -158,7 +158,7 @@ async def data_iter() -> AsyncIterator[MetricSample]:
             else None
         )
 
-        async for sample in client.list_microgrid_components_data(
+        async for sample in client.receive_microgrid_components_data(
             microgrid_components=microgrid_components,
             metrics=metrics,
             start_time=start_time,