Repository navigation
Expand file tree
/
Copy pathtest_dataset.py
More file actions
748 lines (602 loc) · 29.9 KB
/
Copy pathtest_dataset.py
File metadata and controls
748 lines (602 loc) · 29.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
"""Unified tests for dataset (sync + async)."""
from __future__ import annotations
import json
from collections.abc import AsyncIterator, Iterator
from contextlib import AbstractAsyncContextManager, AbstractContextManager
from datetime import timedelta
from typing import TYPE_CHECKING
import impit
import pytest
from .._utils import (
DatasetFixture,
collect_iterate_until_present,
get_random_resource_name,
maybe_await,
poll_until_condition,
)
from apify_client._models import Dataset, DatasetListItem, DatasetStatistics, ListOfDatasets
from apify_client._resource_clients.dataset import DatasetItemsPage
from apify_client.errors import ApifyApiError
from apify_client.http_clients import HttpResponse
if TYPE_CHECKING:
from apify_client import ApifyClient, ApifyClientAsync
async def test_dataset_collection_list(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing datasets."""
datasets_page = await maybe_await(client.datasets().list(limit=10))
assert isinstance(datasets_page, ListOfDatasets)
assert datasets_page.items is not None
assert isinstance(datasets_page.items, list)
async def test_dataset_collection_list_pagination(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing datasets with pagination."""
datasets_page = await maybe_await(client.datasets().list(limit=5, offset=0))
assert isinstance(datasets_page, ListOfDatasets)
assert datasets_page.items is not None
assert isinstance(datasets_page.items, list)
async def test_dataset_collection_get_or_create(client: ApifyClient | ApifyClientAsync) -> None:
"""Test get_or_create for datasets."""
unique_name = get_random_resource_name('dataset')
# Create new dataset
dataset = await maybe_await(client.datasets().get_or_create(name=unique_name))
assert isinstance(dataset, Dataset)
try:
assert dataset.name == unique_name
# Get same dataset again (should return existing)
same_dataset = await maybe_await(client.datasets().get_or_create(name=unique_name))
assert isinstance(same_dataset, Dataset)
assert same_dataset.id == dataset.id
finally:
await maybe_await(client.dataset(dataset.id).delete())
async def test_dataset_should_create_public_items_expiring_url_with_params(
client: ApifyClient | ApifyClientAsync,
) -> None:
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset = client.dataset(created_dataset.id)
try:
items_public_url = await maybe_await(
dataset.create_items_public_url(
expires_in=timedelta(seconds=2000),
limit=10,
offset=0,
)
)
assert isinstance(items_public_url, str)
assert 'signature=' in items_public_url
assert 'limit=10' in items_public_url
assert 'offset=0' in items_public_url
impit_client = impit.Client()
response = impit_client.get(items_public_url, timeout=30)
assert response.status_code == 200
finally:
await maybe_await(dataset.delete())
async def test_dataset_should_create_public_items_non_expiring_url(
client: ApifyClient | ApifyClientAsync,
) -> None:
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset = client.dataset(created_dataset.id)
try:
items_public_url = await maybe_await(dataset.create_items_public_url())
assert isinstance(items_public_url, str)
assert 'signature=' in items_public_url
impit_client = impit.Client()
response = impit_client.get(items_public_url, timeout=30)
assert response.status_code == 200
finally:
await maybe_await(dataset.delete())
async def test_list_items_signature(
client: ApifyClient | ApifyClientAsync, test_dataset_of_another_user: DatasetFixture
) -> None:
dataset = client.dataset(dataset_id=test_dataset_of_another_user.id)
# Permission error without valid signature
with pytest.raises(
ApifyApiError,
match=r"Insufficient permissions for the dataset. Make sure you're passing a "
r'correct API token and that it has the required permissions.',
):
await maybe_await(dataset.list_items())
# Dataset content retrieved with correct signature
signature = test_dataset_of_another_user.signature
list_items_result = await maybe_await(dataset.list_items(signature=signature))
assert isinstance(list_items_result, DatasetItemsPage)
assert test_dataset_of_another_user.expected_content == list_items_result.items
async def test_iterate_items_signature(
client: ApifyClient | ApifyClientAsync,
test_dataset_of_another_user: DatasetFixture,
*,
is_async: bool,
) -> None:
dataset = client.dataset(dataset_id=test_dataset_of_another_user.id)
# Permission error without valid signature
with pytest.raises( # noqa: PT012
ApifyApiError,
match=r"Insufficient permissions for the dataset. Make sure you're passing a "
r'correct API token and that it has the required permissions.',
):
iterator = dataset.iterate_items()
if is_async:
assert isinstance(iterator, AsyncIterator)
async for _ in iterator:
pass
else:
assert isinstance(iterator, Iterator)
for _ in iterator:
pass
# Dataset content retrieved with correct signature
signature = test_dataset_of_another_user.signature
iterator = dataset.iterate_items(signature=signature)
collected_items: list[dict] = []
if is_async:
assert isinstance(iterator, AsyncIterator)
async for item in iterator:
assert isinstance(item, dict)
collected_items.append(item)
else:
assert isinstance(iterator, Iterator)
for item in iterator:
assert isinstance(item, dict)
collected_items.append(item)
assert test_dataset_of_another_user.expected_content == collected_items
async def test_get_items_as_bytes_signature(
client: ApifyClient | ApifyClientAsync, test_dataset_of_another_user: DatasetFixture
) -> None:
dataset = client.dataset(dataset_id=test_dataset_of_another_user.id)
# Permission error without valid signature
with pytest.raises(
ApifyApiError,
match=r"Insufficient permissions for the dataset. Make sure you're passing a "
r'correct API token and that it has the required permissions.',
):
await maybe_await(dataset.get_items_as_bytes())
# Dataset content retrieved with correct signature
signature = test_dataset_of_another_user.signature
raw_data = await maybe_await(dataset.get_items_as_bytes(signature=signature))
assert isinstance(raw_data, bytes)
assert test_dataset_of_another_user.expected_content == json.loads(raw_data.decode('utf-8'))
async def test_dataset_get_or_create_and_get(client: ApifyClient | ApifyClientAsync) -> None:
"""Test creating a dataset and retrieving it."""
dataset_name = get_random_resource_name('dataset')
# Create dataset
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
assert created_dataset.id is not None
assert created_dataset.name == dataset_name
# Get the same dataset
dataset_client = client.dataset(created_dataset.id)
try:
retrieved_dataset = await maybe_await(dataset_client.get())
assert isinstance(retrieved_dataset, Dataset)
assert retrieved_dataset.id == created_dataset.id
assert retrieved_dataset.name == dataset_name
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_update(client: ApifyClient | ApifyClientAsync) -> None:
"""Test updating dataset properties."""
dataset_name = get_random_resource_name('dataset')
new_name = get_random_resource_name('dataset-updated')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Update the name
updated_dataset = await maybe_await(dataset_client.update(name=new_name))
assert isinstance(updated_dataset, Dataset)
assert updated_dataset.name == new_name
assert updated_dataset.id == created_dataset.id
# Verify the update persisted
retrieved_dataset = await maybe_await(dataset_client.get())
assert isinstance(retrieved_dataset, Dataset)
assert retrieved_dataset.name == new_name
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_push_and_list_items(client: ApifyClient | ApifyClientAsync) -> None:
"""Test pushing items to dataset and listing them."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Push some items
items_to_push = [
{'id': 1, 'name': 'Item 1', 'value': 100},
{'id': 2, 'name': 'Item 2', 'value': 200},
{'id': 3, 'name': 'Item 3', 'value': 300},
]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
items_page = await poll_until_condition(get_items, lambda page: len(page.items) == 3)
assert len(items_page.items) == 3
assert items_page.count == 3
# Note: items_page.total may be 0 immediately after push due to eventual consistency
# Verify items content
for i, item in enumerate(items_page.items):
assert item['id'] == items_to_push[i]['id']
assert item['name'] == items_to_push[i]['name']
assert item['value'] == items_to_push[i]['value']
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_list_items_with_pagination(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing items with pagination parameters."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Push more items
items_to_push = [{'index': i, 'value': i * 10} for i in range(10)]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 10)
# List with limit
items_page = await maybe_await(dataset_client.list_items(limit=5))
assert isinstance(items_page, DatasetItemsPage)
assert len(items_page.items) == 5
assert items_page.count == 5
# Note: items_page.total may be 0 immediately after push due to eventual consistency
assert items_page.limit == 5
# List with offset
items_page_offset = await maybe_await(dataset_client.list_items(offset=5, limit=5))
assert isinstance(items_page_offset, DatasetItemsPage)
assert len(items_page_offset.items) == 5
assert items_page_offset.offset == 5
# Note: items_page.total may be 0 immediately after push due to eventual consistency
# Verify different items
assert items_page.items[0]['index'] != items_page_offset.items[0]['index']
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_list_items_with_fields(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing items with field filtering."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Push items with multiple fields
items_to_push = [
{'id': 1, 'name': 'Item 1', 'value': 100, 'extra': 'data1'},
{'id': 2, 'name': 'Item 2', 'value': 200, 'extra': 'data2'},
]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency), listing with the fields filter
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items(fields=['id', 'name']))
assert isinstance(page, DatasetItemsPage)
return page
items_page = await poll_until_condition(get_items, lambda page: len(page.items) == 2)
assert len(items_page.items) == 2
# Verify only specified fields are returned
for item in items_page.items:
assert 'id' in item
assert 'name' in item
assert 'value' not in item
assert 'extra' not in item
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_iterate_items(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test iterating over dataset items."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Push items
items_to_push = [{'index': i} for i in range(5)]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 5)
# Iterate over items
iterator = dataset_client.iterate_items()
collected_items: list[dict] = []
if is_async:
assert isinstance(iterator, AsyncIterator)
async for item in iterator:
assert isinstance(item, dict)
collected_items.append(item)
else:
assert isinstance(iterator, Iterator)
for item in iterator:
assert isinstance(item, dict)
collected_items.append(item)
assert len(collected_items) == 5
for i, item in enumerate(collected_items):
assert item['index'] == i
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_delete_nonexistent(client: ApifyClient | ApifyClientAsync) -> None:
"""Test that getting a deleted dataset returns None."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
# Delete dataset
await maybe_await(dataset_client.delete())
# Verify it's gone
retrieved_dataset = await maybe_await(dataset_client.get())
assert retrieved_dataset is None
async def test_dataset_get_statistics(client: ApifyClient | ApifyClientAsync) -> None:
"""Test getting dataset statistics."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Push some items first
items_to_push = [
{'id': 1, 'name': 'Item 1'},
{'id': 2, 'name': 'Item 2'},
]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 2)
# Get statistics
statistics = await maybe_await(dataset_client.get_statistics())
# Verify statistics is returned and properly parsed
assert isinstance(statistics, DatasetStatistics)
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_collection_iterate(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test iterating over the user's datasets across pages."""
created_ids: list[str] = []
# Create three datasets so pagination has work to do
for _ in range(3):
dataset = await maybe_await(client.datasets().get_or_create(name=get_random_resource_name('dataset')))
assert isinstance(dataset, Dataset)
created_ids.append(dataset.id)
try:
collected = await collect_iterate_until_present(
lambda: client.datasets().iterate(desc=True),
set(created_ids),
item_type=DatasetListItem,
is_async=is_async,
)
collected_ids = {ds.id for ds in collected}
for created_id in created_ids:
assert created_id in collected_ids
finally:
for ds_id in created_ids:
await maybe_await(client.dataset(ds_id).delete())
async def test_dataset_list_items_desc(client: ApifyClient | ApifyClientAsync) -> None:
"""Test listing items in descending order."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
items_to_push = [{'idx': i} for i in range(5)]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 5)
# Default ordering - ascending
page_asc = await maybe_await(dataset_client.list_items())
assert isinstance(page_asc, DatasetItemsPage)
# Reversed ordering
page_desc = await maybe_await(dataset_client.list_items(desc=True))
assert isinstance(page_desc, DatasetItemsPage)
assert page_asc.desc is False
assert page_desc.desc is True
assert [item['idx'] for item in page_desc.items] == list(reversed([item['idx'] for item in page_asc.items]))
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_list_items_omit_and_clean(client: ApifyClient | ApifyClientAsync) -> None:
"""Test list_items with `omit`, `clean`, `skip_hidden`, and `skip_empty` filters."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Mix of regular, hidden (`#`), and empty items to exercise filters
items_to_push = [
{'id': 1, 'name': 'visible', '#secret': 'shh', 'extra': 'X'},
{}, # empty item - filtered out by skip_empty/clean
{'id': 2, 'name': 'also visible', '#secret': 'shh', 'extra': 'Y'},
]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == len(items_to_push))
# `omit` should remove the `extra` field
omit_page = await maybe_await(dataset_client.list_items(omit=['extra']))
assert isinstance(omit_page, DatasetItemsPage)
for item in omit_page.items:
assert 'extra' not in item
# `clean=True` drops both hidden (`#secret`) and empty items
clean_page = await maybe_await(dataset_client.list_items(clean=True))
assert isinstance(clean_page, DatasetItemsPage)
assert all(item for item in clean_page.items) # no empties
for item in clean_page.items:
assert '#secret' not in item
# `skip_hidden=True` keeps empties but drops hidden fields
hidden_page = await maybe_await(dataset_client.list_items(skip_hidden=True))
assert isinstance(hidden_page, DatasetItemsPage)
for item in hidden_page.items:
assert '#secret' not in item
# `skip_empty=True` drops empty items but keeps hidden fields
empty_page = await maybe_await(dataset_client.list_items(skip_empty=True))
assert isinstance(empty_page, DatasetItemsPage)
non_empty_count = len([i for i in items_to_push if i])
assert len(empty_page.items) == non_empty_count
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_iterate_items_chunked(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test iterate_items with a small chunk_size to force multiple API requests."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
items_to_push = [{'idx': i} for i in range(12)]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all 12 items are visible (eventual consistency) so the chunked iteration sees every page
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items(limit=12))
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 12)
# chunk_size=5 forces 3 underlying pages for 12 items
iterator = dataset_client.iterate_items(chunk_size=5)
collected: list[dict] = []
if is_async:
assert isinstance(iterator, AsyncIterator)
async for item in iterator:
assert isinstance(item, dict)
collected.append(item)
else:
assert isinstance(iterator, Iterator)
for item in iterator:
assert isinstance(item, dict)
collected.append(item)
assert len(collected) == 12
# Ordering across multiple paginated reads is not strictly guaranteed mid-flight,
# so compare by membership / sorted view rather than positional equality.
assert sorted(item['idx'] for item in collected) == list(range(12))
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_iterate_items_with_fields(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test iterate_items with `fields` filter."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
items_to_push = [{'id': i, 'name': f'item-{i}', 'extra': 'drop-me'} for i in range(3)]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 3)
iterator = dataset_client.iterate_items(fields=['id', 'name'])
collected: list[dict] = []
if is_async:
assert isinstance(iterator, AsyncIterator)
async for item in iterator:
assert isinstance(item, dict)
collected.append(item)
else:
assert isinstance(iterator, Iterator)
for item in iterator:
assert isinstance(item, dict)
collected.append(item)
assert len(collected) == 3
for item in collected:
assert set(item.keys()) == {'id', 'name'}
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_create_items_public_url(client: ApifyClient | ApifyClientAsync) -> None:
"""Test generating a signed public URL for dataset items and fetching from it."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
items = [{'id': i, 'value': i * 10} for i in range(3)]
await maybe_await(dataset_client.push_items(items))
# Poll until all items are visible (eventual consistency) so the public URL serves all of them
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 3)
public_url = await maybe_await(dataset_client.create_items_public_url(expires_in=timedelta(minutes=5)))
assert isinstance(public_url, str)
assert created_dataset.id in public_url
assert 'signature=' in public_url
# Fetch from the signed URL without any auth header - should succeed
response = impit.get(public_url)
assert response.status_code == 200
downloaded = json.loads(response.content)
assert downloaded == items
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_get_items_as_bytes_csv(client: ApifyClient | ApifyClientAsync) -> None:
"""Test get_items_as_bytes with non-JSON item_format (csv)."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
items = [{'id': 1, 'name': 'first'}, {'id': 2, 'name': 'second'}]
await maybe_await(dataset_client.push_items(items))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 2)
raw = await maybe_await(dataset_client.get_items_as_bytes(item_format='csv'))
assert isinstance(raw, bytes)
decoded = raw.decode('utf-8')
# CSV output should contain a header row and the values
assert 'id' in decoded
assert 'first' in decoded
assert 'second' in decoded
finally:
await maybe_await(dataset_client.delete())
async def test_dataset_stream_items(client: ApifyClient | ApifyClientAsync, *, is_async: bool) -> None:
"""Test streaming dataset items."""
dataset_name = get_random_resource_name('dataset')
created_dataset = await maybe_await(client.datasets().get_or_create(name=dataset_name))
assert isinstance(created_dataset, Dataset)
dataset_client = client.dataset(created_dataset.id)
try:
# Push some items
items_to_push = [
{'id': 1, 'name': 'Item 1', 'value': 100},
{'id': 2, 'name': 'Item 2', 'value': 200},
{'id': 3, 'name': 'Item 3', 'value': 300},
]
await maybe_await(dataset_client.push_items(items_to_push))
# Poll until all items are visible (eventual consistency)
async def get_items() -> DatasetItemsPage:
page = await maybe_await(dataset_client.list_items())
assert isinstance(page, DatasetItemsPage)
return page
await poll_until_condition(get_items, lambda page: len(page.items) == 3)
# Stream items using context manager
stream_ctx = dataset_client.stream_items(item_format='json')
if is_async:
assert isinstance(stream_ctx, AbstractAsyncContextManager)
async with stream_ctx as response:
assert isinstance(response, HttpResponse)
assert response.status_code == 200
content = await response.aread()
items = json.loads(content)
assert len(items) == 3
assert items[0]['id'] == 1
else:
assert isinstance(stream_ctx, AbstractContextManager)
with stream_ctx as response:
assert isinstance(response, HttpResponse)
assert response.status_code == 200
content = response.read()
items = json.loads(content)
assert len(items) == 3
assert items[0]['id'] == 1
finally:
await maybe_await(dataset_client.delete())