Skip to content

Commit e8aea2c

Browse files
authored
refactor!: Remove support for passing a single string to the unwind parameter in DatasetClient (#467)
- Deprecate passing a simple string to the `unwind` parameter for `DatasetClient` ### Issues - Closes: #255
1 parent ebcf098 commit e8aea2c

File tree

2 files changed

+10
-28
lines changed

2 files changed

+10
-28
lines changed

src/apify_client/clients/resource_clients/dataset.py

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,7 @@ def list_items(
7575
desc: bool | None = None,
7676
fields: list[str] | None = None,
7777
omit: list[str] | None = None,
78-
# TODO: change to list[str] only when doing a breaking release
79-
# https://github.com/apify/apify-client-python/issues/255
80-
unwind: str | list[str] | None = None,
78+
unwind: list[str] | None = None,
8179
skip_empty: bool | None = None,
8280
skip_hidden: bool | None = None,
8381
flatten: list[str] | None = None,
@@ -163,9 +161,7 @@ def iterate_items(
163161
desc: bool | None = None,
164162
fields: list[str] | None = None,
165163
omit: list[str] | None = None,
166-
# TODO: change to list[str] only when doing a breaking release
167-
# https://github.com/apify/apify-client-python/issues/255
168-
unwind: str | list[str] | None = None,
164+
unwind: list[str] | None = None,
169165
skip_empty: bool | None = None,
170166
skip_hidden: bool | None = None,
171167
) -> Iterator[dict]:
@@ -248,9 +244,7 @@ def download_items(
248244
delimiter: str | None = None,
249245
fields: list[str] | None = None,
250246
omit: list[str] | None = None,
251-
# TODO: change to list[str] only when doing a breaking release
252-
# https://github.com/apify/apify-client-python/issues/255
253-
unwind: str | list[str] | None = None,
247+
unwind: list[str] | None = None,
254248
skip_empty: bool | None = None,
255249
skip_header_row: bool | None = None,
256250
skip_hidden: bool | None = None,
@@ -342,9 +336,7 @@ def get_items_as_bytes(
342336
delimiter: str | None = None,
343337
fields: list[str] | None = None,
344338
omit: list[str] | None = None,
345-
# TODO: change to list[str] only when doing a breaking release
346-
# https://github.com/apify/apify-client-python/issues/255
347-
unwind: str | list[str] | None = None,
339+
unwind: list[str] | None = None,
348340
skip_empty: bool | None = None,
349341
skip_header_row: bool | None = None,
350342
skip_hidden: bool | None = None,
@@ -438,9 +430,7 @@ def stream_items(
438430
delimiter: str | None = None,
439431
fields: list[str] | None = None,
440432
omit: list[str] | None = None,
441-
# TODO: change to list[str] only when doing a breaking release
442-
# https://github.com/apify/apify-client-python/issues/255
443-
unwind: str | list[str] | None = None,
433+
unwind: list[str] | None = None,
444434
skip_empty: bool | None = None,
445435
skip_header_row: bool | None = None,
446436
skip_hidden: bool | None = None,
@@ -625,9 +615,7 @@ async def list_items(
625615
desc: bool | None = None,
626616
fields: list[str] | None = None,
627617
omit: list[str] | None = None,
628-
# TODO: change to list[str] only when doing a breaking release
629-
# https://github.com/apify/apify-client-python/issues/255
630-
unwind: str | list[str] | None = None,
618+
unwind: list[str] | None = None,
631619
skip_empty: bool | None = None,
632620
skip_hidden: bool | None = None,
633621
flatten: list[str] | None = None,
@@ -713,9 +701,7 @@ async def iterate_items(
713701
desc: bool | None = None,
714702
fields: list[str] | None = None,
715703
omit: list[str] | None = None,
716-
# TODO: change to list[str] only when doing a breaking release
717-
# https://github.com/apify/apify-client-python/issues/255
718-
unwind: str | list[str] | None = None,
704+
unwind: list[str] | None = None,
719705
skip_empty: bool | None = None,
720706
skip_hidden: bool | None = None,
721707
) -> AsyncIterator[dict]:
@@ -799,9 +785,7 @@ async def get_items_as_bytes(
799785
delimiter: str | None = None,
800786
fields: list[str] | None = None,
801787
omit: list[str] | None = None,
802-
# TODO: change to list[str] only when doing a breaking release
803-
# https://github.com/apify/apify-client-python/issues/255
804-
unwind: str | list[str] | None = None,
788+
unwind: list[str] | None = None,
805789
skip_empty: bool | None = None,
806790
skip_header_row: bool | None = None,
807791
skip_hidden: bool | None = None,
@@ -895,9 +879,7 @@ async def stream_items(
895879
delimiter: str | None = None,
896880
fields: list[str] | None = None,
897881
omit: list[str] | None = None,
898-
# TODO: change to list[str] only when doing a breaking release
899-
# https://github.com/apify/apify-client-python/issues/255
900-
unwind: str | list[str] | None = None,
882+
unwind: list[str] | None = None,
901883
skip_empty: bool | None = None,
902884
skip_header_row: bool | None = None,
903885
skip_hidden: bool | None = None,

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)