Fix tests and docs code

Author: vdusek

docs/01_overview/code/01_usage_async.py

@@ -16,6 +16,6 @@ async def main() -> None:
         return
 
     # Fetch results from the Actor run's default dataset.
-    dataset_client = apify_client.dataset(call_result['defaultDatasetId'])
+    dataset_client = apify_client.dataset(call_result.default_dataset_id)
     list_items_result = await dataset_client.list_items()
     print(f'Dataset: {list_items_result}')

docs/01_overview/code/01_usage_sync.py

@@ -16,6 +16,6 @@ def main() -> None:
         return
 
     # Fetch results from the Actor run's default dataset.
-    dataset_client = apify_client.dataset(call_result['defaultDatasetId'])
+    dataset_client = apify_client.dataset(call_result.default_dataset_id)
     list_items_result = dataset_client.list_items()
     print(f'Dataset: {list_items_result}')

docs/02_concepts/code/01_async_support.py

@@ -11,7 +11,7 @@ async def main() -> None:
 
     # Start the Actor and get the run ID
     run_result = await actor_client.start()
-    run_client = apify_client.run(run_result['id'])
+    run_client = apify_client.run(run_result.id)
     log_client = run_client.log()
 
     # Stream the logs

docs/03_examples/code/02_tasks_async.py

@@ -1,22 +1,22 @@
 import asyncio
 
 from apify_client import ApifyClientAsync
-from apify_client.clients.resource_clients import TaskClientAsync
+from apify_client._models import Run, Task
+from apify_client._resource_clients import TaskClientAsync
 
 TOKEN = 'MY-APIFY-TOKEN'
 HASHTAGS = ['zebra', 'lion', 'hippo']
 
 
-async def run_apify_task(client: TaskClientAsync) -> dict:
-    result = await client.call()
-    return result or {}
+async def run_apify_task(client: TaskClientAsync) -> Run | None:
+    return await client.call()
 
 
 async def main() -> None:
     apify_client = ApifyClientAsync(token=TOKEN)
 
     # Create Apify tasks
-    apify_tasks = list[dict]()
+    apify_tasks = list[Task]()
     apify_tasks_client = apify_client.tasks()
 
     for hashtag in HASHTAGS:
@@ -34,7 +34,7 @@ async def main() -> None:
     apify_task_clients = list[TaskClientAsync]()
 
     for apify_task in apify_tasks:
-        task_id = apify_task['id']
+        task_id = apify_task.id
         apify_task_client = apify_client.task(task_id)
         apify_task_clients.append(apify_task_client)
 

docs/03_examples/code/02_tasks_sync.py

@@ -1,20 +1,20 @@
 from apify_client import ApifyClient
-from apify_client.clients.resource_clients import TaskClient
+from apify_client._models import Run, Task
+from apify_client._resource_clients import TaskClient
 
 TOKEN = 'MY-APIFY-TOKEN'
 HASHTAGS = ['zebra', 'lion', 'hippo']
 
 
-def run_apify_task(client: TaskClient) -> dict:
-    result = client.call()
-    return result or {}
+def run_apify_task(client: TaskClient) -> Run | None:
+    return client.call()
 
 
 def main() -> None:
     apify_client = ApifyClient(token=TOKEN)
 
     # Create Apify tasks
-    apify_tasks = list[dict]()
+    apify_tasks = list[Task]()
     apify_tasks_client = apify_client.tasks()
 
     for hashtag in HASHTAGS:
@@ -32,18 +32,19 @@ def main() -> None:
     apify_task_clients = list[TaskClient]()
 
     for apify_task in apify_tasks:
-        task_id = apify_task['id']
+        task_id = apify_task.id
         apify_task_client = apify_client.task(task_id)
         apify_task_clients.append(apify_task_client)
 
     print('Task clients created:', apify_task_clients)
 
     # Execute Apify tasks
-    task_run_results = list[dict]()
+    task_run_results = list[Run]()
 
     for client in apify_task_clients:
         result = run_apify_task(client)
