Skip to content

feat: Remove collect helper method from ListIterator/ListStream #31

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
kylebarron merged 2 commits into from
May 21, 2025
+2 −19
Merged

feat: Remove collect helper method from ListIterator/ListStream #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a084b08
Remove `collect` helper method from `ListIterator`/`ListStream`
kylebarron May 21, 2025
e892f93
fix docstring
kylebarron May 21, 2025
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
21 changes: 2 additions & 19 deletions src/obspec/_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,6 @@ def __iter__(self) -> Self:
"""Return `Self` as an async iterator."""
...

def collect(self) -> ListChunkType_co:
"""Collect all remaining ObjectMeta objects in the stream.

This ignores the `chunk_size` parameter from the `list` call and collects all
remaining data into a single chunk.
"""
...

def __next__(self) -> ListChunkType_co:
"""Return the next chunk of ObjectMeta in the stream."""
...
Expand All @@ -69,14 +61,6 @@ def __aiter__(self) -> Self:
"""Return `Self` as an async iterator."""
...

async def collect_async(self) -> ListChunkType_co:
"""Collect all remaining ObjectMeta objects in the stream.

This ignores the `chunk_size` parameter from the `list` call and collects all
remaining data into a single chunk.
"""
...

async def __anext__(self) -> ListChunkType_co:
"""Return the next chunk of ObjectMeta in the stream."""
...
Expand Down Expand Up @@ -127,7 +111,7 @@ def list(
location greater than `offset`. Defaults to `None`.
chunk_size: The number of items to collect per chunk in the returned
(async) iterator. All chunks except for the last one will have this many
items. This is ignored in [`collect`][obspec.ListIterator.collect].
items.

Returns:
A ListStream, which you can iterate through to access list results.
Expand Down Expand Up @@ -175,8 +159,7 @@ def list_async(
location greater than `offset`. Defaults to `None`.
chunk_size: The number of items to collect per chunk in the returned
(async) iterator. All chunks except for the last one will have this many
items. This is ignored in
[`collect_async`][obspec.ListStream.collect_async].
items.

Returns:
A ListStream, which you can iterate through to access list results.
Expand Down
Loading