Skip to content

Commit 969322f

Browse files
committed
test(integration): assert ListPage + typed item on every list() return
Align every integration test that calls a `list()` / `list_keys()` / `list_requests()` method with the pattern introduced on iterable-list-methods-2 (commit 82ee01f): xs_page = await maybe_await(client.xs().list(limit=10)) assert isinstance(xs_page, ListPage) assert isinstance(xs_page.items, list) assert isinstance(xs_page.items[0], XShort) Covers: actors, actor-env-vars, actor-versions, builds (user + per-actor), datasets, key-value-stores, key-value-store keys (incl. signature variant), request-queues, request-queue requests (list + batch-add + batch-delete polls), runs (multi-status + user runs + task runs), schedules, store, tasks, webhooks, webhook dispatches, log (build listing). Where a listing may legitimately be empty (user's own actors, user's own datasets/ KVSs/RQs/runs/builds, new task's webhooks, webhook dispatches), the element-type assertion is guarded with `if xs_page.items:` rather than asserting `items[0]`. All `ListOf*` imports from `_models_generated` in integration tests replaced with the item-type import (e.g. `ActorShort`, `BuildShort`, `KeyValueStoreKey`, `Request`) plus `ListPage` from `_iterable_list_page`. No source changes. 258 integration tests collect cleanly; 521 unit tests pass. https://claude.ai/code/session_011VSSFo89Z9LfyFqZGsJKfz
1 parent 82ee01f commit 969322f

14 files changed

Lines changed: 235 additions & 175 deletions

‎tests/integration/test_actor.py‎

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@
55
from typing import TYPE_CHECKING, cast
66

77
from ._utils import get_random_resource_name, maybe_await
8+
from apify_client._iterable_list_page import ListPage
9+
from apify_client._models_generated import ActorShort
810

911
if TYPE_CHECKING:
1012
from apify_client import ApifyClient, ApifyClientAsync
11-
from apify_client._models_generated import Actor, Build, ListOfActors, Run
13+
from apify_client._models_generated import Actor, Build, Run
1214
from apify_client._resource_clients import BuildClient, BuildClientAsync
1315

1416

@@ -36,36 +38,31 @@ async def test_get_actor_by_full_name(client: ApifyClient | ApifyClientAsync) ->
3638

3739
async def test_list_actors_my(client: ApifyClient | ApifyClientAsync) -> None:
3840
"""Test listing Actors created by the user."""
39-
result = await maybe_await(client.actors().list(my=True, limit=10))
40-
actors_page = cast('ListOfActors', result)
41+
actors_page = await maybe_await(client.actors().list(my=True, limit=10))
4142

42-
assert actors_page is not None
43-
assert actors_page.items is not None
44-
# User may have 0 actors
43+
assert isinstance(actors_page, ListPage)
4544
assert isinstance(actors_page.items, list)
45+
# User may have 0 actors — only check element type when any were returned.
46+
if actors_page.items:
47+
assert isinstance(actors_page.items[0], ActorShort)
4648

4749

4850
async def test_list_actors_pagination(client: ApifyClient | ApifyClientAsync) -> None:
4951
"""Test listing Actors with pagination parameters."""
50-
# List all actors (public + owned), should return some results
51-
result = await maybe_await(client.actors().list(limit=5, offset=0))
52-
actors_page = cast('ListOfActors', result)
52+
actors_page = await maybe_await(client.actors().list(limit=5, offset=0))
5353

54-
assert actors_page is not None
55-
assert actors_page.items is not None
54+
assert isinstance(actors_page, ListPage)
5655
assert isinstance(actors_page.items, list)
57-
# Should have at least some actors (public ones exist)
58-
assert len(actors_page.items) >= 0
56+
assert isinstance(actors_page.items[0], ActorShort)
5957

6058

6159
async def test_list_actors_sorting(client: ApifyClient | ApifyClientAsync) -> None:
6260
"""Test listing Actors with sorting."""
63-
result = await maybe_await(client.actors().list(limit=10, desc=True, sort_by='created_at'))
64-
actors_page = cast('ListOfActors', result)
61+
actors_page = await maybe_await(client.actors().list(limit=10, desc=True, sort_by='created_at'))
6562

66-
assert actors_page is not None
67-
assert actors_page.items is not None
63+
assert isinstance(actors_page, ListPage)
6864
assert isinstance(actors_page.items, list)
65+
assert isinstance(actors_page.items[0], ActorShort)
6966

7067

7168
async def test_actor_create_update_delete(client: ApifyClient | ApifyClientAsync) -> None:

‎tests/integration/test_actor_env_var.py‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44

55
from typing import TYPE_CHECKING, cast
66

7+
from apify_client._iterable_list_page import ListPage
8+
from apify_client._models_generated import EnvVar
9+
710
if TYPE_CHECKING:
811
from apify_client import ApifyClient, ApifyClientAsync
9-
from apify_client._models_generated import Actor, EnvVar, ListOfEnvVars
12+
from apify_client._models_generated import Actor
1013

1114

1215
from ._utils import get_random_resource_name, maybe_await
@@ -49,11 +52,11 @@ async def test_actor_env_var_list(client: ApifyClient | ApifyClientAsync) -> Non
4952

5053
try:
5154
# List env vars
52-
result = await maybe_await(version_client.env_vars().list())
53-
env_vars = cast('ListOfEnvVars', result)
55+
env_vars = await maybe_await(version_client.env_vars().list())
5456

55-
assert env_vars is not None
56-
assert env_vars.items is not None
57+
assert isinstance(env_vars, ListPage)
58+
assert isinstance(env_vars.items, list)
59+
assert isinstance(env_vars.items[0], EnvVar)
5760
assert len(env_vars.items) >= 1
5861

5962
# Verify env var fields

‎tests/integration/test_actor_version.py‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44

55
from typing import TYPE_CHECKING, cast
66

7+
from apify_client._iterable_list_page import ListPage
8+
from apify_client._models_generated import Version
9+
710
if TYPE_CHECKING:
811
from apify_client import ApifyClient, ApifyClientAsync
9-
from apify_client._models_generated import Actor, ListOfVersions, Version
12+
from apify_client._models_generated import Actor
1013

1114

1215
from ._utils import get_random_resource_name, maybe_await
@@ -42,11 +45,11 @@ async def test_actor_version_list(client: ApifyClient | ApifyClientAsync) -> Non
4245

4346
try:
4447
# List versions
45-
result = await maybe_await(actor_client.versions().list())
46-
versions = cast('ListOfVersions', result)
48+
versions = await maybe_await(actor_client.versions().list())
4749

48-
assert versions is not None
49-
assert versions.items is not None
50+
assert isinstance(versions, ListPage)
51+
assert isinstance(versions.items, list)
52+
assert isinstance(versions.items[0], Version)
5053
assert len(versions.items) >= 1
5154

5255
# Verify version fields

‎tests/integration/test_build.py‎

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44

55
from typing import TYPE_CHECKING, cast
66

7+
from apify_client._iterable_list_page import ListPage
8+
from apify_client._models_generated import BuildShort
9+
710
if TYPE_CHECKING:
811
from apify_client import ApifyClient, ApifyClientAsync
9-
from apify_client._models_generated import Actor, Build, ListOfBuilds
12+
from apify_client._models_generated import Actor, Build
1013

1114

1215
from datetime import timedelta
@@ -21,14 +24,12 @@ async def test_build_list_for_actor(client: ApifyClient | ApifyClientAsync) -> N
2124
"""Test listing builds for a public Actor."""
2225
# Get builds for hello-world actor
2326
actor = client.actor(HELLO_WORLD_ACTOR)
24-
result = await maybe_await(actor.builds().list(limit=10))
25-
builds_page = cast('ListOfBuilds', result)
27+
builds_page = await maybe_await(actor.builds().list(limit=10))
2628

27-
assert builds_page is not None
28-
assert builds_page.items is not None
29-
assert len(builds_page.items) > 0 # hello-world should have at least one build
29+
assert isinstance(builds_page, ListPage)
30+
assert isinstance(builds_page.items, list)
31+
assert isinstance(builds_page.items[0], BuildShort) # hello-world has at least one build
3032

31-
# Verify build structure
3233
first_build = builds_page.items[0]
3334
assert first_build.id is not None
3435
assert first_build.act_id is not None
@@ -38,9 +39,11 @@ async def test_build_get(client: ApifyClient | ApifyClientAsync) -> None:
3839
"""Test getting a specific build."""
3940
# First list builds to get a build ID
4041
actor = client.actor(HELLO_WORLD_ACTOR)
41-
result = await maybe_await(actor.builds().list(limit=1))
42-
builds_page = cast('ListOfBuilds', result)
43-
assert builds_page.items
42+
builds_page = await maybe_await(actor.builds().list(limit=1))
43+
44+
assert isinstance(builds_page, ListPage)
45+
assert isinstance(builds_page.items, list)
46+
assert isinstance(builds_page.items[0], BuildShort)
4447
build_id = builds_page.items[0].id
4548

4649
# Get the specific build
@@ -56,22 +59,24 @@ async def test_build_get(client: ApifyClient | ApifyClientAsync) -> None:
5659
async def test_user_builds_list(client: ApifyClient | ApifyClientAsync) -> None:
5760
"""Test listing all user builds."""
5861
# List user's builds (may be empty if user has no actors)
59-
result = await maybe_await(client.builds().list(limit=10))
60-
builds_page = cast('ListOfBuilds', result)
62+
builds_page = await maybe_await(client.builds().list(limit=10))
6163

62-
assert builds_page is not None
63-
assert builds_page.items is not None
64-
# User may have 0 builds, so we just check the structure
64+
assert isinstance(builds_page, ListPage)
6565
assert isinstance(builds_page.items, list)
66+
# User may have 0 builds — only check element type when any were returned.
67+
if builds_page.items:
68+
assert isinstance(builds_page.items[0], BuildShort)
6669

6770

6871
async def test_build_log(client: ApifyClient | ApifyClientAsync) -> None:
6972
"""Test getting build log."""
7073
# First list builds to get a completed build ID
7174
actor = client.actor(HELLO_WORLD_ACTOR)
72-
result = await maybe_await(actor.builds().list(limit=5))
73-
builds_page = cast('ListOfBuilds', result)
74-
assert builds_page.items
75+
builds_page = await maybe_await(actor.builds().list(limit=5))
76+
77+
assert isinstance(builds_page, ListPage)
78+
assert isinstance(builds_page.items, list)
79+
assert isinstance(builds_page.items[0], BuildShort)
7580

7681
# Find a completed build (SUCCEEDED status)
7782
completed_build = None
@@ -96,9 +101,11 @@ async def test_build_wait_for_finish(client: ApifyClient | ApifyClientAsync) ->
96101
"""Test wait_for_finish on an already completed build."""
97102
# First list builds to get a completed build ID
98103
actor = client.actor(HELLO_WORLD_ACTOR)
99-
result = await maybe_await(actor.builds().list(limit=5))
100-
builds_page = cast('ListOfBuilds', result)
101-
assert builds_page.items
104+
builds_page = await maybe_await(actor.builds().list(limit=5))
105+
106+
assert isinstance(builds_page, ListPage)
107+
assert isinstance(builds_page.items, list)
108+
assert isinstance(builds_page.items[0], BuildShort)
102109

103110
# Find a completed build (SUCCEEDED status)
104111
completed_build = None
@@ -208,9 +215,11 @@ async def test_build_get_open_api_definition(client: ApifyClient | ApifyClientAs
208215
"""Test getting OpenAPI definition for a build."""
209216
# Get builds for hello-world actor
210217
actor = client.actor(HELLO_WORLD_ACTOR)
211-
result = await maybe_await(actor.builds().list(limit=1))
212-
builds_page = cast('ListOfBuilds', result)
213-
assert builds_page.items
218+
builds_page = await maybe_await(actor.builds().list(limit=1))
219+
220+
assert isinstance(builds_page, ListPage)
221+
assert isinstance(builds_page.items, list)
222+
assert isinstance(builds_page.items[0], BuildShort)
214223
build_id = builds_page.items[0].id
215224

216225
# Get the OpenAPI definition

‎tests/integration/test_dataset.py‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44

55
from typing import TYPE_CHECKING, cast
66

7+
from apify_client._iterable_list_page import ListPage
8+
from apify_client._models_generated import DatasetListItem
9+
710
if TYPE_CHECKING:
811
from collections.abc import AsyncIterator, Iterator
912
from contextlib import AbstractAsyncContextManager, AbstractContextManager
1013

1114
from impit import Response
1215

1316
from apify_client import ApifyClient, ApifyClientAsync
14-
from apify_client._models_generated import Dataset, ListOfDatasets
17+
from apify_client._models_generated import Dataset
1518
from apify_client._resource_clients.dataset import DatasetItemsPage
1619

1720
import json
@@ -26,22 +29,23 @@
2629

2730
async def test_dataset_collection_list(client: ApifyClient | ApifyClientAsync) -> None:
2831
"""Test listing datasets."""
29-
result = await maybe_await(client.datasets().list(limit=10))
30-
datasets_page = cast('ListOfDatasets', result)
32+
datasets_page = await maybe_await(client.datasets().list(limit=10))
3133

32-
assert datasets_page is not None
33-
assert datasets_page.items is not None
34+
assert isinstance(datasets_page, ListPage)
3435
assert isinstance(datasets_page.items, list)
36+
# User may have 0 datasets — only check element type when any were returned.
37+
if datasets_page.items:
38+
assert isinstance(datasets_page.items[0], DatasetListItem)
3539

3640

3741
async def test_dataset_collection_list_pagination(client: ApifyClient | ApifyClientAsync) -> None:
3842
"""Test listing datasets with pagination."""
39-
result = await maybe_await(client.datasets().list(limit=5, offset=0))
40-
datasets_page = cast('ListOfDatasets', result)
43+
datasets_page = await maybe_await(client.datasets().list(limit=5, offset=0))
4144

42-
assert datasets_page is not None
43-
assert datasets_page.items is not None
45+
assert isinstance(datasets_page, ListPage)
4446
assert isinstance(datasets_page.items, list)
47+
if datasets_page.items:
48+
assert isinstance(datasets_page.items[0], DatasetListItem)
4549

4650

4751
async def test_dataset_collection_get_or_create(client: ApifyClient | ApifyClientAsync) -> None:

‎tests/integration/test_key_value_store.py‎

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44

55
from typing import TYPE_CHECKING, cast
66

7+
from apify_client._iterable_list_page import ListPage
8+
from apify_client._models_generated import KeyValueStore, KeyValueStoreKey
9+
710
if TYPE_CHECKING:
811
from collections.abc import AsyncIterator, Iterator
912

1013
from apify_client import ApifyClient, ApifyClientAsync
11-
from apify_client._models_generated import KeyValueStore, KeyValueStoreKey, ListOfKeys, ListOfKeyValueStores
1214

1315
import json
1416
from datetime import timedelta
@@ -22,22 +24,22 @@
2224

2325
async def test_key_value_store_collection_list(client: ApifyClient | ApifyClientAsync) -> None:
2426
"""Test listing key-value stores."""
25-
result = await maybe_await(client.key_value_stores().list(limit=10))
26-
kvs_page = cast('ListOfKeyValueStores', result)
27+
kvs_page = await maybe_await(client.key_value_stores().list(limit=10))
2728

28-
assert kvs_page is not None
29-
assert kvs_page.items is not None
29+
assert isinstance(kvs_page, ListPage)
3030
assert isinstance(kvs_page.items, list)
31+
if kvs_page.items:
32+
assert isinstance(kvs_page.items[0], KeyValueStore)
3133

3234

3335
async def test_key_value_store_collection_list_pagination(client: ApifyClient | ApifyClientAsync) -> None:
3436
"""Test listing key-value stores with pagination."""
35-
result = await maybe_await(client.key_value_stores().list(limit=5, offset=0))
36-
kvs_page = cast('ListOfKeyValueStores', result)
37+
kvs_page = await maybe_await(client.key_value_stores().list(limit=5, offset=0))
3738

38-
assert kvs_page is not None
39-
assert kvs_page.items is not None
39+
assert isinstance(kvs_page, ListPage)
4040
assert isinstance(kvs_page.items, list)
41+
if kvs_page.items:
42+
assert isinstance(kvs_page.items[0], KeyValueStore)
4143

4244

4345
async def test_key_value_store_collection_get_or_create(client: ApifyClient | ApifyClientAsync) -> None:
@@ -124,11 +126,12 @@ async def test_list_keys_signature(
124126
await maybe_await(kvs.list_keys())
125127

126128
# Kvs content retrieved with correct signature
127-
result = await maybe_await(kvs.list_keys(signature=test_kvs_of_another_user.signature))
128-
response = cast('ListOfKeys', result)
129-
raw_items = response.items
129+
response = await maybe_await(kvs.list_keys(signature=test_kvs_of_another_user.signature))
130130

131-
assert set(test_kvs_of_another_user.expected_content) == {item.key for item in raw_items}
131+
assert isinstance(response, ListPage)
132+
assert isinstance(response.items, list)
133+
assert isinstance(response.items[0], KeyValueStoreKey)
134+
assert set(test_kvs_of_another_user.expected_content) == {item.key for item in response.items}
132135

133136

134137
async def test_get_record_signature(
@@ -338,9 +341,11 @@ async def test_key_value_store_list_keys(client: ApifyClient | ApifyClientAsync,
338341
await maybe_sleep(1, is_async=is_async)
339342

340343
# List keys
341-
result = await maybe_await(store_client.list_keys())
342-
keys_response = cast('ListOfKeys', result)
343-
assert keys_response is not None
344+
keys_response = await maybe_await(store_client.list_keys())
345+
346+
assert isinstance(keys_response, ListPage)
347+
assert isinstance(keys_response.items, list)
348+
assert isinstance(keys_response.items[0], KeyValueStoreKey)
344349
assert len(keys_response.items) == 5
345350

346351
# Verify key names
@@ -368,9 +373,11 @@ async def test_key_value_store_list_keys_with_limit(client: ApifyClient | ApifyC
368373
await maybe_sleep(1, is_async=is_async)
369374

370375
# List with limit
371-
result = await maybe_await(store_client.list_keys(limit=5))
372-
keys_response = cast('ListOfKeys', result)
373-
assert keys_response is not None
376+
keys_response = await maybe_await(store_client.list_keys(limit=5))
377+
378+
assert isinstance(keys_response, ListPage)
379+
assert isinstance(keys_response.items, list)
380+
assert isinstance(keys_response.items[0], KeyValueStoreKey)
374381
assert len(keys_response.items) == 5
375382
finally:
376383
await maybe_await(store_client.delete())

0 commit comments

Comments
 (0)