-        task_run_results.append(result)
+        if result is not None:
+            task_run_results.append(result)
 
     print('Task results:', task_run_results)
 

docs/03_examples/code/03_retrieve_async.py

@@ -19,11 +19,11 @@ async def main() -> None:
 
     for dataset_item in actor_datasets.items:
         # Dataset items can be handled here. Dataset items can be paginated
-        dataset_client = apify_client.dataset(dataset_item['id'])
+        dataset_client = apify_client.dataset(dataset_item.id)
         dataset_items = await dataset_client.list_items(limit=1000)
 
         # Items can be pushed to single dataset
-        merging_dataset_client = apify_client.dataset(merging_dataset['id'])
+        merging_dataset_client = apify_client.dataset(merging_dataset.id)
         await merging_dataset_client.push_items(dataset_items.items)
 
         # ...

docs/03_examples/code/03_retrieve_sync.py

@@ -17,11 +17,11 @@ def main() -> None:
 
     for dataset_item in actor_datasets.items:
         # Dataset items can be handled here. Dataset items can be paginated
-        dataset_client = apify_client.dataset(dataset_item['id'])
+        dataset_client = apify_client.dataset(dataset_item.id)
         dataset_items = dataset_client.list_items(limit=1000)
 
         # Items can be pushed to single dataset
-        merging_dataset_client = apify_client.dataset(merging_dataset['id'])
+        merging_dataset_client = apify_client.dataset(merging_dataset.id)
         merging_dataset_client.push_items(dataset_items.items)
 
         # ...

scripts/utils.py

@@ -25,7 +25,7 @@ def get_current_package_version() -> str:
 # It replaces the version number on the line with the format `version = "1.2.3"`
 def set_current_package_version(version: str) -> None:
     with open(PYPROJECT_TOML_FILE_PATH, 'r+', encoding='utf-8') as pyproject_toml_file:
-        updated_pyproject_toml_file_lines = []
+        updated_pyproject_toml_file_lines = list[str]()
         version_string_found = False
         for line in pyproject_toml_file:
             line_processed = line

src/apify_client/_http_client.py

@@ -125,7 +125,7 @@ def _build_url_with_params(self, url: str, params: dict | None = None) -> str:
         if not params:
             return url
 
-        param_pairs: list[tuple[str, str]] = []
+        param_pairs = list[tuple[str, str]]()
         for key, value in params.items():
             if isinstance(value, list):
                 param_pairs.extend((key, str(v)) for v in value)

src/apify_client/_resource_clients/log.py

@@ -22,6 +22,7 @@
     import impit
     from typing_extensions import Self
 
+    from apify_client._models import Run
     from apify_client._resource_clients import RunClient, RunClientAsync
 
 
@@ -404,25 +405,25 @@ def __init__(self, *, to_logger: logging.Logger, check_period: timedelta = timed
         self._check_period = check_period.total_seconds()
         self._last_status_message = ''
 
-    def _log_run_data(self, run_data: dict[str, Any] | None) -> bool:
+    def _log_run_data(self, run_data: Run | None) -> bool:
         """Get relevant run data, log them if changed and return `True` if more data is expected.
 
         Args:
-            run_data: The dictionary that contains the run data.
+            run_data: The Run model that contains the run data.
 
         Returns:
               `True` if more data is expected, `False` otherwise.
         """
         if run_data is not None:
-            status = run_data.get('status', 'Unknown status')
-            status_message = run_data.get('statusMessage', '')
+            status = run_data.status if run_data.status else 'Unknown status'
+            status_message = run_data.status_message or ''
             new_status_message = f'Status: {status}, Message: {status_message}'
 
             if new_status_message != self._last_status_message:
                 self._last_status_message = new_status_message
                 self._to_logger.info(new_status_message)
 
-            return not (run_data.get('isStatusMessageTerminal', False))
+            return not (run_data.is_status_message_terminal or False)
         return True