Introduce default client timeout

Author: Pijukatel

src/apify_client/client.py

@@ -54,6 +54,7 @@
 )
 
 DEFAULT_API_URL = 'https://api.apify.com'
+DEFAULT_TIMEOUT = 360
 API_VERSION = 'v2'
 
 
@@ -68,7 +69,7 @@ def __init__(
         api_url: str | None = None,
         max_retries: int | None = 8,
         min_delay_between_retries_millis: int | None = 500,
-        timeout_secs: int | None = 360,
+        timeout_secs: int | None = DEFAULT_TIMEOUT,
     ) -> None:
         """Initialize a new instance.
 
@@ -85,7 +86,7 @@ def __init__(
         self.base_url = f'{api_url}/{API_VERSION}'
         self.max_retries = max_retries or 8
         self.min_delay_between_retries_millis = min_delay_between_retries_millis or 500
-        self.timeout_secs = timeout_secs or 360
+        self.timeout_secs = timeout_secs or DEFAULT_TIMEOUT
 
     def _options(self) -> dict:
         return {
@@ -107,7 +108,7 @@ def __init__(
         api_url: str | None = None,
         max_retries: int | None = 8,
         min_delay_between_retries_millis: int | None = 500,
-        timeout_secs: int | None = 360,
+        timeout_secs: int | None = DEFAULT_TIMEOUT,
     ) -> None:
         """Initialize a new instance.
 
@@ -290,7 +291,7 @@ def __init__(
         api_url: str | None = None,
         max_retries: int | None = 8,
         min_delay_between_retries_millis: int | None = 500,
-        timeout_secs: int | None = 360,
+        timeout_secs: int | None = DEFAULT_TIMEOUT,
     ) -> None:
         """Initialize a new instance.
 

tests/unit/test_client_timeouts.py

@@ -8,6 +8,7 @@
 
 from apify_client import ApifyClient
 from apify_client._http_client import HTTPClient, HTTPClientAsync
+from apify_client.client import DEFAULT_TIMEOUT
 from apify_client.clients import DatasetClient, KeyValueStoreClient, RequestQueueClient
 from apify_client.clients.resource_clients import dataset, request_queue
 from apify_client.clients.resource_clients import key_value_store as kvs
@@ -17,16 +18,6 @@ class EndOfTestError(Exception):
     """Custom exception that is raised after the relevant part of the code is executed to stop the test."""
 
 
-def assert_timeout(expected_timeout: int, request: Request) -> Response:
-    assert request.extensions['timeout'] == {
-        'connect': expected_timeout,
-        'pool': expected_timeout,
-        'read': expected_timeout,
-        'write': expected_timeout,
-    }
-    raise EndOfTestError
-
-
 @respx.mock
 async def test_dynamic_timeout_async_client() -> None:
     """Tests timeout values for request with retriable errors.
@@ -83,22 +74,36 @@ def check_timeout(request: Request) -> Response:
     HTTPClient(timeout_secs=client_timeout).call(method='GET', url='https://example.com', timeout_secs=call_timeout)
 
 
+def assert_timeout(expected_timeout: int, request: Request) -> Response:
+    """Assert that correct timeouts are set on the request and raise `EndOfTestError`.
+
+    This is intended for tests that are only testing timeout value and further execution of the code is not desired.
+    """
+    assert request.extensions['timeout'] == {
+        'connect': expected_timeout,
+        'pool': expected_timeout,
+        'read': expected_timeout,
+        'write': expected_timeout,
+    }
+    raise EndOfTestError
+
+
 _timeout_params = [
     (DatasetClient, 'get', dataset._SMALL_TIMEOUT, {}),
     (DatasetClient, 'update', dataset._SMALL_TIMEOUT, {}),
     (DatasetClient, 'delete', dataset._SMALL_TIMEOUT, {}),
-    (DatasetClient, 'list_items', 360, {}),
-    (DatasetClient, 'download_items', 360, {}),
-    (DatasetClient, 'get_items_as_bytes', 360, {}),
+    (DatasetClient, 'list_items', DEFAULT_TIMEOUT, {}),
+    (DatasetClient, 'download_items', DEFAULT_TIMEOUT, {}),
+    (DatasetClient, 'get_items_as_bytes', DEFAULT_TIMEOUT, {}),
     (DatasetClient, 'push_items', dataset._MEDIUM_TIMEOUT, {'items': {}}),
     (DatasetClient, 'get_statistics', dataset._SMALL_TIMEOUT, {}),
     (KeyValueStoreClient, 'get', kvs._SMALL_TIMEOUT, {}),
-    (KeyValueStoreClient, 'update', 360, {}),
+    (KeyValueStoreClient, 'update', DEFAULT_TIMEOUT, {}),
     (KeyValueStoreClient, 'delete', kvs._SMALL_TIMEOUT, {}),
     (KeyValueStoreClient, 'list_keys', kvs._MEDIUM_TIMEOUT, {}),
-    (KeyValueStoreClient, 'get_record', 360, {'key': 'some_key'}),
-    (KeyValueStoreClient, 'get_record_as_bytes', 360, {'key': 'some_key'}),
-    (KeyValueStoreClient, 'set_record', 360, {'key': 'some_key', 'value': 'some_value'}),
+    (KeyValueStoreClient, 'get_record', DEFAULT_TIMEOUT, {'key': 'some_key'}),
+    (KeyValueStoreClient, 'get_record_as_bytes', DEFAULT_TIMEOUT, {'key': 'some_key'}),
+    (KeyValueStoreClient, 'set_record', DEFAULT_TIMEOUT, {'key': 'some_key', 'value': 'some_value'}),
     (KeyValueStoreClient, 'delete_record', kvs._SMALL_TIMEOUT, {'key': 'some_key'}),
     (RequestQueueClient, 'get', request_queue._SMALL_TIMEOUT, {}),
     (RequestQueueClient, 'update', kvs._SMALL_TIMEOUT, {}),