feat: Expose apify_client.errors module (#468)

- Move apify_client._errors to apify_client.errors

### Issues

- Closes: #158

Author: Mantisus

src/apify_client/_http_client.py

@@ -13,10 +13,10 @@
 import impit
 from apify_shared.utils import ignore_docs, is_content_type_json, is_content_type_text, is_content_type_xml
 
-from apify_client._errors import ApifyApiError, InvalidResponseBodyError, is_retryable_error
 from apify_client._logging import log_context, logger_name
 from apify_client._statistics import Statistics
-from apify_client._utils import retry_with_exp_backoff, retry_with_exp_backoff_async
+from apify_client._utils import is_retryable_error, retry_with_exp_backoff, retry_with_exp_backoff_async
+from apify_client.errors import ApifyApiError, InvalidResponseBodyError
 
 if TYPE_CHECKING:
     from collections.abc import Callable

src/apify_client/_utils.py

@@ -9,12 +9,15 @@
 from http import HTTPStatus
 from typing import TYPE_CHECKING, Any, TypeVar, cast
 
+import impit
 from apify_shared.utils import is_file_or_bytes, maybe_extract_enum_member_value
 
+from apify_client.errors import InvalidResponseBodyError
+
 if TYPE_CHECKING:
     from collections.abc import Awaitable
 
-    from apify_client._errors import ApifyApiError
+    from apify_client.errors import ApifyApiError
 
 PARSE_DATE_FIELDS_MAX_DEPTH = 3
 PARSE_DATE_FIELDS_KEY_SUFFIX = 'At'
@@ -149,3 +152,16 @@ def encode_key_value_store_record_value(value: Any, content_type: str | None = N
         value = json.dumps(value, ensure_ascii=False, indent=2, allow_nan=False, default=str).encode('utf-8')
 
     return (value, content_type)
+
+
+def is_retryable_error(exc: Exception) -> bool:
+    """Check if the given error is retryable."""
+    return isinstance(
+        exc,
+        (
+            InvalidResponseBodyError,
+            impit.NetworkError,
+            impit.TimeoutException,
+            impit.RemoteProtocolError,
+        ),
+    )

src/apify_client/clients/base/actor_job_base_client.py

@@ -9,9 +9,9 @@
 from apify_shared.consts import ActorJobStatus
 from apify_shared.utils import ignore_docs, parse_date_fields
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw, pluck_data
 from apify_client.clients.base.resource_client import ResourceClient, ResourceClientAsync
+from apify_client.errors import ApifyApiError
 
 DEFAULT_WAIT_FOR_FINISH_SEC = 999999
 

src/apify_client/clients/base/resource_client.py

@@ -4,9 +4,9 @@
 
 from apify_shared.utils import ignore_docs, parse_date_fields
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw, pluck_data
 from apify_client.clients.base.base_client import BaseClient, BaseClientAsync
+from apify_client.errors import ApifyApiError
 
 
 @ignore_docs

src/apify_client/clients/resource_clients/dataset.py

@@ -8,9 +8,9 @@
 from apify_shared.models import ListPage
 from apify_shared.utils import filter_out_none_values_recursively, ignore_docs
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw, pluck_data
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
+from apify_client.errors import ApifyApiError
 
 if TYPE_CHECKING:
     from collections.abc import AsyncIterator, Iterator

src/apify_client/clients/resource_clients/key_value_store.py

@@ -8,9 +8,9 @@
 
 from apify_shared.utils import filter_out_none_values_recursively, ignore_docs, parse_date_fields
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw, encode_key_value_store_record_value, pluck_data
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
+from apify_client.errors import ApifyApiError
 
 if TYPE_CHECKING:
     from collections.abc import AsyncIterator, Iterator

src/apify_client/clients/resource_clients/log.py

@@ -13,9 +13,9 @@
 
 from apify_shared.utils import ignore_docs
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
+from apify_client.errors import ApifyApiError
 
 if TYPE_CHECKING:
     from collections.abc import AsyncIterator, Iterator

src/apify_client/clients/resource_clients/request_queue.py

@@ -11,9 +11,9 @@
 from apify_shared.utils import filter_out_none_values_recursively, ignore_docs, parse_date_fields
 from more_itertools import constrained_batches
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw, pluck_data
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
+from apify_client.errors import ApifyApiError
 
 if TYPE_CHECKING:
     from datetime import timedelta

src/apify_client/clients/resource_clients/schedule.py

@@ -5,9 +5,9 @@
 
 from apify_shared.utils import filter_out_none_values_recursively, ignore_docs
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw, pluck_data_as_list
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
+from apify_client.errors import ApifyApiError
 
 
 def _get_schedule_representation(

src/apify_client/clients/resource_clients/task.py

@@ -10,7 +10,6 @@
     parse_date_fields,
 )
 
-from apify_client._errors import ApifyApiError
 from apify_client._utils import catch_not_found_or_throw, encode_webhook_list_to_base64, pluck_data
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
 from apify_client.clients.resource_clients.run import RunClient, RunClientAsync
@@ -19,6 +18,7 @@
     WebhookCollectionClient,
     WebhookCollectionClientAsync,
 )
+from apify_client.errors import ApifyApiError
 
 if TYPE_CHECKING:
     from apify_shared.consts import ActorJobStatus, MetaOrigin