Review comments

Author: Pijukatel

scripts/_utils.py

@@ -27,6 +27,7 @@
     (re.compile(r'\bSynchronous\b'), 'Asynchronous'),
     (re.compile(r'Retry a function'), 'Retry an async function'),
     (re.compile(r'Function to retry'), 'Async function to retry'),
+    (re.compile(r'returned page also supports iteration: `for'), 'returned page also supports iteration: `async for'),
 ]
 """Patterns for converting sync docstrings to async docstrings."""
 

src/apify_client/_iterable_list_page.py

@@ -91,14 +91,14 @@ class IterableListPage(ListPage[T], Iterable[T], Generic[T]):
     yields individual items and performs additional API calls as needed to fetch further pages.
     """
 
-    def __init__(self, first_page: HasItems[T], iterator: Iterator[T]) -> None:
+    def __init__(self, first_page: HasItems[T], get_iterator: Callable[[], Iterator[T]]) -> None:
         """Initialize a page wrapper from a Pydantic paginated model and an iterator over all items."""
         super().__init__(first_page)
-        self._iterator = iterator
+        self._get_iterator = get_iterator
 
     def __iter__(self) -> Iterator[T]:
         """Return an iterator over all items across pages, fetching additional pages as needed."""
-        return self._iterator
+        return self._get_iterator()
 
 
 @docs_group('Other')
@@ -113,15 +113,15 @@ class IterableListPageAsync(AsyncIterable[T], Generic[T]):
     def __init__(
         self,
         awaitable_first_page: Callable[[], Awaitable[ListPage[T]]],
-        async_iterator: AsyncIterator[T],
+        get_async_iterator: Callable[[], AsyncIterator[T]],
     ) -> None:
         """Initialize with a factory that creates the awaitable on demand and the async iterator over items."""
         self._awaitable_first_page = awaitable_first_page
-        self._async_iterator = async_iterator
+        self._get_async_iterator = get_async_iterator
 
     def __aiter__(self) -> AsyncIterator[T]:
         """Return an asynchronous iterator over all items across pages."""
-        return self._async_iterator
+        return self._get_async_iterator()
 
     def __await__(self) -> Generator[Any, Any, ListPage[T]]:
         """Return an awaitable that resolves to an `IterableListPage` containing the first page."""
@@ -161,7 +161,7 @@ def build_iterable_list_page(
 
     first_page = callback(**{**kwargs, 'limit': _min_for_limit_param(kwargs.get('limit'), chunk_size)})
 
-    def iterator() -> Iterator[T]:
+    def get_iterator() -> Iterator[T]:
         current_page = first_page
         yield from current_page.items
 
@@ -176,7 +176,7 @@ def iterator() -> Iterator[T]:
             yield from current_page.items
             fetched_items += getattr(current_page, 'count', len(current_page.items))
 
-    return IterableListPage(first_page, iterator())
+    return IterableListPage(first_page, get_iterator)
 
 
 def build_iterable_list_page_async(
@@ -196,7 +196,7 @@ def build_iterable_list_page_async(
     # Can be awaited multiple times with same result, but not scheduled at this time yet, as it might be pre-emptive.
     fetch_first_page = _LazyTask(callback(**{**kwargs, 'limit': _min_for_limit_param(kwargs.get('limit'), chunk_size)}))
 
-    async def async_iterator() -> AsyncIterator[Any]:
+    async def get_async_iterator() -> AsyncIterator[Any]:
         current_page = await fetch_first_page
         for item in current_page.items:
             yield item
@@ -217,7 +217,7 @@ async def wrap_first_page() -> ListPage[Any]:
         first_page = await fetch_first_page
         return ListPage(first_page)
 
-    return IterableListPageAsync(wrap_first_page, async_iterator())
+    return IterableListPageAsync(wrap_first_page, get_async_iterator)
 
 
 def build_cursor_iterable_list_page(
@@ -242,7 +242,7 @@ def build_cursor_iterable_list_page(
     first_limit = _min_for_limit_param(limit, effective_chunk)
     first_page = callback(**{**kwargs, cursor_param: initial_cursor, 'limit': first_limit})
 
-    def iterator() -> Iterator[Any]:
+    def get_iterator() -> Iterator[Any]:
         current_page = first_page
         yield from current_page.items
 
@@ -257,7 +257,7 @@ def iterator() -> Iterator[Any]:
             fetched += len(current_page.items)
             next_cursor = getattr(current_page, f'next_{cursor_param}')
 
-    return IterableListPage(first_page, iterator())
+    return IterableListPage(first_page, get_iterator)
 
 
 def build_cursor_iterable_list_page_async(
@@ -282,7 +282,7 @@ def build_cursor_iterable_list_page_async(
     # Can be awaited multiple times with same result, but not scheduled at this time yet, as it might be pre-emptive.
     fetch_first_page = _LazyTask(callback(**{**kwargs, cursor_param: initial_cursor, 'limit': first_limit}))
 
-    async def async_iterator() -> AsyncIterator[Any]:
+    async def get_async_iterator() -> AsyncIterator[Any]:
         current_page = await fetch_first_page
         for item in current_page.items:
             yield item
@@ -302,4 +302,4 @@ async def async_iterator() -> AsyncIterator[Any]:
     async def wrap_first_page() -> ListPage[Any]:
         return ListPage(await fetch_first_page)
 
-    return IterableListPageAsync(wrap_first_page, async_iterator())
+    return IterableListPageAsync(wrap_first_page, get_async_iterator)

src/apify_client/_models_generated.py

@@ -3912,7 +3912,7 @@ class WebhookDispatchList(BaseModel):
         extra='allow',
         populate_by_name=True,
     )
-    data: ListOfWebhookDispatches | None = None
+    data: ListOfWebhookDispatches
 
 
 @docs_group('Models')

src/apify_client/_resource_clients/actor_collection.py

@@ -218,7 +218,7 @@ def list(
     ) -> IterableListPageAsync[ActorShort]:
         """List the Actors the user has created or used.
 
