Fix: Change list method parameters from Iterator to Iterable for better API usability #223
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Marenz
requested review from
Copilot,
ela-kotulska-frequenz and
stefan-brus-frequenz
There was a problem hiding this comment.
Pull Request Overview
This PR improves the API usability of the dispatch client by changing parameter types from Iterator to Iterable. The change allows users to pass any iterable collection (lists, tuples, generators, etc.) instead of requiring specific iterator types, making the API more flexible and user-friendly.
- Updated type hints from Iterator to Iterable for three parameters in the list method
- Changed default values from iter(()) to () for consistency with the new types
- Added release note documenting the improvement
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frequenz/client/dispatch/_client.py | Updated list method parameter types and defaults to accept Iterable instead of Iterator |
| RELEASE_NOTES.md | Added bug fix entry documenting the API improvement |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
llucax
previously approved these changes
Oct 13, 2025
RELEASE_NOTES.md
Outdated
|
|
||
| ## Bug Fixes | ||
|
|
||
| * Changed `target_components`, `dispatch_ids`, and `filter_queries` parameters from `Iterator` to `Iterable` in `list` method for better API usability |
There was a problem hiding this comment.
Nitpick, I would put this as a "new feature", nothing was really broken, we are just accepting a wider range of parameters.
…er API usability - Changed target_components, dispatch_ids, and filter_queries parameters from Iterator to Iterable in the list method - This allows users to pass any iterable (list, tuple, generator, etc.) instead of requiring specific iterator types - Improves API flexibility and usability Signed-off-by: Mathias L. Baumann <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
from Iterator to Iterable in the list method
instead of requiring specific iterator types