Skip to content

Fix keyword-only argument usage in some dataset-client functions #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fnesveda merged 1 commit into from
May 17, 2021
Merged

Fix keyword-only argument usage in some dataset-client functions #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1420,7 +1420,7 @@ List the items of the dataset.

***

#### [](#datasetclient-iterate_items) `DatasetClient.iterate_items(offset=0, limit=None, clean=None, desc=None, fields=None, omit=None, unwind=None, skip_empty=None, skip_hidden=None)`
#### [](#datasetclient-iterate_items) `DatasetClient.iterate_items(*, offset=0, limit=None, clean=None, desc=None, fields=None, omit=None, unwind=None, skip_empty=None, skip_hidden=None)`

Iterate over the items in the dataset.

Expand Down Expand Up @@ -1467,7 +1467,7 @@ Iterate over the items in the dataset.

***

#### [](#datasetclient-download_items) `DatasetClient.download_items(item_format='json', *, offset=None, limit=None, desc=None, clean=None, bom=None, delimiter=None, fields=None, omit=None, unwind=None, skip_empty=None, skip_header_row=None, skip_hidden=None, xml_root=None, xml_row=None)`
#### [](#datasetclient-download_items) `DatasetClient.download_items(*, item_format='json', offset=None, limit=None, desc=None, clean=None, bom=None, delimiter=None, fields=None, omit=None, unwind=None, skip_empty=None, skip_header_row=None, skip_hidden=None, xml_root=None, xml_row=None)`

Download the items in the dataset as raw bytes.

Expand Down Expand Up @@ -1530,7 +1530,7 @@ Download the items in the dataset as raw bytes.

***

#### [](#datasetclient-stream_items) `DatasetClient.stream_items(item_format='json', *, offset=None, limit=None, desc=None, clean=None, bom=None, delimiter=None, fields=None, omit=None, unwind=None, skip_empty=None, skip_header_row=None, skip_hidden=None, xml_root=None, xml_row=None)`
#### [](#datasetclient-stream_items) `DatasetClient.stream_items(*, item_format='json', offset=None, limit=None, desc=None, clean=None, bom=None, delimiter=None, fields=None, omit=None, unwind=None, skip_empty=None, skip_header_row=None, skip_hidden=None, xml_root=None, xml_row=None)`

Retrieve the items in the dataset as a file-like object.

Expand Down Expand Up @@ -2825,9 +2825,9 @@ A single page of items returned from a list() method.
Name | Type | Description
---- | ---- | -----------
`items` | `list` | List of returned objects on this page
`total` | `int` | Total number of objects matching the API call criteria
`count` | `int` | Count of the returned objects on this page
`offset` | `int` | The limit on the number of returned objects offset specified in the API call
`limit` | `int` | The offset of the first object specified in the API call
`count` | `int` | Count of the returned objects on this page
`total` | `int` | Total number of objects matching the API call criteria

***
5 changes: 3 additions & 2 deletions src/apify_client/clients/resource_clients/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ def list_items(

def iterate_items(
self,
*,
offset: int = 0,
limit: Optional[int] = None,
clean: Optional[bool] = None,
Expand Down Expand Up @@ -195,8 +196,8 @@ def iterate_items(

def download_items(
self,
item_format: str = 'json',
*,
item_format: str = 'json',
offset: Optional[int] = None,
limit: Optional[int] = None,
desc: Optional[bool] = None,
Expand Down Expand Up @@ -280,8 +281,8 @@ def download_items(

def stream_items(
self,
item_format: str = 'json',
*,
item_format: str = 'json',
offset: Optional[int] = None,
limit: Optional[int] = None,
desc: Optional[bool] = None,
Expand Down