-        The returned page also supports iteration: `for item in client.list(...)` yields individual Actors
+        The returned page also supports iteration: `async for item in client.list(...)` yields individual Actors
         and transparently fetches further pages from the API.
 
         https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors

src/apify_client/_resource_clients/actor_env_var_collection.py

@@ -106,7 +106,7 @@ def __init__(
     def list(self, *, timeout: Timeout = 'short') -> IterableListPageAsync[EnvVar]:
         """List the available Actor environment variables.
 
-        The returned page also supports iteration: `for item in client.list()` yields individual environment
+        The returned page also supports iteration: `async for item in client.list()` yields individual environment
         variables.
 
         https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables

src/apify_client/_resource_clients/actor_version_collection.py

@@ -146,7 +146,7 @@ def __init__(
     def list(self, *, timeout: Timeout = 'short') -> IterableListPageAsync[Version]:
         """List the available Actor versions.
 
-        The returned page also supports iteration: `for item in client.list()` yields individual versions.
+        The returned page also supports iteration: `async for item in client.list()` yields individual versions.
 
         https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions
 

src/apify_client/_resource_clients/build_collection.py

@@ -104,7 +104,7 @@ def list(
         List all Actor builds, either of a single Actor, or all user's Actors, depending on where this client
         was initialized from.
 
-        The returned page also supports iteration: `for item in client.list(...)` yields individual builds
+        The returned page also supports iteration: `async for item in client.list(...)` yields individual builds
         and transparently fetches further pages from the API.
 
         https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds

src/apify_client/_resource_clients/dataset.py

@@ -828,7 +828,7 @@ def list_items(
     ) -> IterableListPageAsync[dict[str, Any]]:
         """List the items of the dataset.
 
-        The returned page also supports iteration: `for item in client.list_items(...)` yields individual
+        The returned page also supports iteration: `async for item in client.list_items(...)` yields individual
         items and transparently fetches further pages from the API.
 
         https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items

src/apify_client/_resource_clients/dataset_collection.py

@@ -132,7 +132,7 @@ def list(
     ) -> IterableListPageAsync[DatasetListItem]:
         """List the available datasets.
 
-        The returned page also supports iteration: `for item in client.list(...)` yields individual datasets
+        The returned page also supports iteration: `async for item in client.list(...)` yields individual datasets
         and transparently fetches further pages from the API.
 
         https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets

src/apify_client/_resource_clients/key_value_store.py

@@ -594,7 +594,7 @@ def list_keys(
     ) -> IterableListPageAsync[KeyValueStoreKey]:
         """List the keys in the key-value store.
 
-        The returned page also supports iteration: `for key in client.list_keys(...)` yields individual
+        The returned page also supports iteration: `async for key in client.list_keys(...)` yields individual
         keys and transparently fetches further pages using cursor-based pagination.
 
         https://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys