Skip to content

Remove iterator from function names #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwasicki merged 2 commits into from
Apr 19, 2024
Merged

Remove iterator from function names #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ced2e73
Replace iterate in method names
cwasicki Apr 12, 2024
46b7dd2
Update release notes
cwasicki Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

* The `ReportingClient` is renamed to `ReportingApiClient`.

* The client method `iterate_single_component` is renamed to `list_single_component_data`.

## New Features

## Bug Fixes
Expand Down
2 changes: 1 addition & 1 deletion examples/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def data_iter() -> AsyncIterator[MetricSample]:
Returns:
Iterator over single metric samples
"""
return client.iterate_single_component(
return client.list_single_component_data(
microgrid_id=microgrid_id,
component_id=component_id,
metrics=metrics,
Expand Down
6 changes: 3 additions & 3 deletions src/frequenz/client/reporting/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ def __init__(self, service_address: str):
self._stub = ReportingStub(self._grpc_channel)

# pylint: disable=too-many-arguments
async def iterate_single_component(
async def list_single_component_data(
self,
*,
microgrid_id: int,
Expand All @@ -147,7 +147,7 @@ async def iterate_single_component(
* timestamp: The timestamp of the metric sample.
* value: The metric value.
"""
async for page in self._iterate_components_data_pages(
async for page in self._list_microgrid_components_data_pages(
microgrid_components=[(microgrid_id, [component_id])],
metrics=[metrics] if isinstance(metrics, Metric) else metrics,
start_dt=start_dt,
Expand All @@ -158,7 +158,7 @@ async def iterate_single_component(
yield entry

# pylint: disable=too-many-arguments
async def _iterate_components_data_pages(
async def _list_microgrid_components_data_pages(
self,
*,
microgrid_components: list[tuple[int, list[int]]],
Expand Down