feat: Make list methods of CollectionClients iterable #556
Draft
feat: Make list methods of CollectionClients iterable #556
list methods of CollectionClients iterable #556Conversation
github-actions
bot
added
t-tooling
Pijukatel
force-pushed
the
iterable-list-methods
branch
from
9e6bb90 to
fdf4b3d
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #556 +/- ##
==========================================
+ Coverage 76.01% 79.58% +3.57%
==========================================
Files 42 42
Lines 2468 2508 +40
==========================================
+ Hits 1876 1996 +120
+ Misses 592 512 -80
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Pijukatel
force-pushed
the
iterable-list-methods
branch
3 times, most recently
from
a196f2c to
b561795
Compare
Pijukatel
force-pushed
the
iterable-list-methods
branch
from
b561795 to
5309bc6
Compare
Contributor
Author
|
It is in a working state, but first, the big changes in the client will be merged. So, pausing work on this until that is done. |
danpoletaev
force-pushed
the
iterable-list-methods
branch
from
5309bc6 to
cf67c9d
Compare
B4nan
force-pushed
the
iterable-list-methods
branch
from
cf67c9d to
5309bc6
Compare
Pijukatel
pushed a commit
that referenced
this pull request
Apr 17, 2026
Adds iteration support to all `list()` methods on collection clients and to `DatasetClient.list_items()`, so callers can iterate across pages without manually handling offset/limit/chunk_size state. Introduces `IterableListPage` (sync) and `IterableListPageAsync` (async) in `apify_client._iterable_list_page`. The sync wrapper exposes the page metadata fields (`items`, `count`, `offset`, `limit`, `total`, `desc`) and is iterable; the async wrapper is both awaitable (returns the first page) and asynchronously iterable (yields items across pages, performing additional API calls as needed). `DatasetClient.iterate_items()` is now deprecated — iterate the return value of `list_items()` instead. `list_items()` also gains a `chunk_size` parameter to control the per-request page size during iteration. Re-creates the intent of the draft PR #556 against the current codebase, which has since been restructured (resource clients moved under `_resource_clients/`, a single `ResourceClient` base, typed Pydantic response models replacing the old `ListPage` class). Usage: # Sync — single page (unchanged) or iterate across pages page = client.datasets().list() for dataset in client.datasets().list(): ... # Async — awaitable for single page, or async iterator across pages page = await client.datasets().list() async for dataset in client.datasets().list(): ... https://claude.ai/code/session_011VSSFo89Z9LfyFqZGsJKfz
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
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.
Description
TODO:
Example usage
Issues
Testing
Checklist