diff --git a/docs/02_concepts/04_error_handling.mdx b/docs/02_concepts/04_error_handling.mdx index a2d6ef3d..4c465b81 100644 --- a/docs/02_concepts/04_error_handling.mdx +++ b/docs/02_concepts/04_error_handling.mdx @@ -43,4 +43,8 @@ All subclasses inherit from `ApifyApiError` +## Response validation errors + +The client validates every API response against its model. When a response does not match, for example because the API changed ahead of the client, it raises a `ResponseValidationError` instead of a bare `pydantic.ValidationError`. It inherits from `ApifyClientError`, so a handler for client errors catches it. It also inherits from `pydantic.ValidationError`, so `errors()` lists the individual mismatches and an existing `except pydantic.ValidationError` or `except ValueError` handler keeps working. The `method` and `url` attributes name the request whose response failed, and `__cause__` holds the original validation error. + For a complete list of error classes, see the `ApifyApiError` reference. diff --git a/src/apify_client/_resource_clients/actor.py b/src/apify_client/_resource_clients/actor.py index eb7cec5d..fae23a93 100644 --- a/src/apify_client/_resource_clients/actor.py +++ b/src/apify_client/_resource_clients/actor.py @@ -24,7 +24,7 @@ ) from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync from apify_client._utils.encoding import encode_key_value_store_record_value, encode_webhooks_to_base64 -from apify_client._utils.http import response_to_dict +from apify_client._utils.http import response_to_dict, validate_response from apify_client._utils.server_args import build_actor_standby from apify_client._utils.time import to_seconds from apify_client._utils.wait_for_resources import ( @@ -104,7 +104,7 @@ def get(self, *, timeout: Timeout = 'short') -> ActorResource | None: result = self._get(timeout=timeout) if result is None: return None - return ActorResponse.model_validate(result).data + return validate_response(ActorResponse, result).data def update( self, @@ -264,7 +264,7 @@ def update( tagged_builds=tagged_builds, ) result = self._update(timeout=timeout, **actor_fields.model_dump(by_alias=True, exclude_none=True)) - return ActorResponse.model_validate(result).data + return validate_response(ActorResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the Actor. @@ -368,7 +368,7 @@ def start( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def call( self, @@ -522,7 +522,7 @@ def build( ) result = response_to_dict(response) - return BuildResponse.model_validate(result).data + return validate_response(BuildResponse, result).data def builds(self) -> BuildCollectionClient: """Retrieve a client for the builds of this Actor.""" @@ -751,7 +751,7 @@ async def get(self, *, timeout: Timeout = 'short') -> ActorResource | None: result = await self._get(timeout=timeout) if result is None: return None - return ActorResponse.model_validate(result).data + return validate_response(ActorResponse, result).data async def update( self, @@ -911,7 +911,7 @@ async def update( tagged_builds=tagged_builds, ) result = await self._update(timeout=timeout, **actor_fields.model_dump(by_alias=True, exclude_none=True)) - return ActorResponse.model_validate(result).data + return validate_response(ActorResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the Actor. @@ -1015,7 +1015,7 @@ async def start( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data async def call( self, @@ -1170,7 +1170,7 @@ async def build( ) result = response_to_dict(response) - return BuildResponse.model_validate(result).data + return validate_response(BuildResponse, result).data def builds(self) -> BuildCollectionClientAsync: """Retrieve a client for the builds of this Actor.""" diff --git a/src/apify_client/_resource_clients/actor_collection.py b/src/apify_client/_resource_clients/actor_collection.py index 7838f412..5a170ea2 100644 --- a/src/apify_client/_resource_clients/actor_collection.py +++ b/src/apify_client/_resource_clients/actor_collection.py @@ -14,6 +14,7 @@ ) from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response from apify_client._utils.server_args import build_actor_standby from apify_client._utils.time import to_seconds @@ -71,7 +72,7 @@ def list( The list of available Actors matching the specified filters. """ result = self._list(timeout=timeout, my=my, limit=limit, offset=offset, desc=desc, sortBy=sort_by) - return ListOfActorsResponse.model_validate(result).data + return validate_response(ListOfActorsResponse, result).data def iterate( self, @@ -259,7 +260,7 @@ def create( ), ) result = self._create(timeout=timeout, **actor_fields.model_dump(by_alias=True, exclude_none=True)) - return ActorResponse.model_validate(result).data + return validate_response(ActorResponse, result).data @docs_group('Resource clients') @@ -307,7 +308,7 @@ async def list( The list of available Actors matching the specified filters. """ result = await self._list(timeout=timeout, my=my, limit=limit, offset=offset, desc=desc, sortBy=sort_by) - return ListOfActorsResponse.model_validate(result).data + return validate_response(ListOfActorsResponse, result).data def iterate( self, @@ -495,4 +496,4 @@ async def create( ), ) result = await self._create(timeout=timeout, **actor_fields.model_dump(by_alias=True, exclude_none=True)) - return ActorResponse.model_validate(result).data + return validate_response(ActorResponse, result).data diff --git a/src/apify_client/_resource_clients/actor_env_var.py b/src/apify_client/_resource_clients/actor_env_var.py index 9d04018a..790939c3 100644 --- a/src/apify_client/_resource_clients/actor_env_var.py +++ b/src/apify_client/_resource_clients/actor_env_var.py @@ -5,6 +5,7 @@ from apify_client._docs import docs_group from apify_client._models import EnvVar, EnvVarResponse from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from apify_client.types import Timeout @@ -45,7 +46,7 @@ def get(self, *, timeout: Timeout = 'short') -> EnvVar | None: result = self._get(timeout=timeout) if result is None: return None - return EnvVarResponse.model_validate(result).data + return validate_response(EnvVarResponse, result).data def update( self, @@ -72,7 +73,7 @@ def update( timeout=timeout, **EnvVar(name=name, value=value, is_secret=is_secret).model_dump(by_alias=True, exclude_none=True), ) - return EnvVarResponse.model_validate(result).data + return validate_response(EnvVarResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the Actor environment variable. @@ -120,7 +121,7 @@ async def get(self, *, timeout: Timeout = 'short') -> EnvVar | None: result = await self._get(timeout=timeout) if result is None: return None - return EnvVarResponse.model_validate(result).data + return validate_response(EnvVarResponse, result).data async def update( self, @@ -147,7 +148,7 @@ async def update( timeout=timeout, **EnvVar(name=name, value=value, is_secret=is_secret).model_dump(by_alias=True, exclude_none=True), ) - return EnvVarResponse.model_validate(result).data + return validate_response(EnvVarResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the Actor environment variable. diff --git a/src/apify_client/_resource_clients/actor_env_var_collection.py b/src/apify_client/_resource_clients/actor_env_var_collection.py index 2a013d35..baa4896b 100644 --- a/src/apify_client/_resource_clients/actor_env_var_collection.py +++ b/src/apify_client/_resource_clients/actor_env_var_collection.py @@ -5,6 +5,7 @@ from apify_client._docs import docs_group from apify_client._models import EnvVar, EnvVarResponse, ListOfEnvVars, ListOfEnvVarsResponse from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -43,7 +44,7 @@ def list(self, *, timeout: Timeout = 'short') -> ListOfEnvVars: The list of available Actor environment variables. """ result = self._list(timeout=timeout) - return ListOfEnvVarsResponse.model_validate(result).data + return validate_response(ListOfEnvVarsResponse, result).data def iterate(self, *, timeout: Timeout = 'short') -> Iterator[EnvVar]: """Iterate over the available Actor environment variables. @@ -88,7 +89,7 @@ def create( timeout=timeout, **EnvVar(name=name, value=value, is_secret=is_secret).model_dump(by_alias=True, exclude_none=True), ) - return EnvVarResponse.model_validate(result).data + return validate_response(EnvVarResponse, result).data @docs_group('Resource clients') @@ -122,7 +123,7 @@ async def list(self, *, timeout: Timeout = 'short') -> ListOfEnvVars: The list of available Actor environment variables. """ result = await self._list(timeout=timeout) - return ListOfEnvVarsResponse.model_validate(result).data + return validate_response(ListOfEnvVarsResponse, result).data async def iterate(self, *, timeout: Timeout = 'short') -> AsyncIterator[EnvVar]: """Iterate over the available Actor environment variables. @@ -168,4 +169,4 @@ async def create( timeout=timeout, **EnvVar(name=name, value=value, is_secret=is_secret).model_dump(by_alias=True, exclude_none=True), ) - return EnvVarResponse.model_validate(result).data + return validate_response(EnvVarResponse, result).data diff --git a/src/apify_client/_resource_clients/actor_server.py b/src/apify_client/_resource_clients/actor_server.py index 1429c3b3..556670e4 100644 --- a/src/apify_client/_resource_clients/actor_server.py +++ b/src/apify_client/_resource_clients/actor_server.py @@ -6,7 +6,7 @@ from apify_client._docs import docs_group from apify_client._models import ActorResponse from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync -from apify_client._utils.http import merge_headers, response_to_dict +from apify_client._utils.http import merge_headers, response_to_dict, validate_response from apify_client.errors import ApifyClientError from apify_client.http_compressors._resolve import resolve_compressor @@ -239,7 +239,7 @@ def _get_server_actor(self, *, timeout: Timeout) -> tuple[ActorResource, str]: The Actor and the URL of its server. """ response = self._http_client.call(url=self._build_url(), method='GET', timeout=timeout) - actor = ActorResponse.model_validate(response_to_dict(response)).data + actor = validate_response(ActorResponse, response_to_dict(response)).data url = actor.standby_url if url is None: raise ApifyClientError(f'Actor {self.resource_id} is not a Server Actor.') @@ -442,7 +442,7 @@ async def _get_server_actor(self, *, timeout: Timeout) -> tuple[ActorResource, s The Actor and the URL of its server. """ response = await self._http_client.call(url=self._build_url(), method='GET', timeout=timeout) - actor = ActorResponse.model_validate(response_to_dict(response)).data + actor = validate_response(ActorResponse, response_to_dict(response)).data url = actor.standby_url if url is None: raise ApifyClientError(f'Actor {self.resource_id} is not a Server Actor.') diff --git a/src/apify_client/_resource_clients/actor_version.py b/src/apify_client/_resource_clients/actor_version.py index 20c849a4..5fc00fc9 100644 --- a/src/apify_client/_resource_clients/actor_version.py +++ b/src/apify_client/_resource_clients/actor_version.py @@ -14,6 +14,7 @@ VersionResponse, ) from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from apify_client._literals import VersionSourceType @@ -63,7 +64,7 @@ def get(self, *, timeout: Timeout = 'short') -> Version | None: result = self._get(timeout=timeout) if result is None: return None - return VersionResponse.model_validate(result).data + return validate_response(VersionResponse, result).data def update( self, @@ -121,7 +122,7 @@ def update( actor_path=actor_path, ) result = self._update(timeout=timeout, **version_fields.model_dump(by_alias=True, exclude_none=True)) - return VersionResponse.model_validate(result).data + return validate_response(VersionResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the Actor version. @@ -187,7 +188,7 @@ async def get(self, *, timeout: Timeout = 'short') -> Version | None: result = await self._get(timeout=timeout) if result is None: return None - return VersionResponse.model_validate(result).data + return validate_response(VersionResponse, result).data async def update( self, @@ -245,7 +246,7 @@ async def update( actor_path=actor_path, ) result = await self._update(timeout=timeout, **version_fields.model_dump(by_alias=True, exclude_none=True)) - return VersionResponse.model_validate(result).data + return validate_response(VersionResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the Actor version. diff --git a/src/apify_client/_resource_clients/actor_version_collection.py b/src/apify_client/_resource_clients/actor_version_collection.py index 3a09a6b6..d7a2c318 100644 --- a/src/apify_client/_resource_clients/actor_version_collection.py +++ b/src/apify_client/_resource_clients/actor_version_collection.py @@ -16,6 +16,7 @@ VersionResponse, ) from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -58,7 +59,7 @@ def list(self, *, timeout: Timeout = 'short') -> ListOfVersions: The list of available Actor versions. """ result = self._list(timeout=timeout) - return ListOfVersionsResponse.model_validate(result).data + return validate_response(ListOfVersionsResponse, result).data def iterate(self, *, timeout: Timeout = 'short') -> Iterator[Version]: """Iterate over the available Actor versions. @@ -135,7 +136,7 @@ def create( actor_path=actor_path, ) result = self._create(timeout=timeout, **version_fields.model_dump(by_alias=True, exclude_none=True)) - return VersionResponse.model_validate(result).data + return validate_response(VersionResponse, result).data @docs_group('Resource clients') @@ -169,7 +170,7 @@ async def list(self, *, timeout: Timeout = 'short') -> ListOfVersions: The list of available Actor versions. """ result = await self._list(timeout=timeout) - return ListOfVersionsResponse.model_validate(result).data + return validate_response(ListOfVersionsResponse, result).data async def iterate(self, *, timeout: Timeout = 'short') -> AsyncIterator[Version]: """Iterate over the available Actor versions. @@ -247,4 +248,4 @@ async def create( actor_path=actor_path, ) result = await self._create(timeout=timeout, **version_fields.model_dump(by_alias=True, exclude_none=True)) - return VersionResponse.model_validate(result).data + return validate_response(VersionResponse, result).data diff --git a/src/apify_client/_resource_clients/build.py b/src/apify_client/_resource_clients/build.py index c0db13ed..69694549 100644 --- a/src/apify_client/_resource_clients/build.py +++ b/src/apify_client/_resource_clients/build.py @@ -5,7 +5,7 @@ from apify_client._docs import docs_group from apify_client._models import Build, BuildResponse from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync -from apify_client._utils.http import response_to_dict +from apify_client._utils.http import response_to_dict, validate_response if TYPE_CHECKING: from datetime import timedelta @@ -53,7 +53,7 @@ def get(self, *, wait_for_finish: timedelta | int | None = None, timeout: Timeou result = self._get(timeout=request_timeout, waitForFinish=wait_for_finish_secs) if result is None: return None - return BuildResponse.model_validate(result).data + return validate_response(BuildResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the build. @@ -83,7 +83,7 @@ def abort(self, *, timeout: Timeout = 'short') -> Build: timeout=timeout, ) result = response_to_dict(response) - return BuildResponse.model_validate(result).data + return validate_response(BuildResponse, result).data def get_open_api_definition(self, *, timeout: Timeout = 'medium') -> dict: """Return OpenAPI definition of the Actor's build. @@ -122,7 +122,7 @@ def wait_for_finish( wait_duration=wait_duration, timeout=timeout, ) - return Build.model_validate(result) if result is not None else None + return validate_response(Build, result) if result is not None else None def log(self) -> LogClient: """Get the client for the log of the Actor build. @@ -177,7 +177,7 @@ async def get(self, *, wait_for_finish: timedelta | int | None = None, timeout: result = await self._get(timeout=request_timeout, waitForFinish=wait_for_finish_secs) if result is None: return None - return BuildResponse.model_validate(result).data + return validate_response(BuildResponse, result).data async def abort(self, *, timeout: Timeout = 'short') -> Build: """Abort the Actor build which is starting or currently running and return its details. @@ -197,7 +197,7 @@ async def abort(self, *, timeout: Timeout = 'short') -> Build: timeout=timeout, ) result = response_to_dict(response) - return BuildResponse.model_validate(result).data + return validate_response(BuildResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the build. @@ -246,7 +246,7 @@ async def wait_for_finish( wait_duration=wait_duration, timeout=timeout, ) - return Build.model_validate(result) if result is not None else None + return validate_response(Build, result) if result is not None else None def log(self) -> LogClientAsync: """Get the client for the log of the Actor build. diff --git a/src/apify_client/_resource_clients/build_collection.py b/src/apify_client/_resource_clients/build_collection.py index eea37af3..4aa5e686 100644 --- a/src/apify_client/_resource_clients/build_collection.py +++ b/src/apify_client/_resource_clients/build_collection.py @@ -6,6 +6,7 @@ from apify_client._models import ListOfBuilds, ListOfBuildsResponse from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -59,7 +60,7 @@ def list( The retrieved Actor builds. """ result = self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfBuildsResponse.model_validate(result).data + return validate_response(ListOfBuildsResponse, result).data def iterate( self, @@ -140,7 +141,7 @@ async def list( The retrieved Actor builds. """ result = await self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfBuildsResponse.model_validate(result).data + return validate_response(ListOfBuildsResponse, result).data def iterate( self, diff --git a/src/apify_client/_resource_clients/dataset.py b/src/apify_client/_resource_clients/dataset.py index 1a216842..6ace6985 100644 --- a/src/apify_client/_resource_clients/dataset.py +++ b/src/apify_client/_resource_clients/dataset.py @@ -9,7 +9,7 @@ from apify_client._pagination import DEFAULT_CHUNK_SIZE, get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync from apify_client._utils.crypto import create_storage_content_signature -from apify_client._utils.http import response_to_dict, response_to_list +from apify_client._utils.http import response_to_dict, response_to_list, validate_response if TYPE_CHECKING: from collections.abc import AsyncGenerator, AsyncIterator, Generator, Iterator @@ -84,7 +84,7 @@ def get(self, *, timeout: Timeout = 'short') -> DatasetResource | None: result = self._get(timeout=timeout) if result is None: return None - return DatasetResponse.model_validate(result).data + return validate_response(DatasetResponse, result).data def update( self, @@ -113,7 +113,7 @@ def update( title=title, generalAccess=general_access, ) - return DatasetResponse.model_validate(result).data + return validate_response(DatasetResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the dataset. @@ -559,7 +559,7 @@ def get_statistics(self, *, timeout: Timeout = 'short') -> DatasetStatistics: timeout=timeout, ) result = response_to_dict(response) - return DatasetStatisticsResponse.model_validate(result).data + return validate_response(DatasetStatisticsResponse, result).data def create_items_public_url( self, @@ -677,7 +677,7 @@ async def get(self, *, timeout: Timeout = 'short') -> DatasetResource | None: result = await self._get(timeout=timeout) if result is None: return None - return DatasetResponse.model_validate(result).data + return validate_response(DatasetResponse, result).data async def update( self, @@ -706,7 +706,7 @@ async def update( title=title, generalAccess=general_access, ) - return DatasetResponse.model_validate(result).data + return validate_response(DatasetResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the dataset. @@ -1154,7 +1154,7 @@ async def get_statistics(self, *, timeout: Timeout = 'short') -> DatasetStatisti timeout=timeout, ) result = response_to_dict(response) - return DatasetStatisticsResponse.model_validate(result).data + return validate_response(DatasetStatisticsResponse, result).data async def create_items_public_url( self, diff --git a/src/apify_client/_resource_clients/dataset_collection.py b/src/apify_client/_resource_clients/dataset_collection.py index 6533f811..68bc9289 100644 --- a/src/apify_client/_resource_clients/dataset_collection.py +++ b/src/apify_client/_resource_clients/dataset_collection.py @@ -11,6 +11,7 @@ ) from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -73,7 +74,7 @@ def list( desc=desc, ownership=ownership, ) - return ListOfDatasetsResponse.model_validate(result).data + return validate_response(ListOfDatasetsResponse, result).data def iterate( self, @@ -134,7 +135,7 @@ def get_or_create( The retrieved or newly-created dataset. """ result = self._get_or_create(timeout=timeout, name=name, resource_fields={'schema': schema}) - return DatasetResponse.model_validate(result).data + return validate_response(DatasetResponse, result).data @docs_group('Resource clients') @@ -190,7 +191,7 @@ async def list( desc=desc, ownership=ownership, ) - return ListOfDatasetsResponse.model_validate(result).data + return validate_response(ListOfDatasetsResponse, result).data def iterate( self, @@ -251,4 +252,4 @@ async def get_or_create( The retrieved or newly-created dataset. """ result = await self._get_or_create(timeout=timeout, name=name, resource_fields={'schema': schema}) - return DatasetResponse.model_validate(result).data + return validate_response(DatasetResponse, result).data diff --git a/src/apify_client/_resource_clients/key_value_store.py b/src/apify_client/_resource_clients/key_value_store.py index 1ec6e5fe..ac4e8c8a 100644 --- a/src/apify_client/_resource_clients/key_value_store.py +++ b/src/apify_client/_resource_clients/key_value_store.py @@ -18,7 +18,7 @@ from apify_client._utils.crypto import create_hmac_signature, create_storage_content_signature from apify_client._utils.encoding import encode_key_value_store_record_value from apify_client._utils.errors import catch_not_found_or_throw -from apify_client._utils.http import response_to_dict, to_path_segment +from apify_client._utils.http import response_to_dict, to_path_segment, validate_response from apify_client.errors import ApifyApiError, InvalidResponseBodyError if TYPE_CHECKING: @@ -103,7 +103,7 @@ def get(self, *, timeout: Timeout = 'short') -> KeyValueStoreResource | None: result = self._get(timeout=timeout) if result is None: return None - return KeyValueStoreResponse.model_validate(result).data + return validate_response(KeyValueStoreResponse, result).data def update( self, @@ -127,7 +127,7 @@ def update( The updated key-value store. """ result = self._update(timeout=timeout, name=name, title=title, generalAccess=general_access) - return KeyValueStoreResponse.model_validate(result).data + return validate_response(KeyValueStoreResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the key-value store. @@ -180,7 +180,7 @@ def list_keys( ) result = response_to_dict(response) - return ListOfKeysResponse.model_validate(result).data + return validate_response(ListOfKeysResponse, result).data def iterate_keys( self, @@ -545,7 +545,7 @@ async def get(self, *, timeout: Timeout = 'short') -> KeyValueStoreResource | No result = await self._get(timeout=timeout) if result is None: return None - return KeyValueStoreResponse.model_validate(result).data + return validate_response(KeyValueStoreResponse, result).data async def update( self, @@ -569,7 +569,7 @@ async def update( The updated key-value store. """ result = await self._update(timeout=timeout, name=name, title=title, generalAccess=general_access) - return KeyValueStoreResponse.model_validate(result).data + return validate_response(KeyValueStoreResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the key-value store. @@ -622,7 +622,7 @@ async def list_keys( ) result = response_to_dict(response) - return ListOfKeysResponse.model_validate(result).data + return validate_response(ListOfKeysResponse, result).data def iterate_keys( self, diff --git a/src/apify_client/_resource_clients/key_value_store_collection.py b/src/apify_client/_resource_clients/key_value_store_collection.py index 2d6727e5..842c1235 100644 --- a/src/apify_client/_resource_clients/key_value_store_collection.py +++ b/src/apify_client/_resource_clients/key_value_store_collection.py @@ -12,6 +12,7 @@ ) from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -73,7 +74,7 @@ def list( desc=desc, ownership=ownership, ) - return ListOfKeyValueStoresResponse.model_validate(result).data + return validate_response(ListOfKeyValueStoresResponse, result).data def iterate( self, @@ -134,7 +135,7 @@ def get_or_create( The retrieved or newly-created key-value store. """ result = self._get_or_create(timeout=timeout, name=name, resource_fields={'schema': schema}) - return KeyValueStoreResponse.model_validate(result).data + return validate_response(KeyValueStoreResponse, result).data @docs_group('Resource clients') @@ -190,7 +191,7 @@ async def list( desc=desc, ownership=ownership, ) - return ListOfKeyValueStoresResponse.model_validate(result).data + return validate_response(ListOfKeyValueStoresResponse, result).data def iterate( self, @@ -251,4 +252,4 @@ async def get_or_create( The retrieved or newly-created key-value store. """ result = await self._get_or_create(timeout=timeout, name=name, resource_fields={'schema': schema}) - return KeyValueStoreResponse.model_validate(result).data + return validate_response(KeyValueStoreResponse, result).data diff --git a/src/apify_client/_resource_clients/request_queue.py b/src/apify_client/_resource_clients/request_queue.py index baa1bf30..f40ce2f2 100644 --- a/src/apify_client/_resource_clients/request_queue.py +++ b/src/apify_client/_resource_clients/request_queue.py @@ -39,7 +39,7 @@ from apify_client._pagination import DEFAULT_CHUNK_SIZE, get_cursor_iterator, get_cursor_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync from apify_client._utils.errors import catch_not_found_or_throw -from apify_client._utils.http import response_to_dict, to_path_segment +from apify_client._utils.http import response_to_dict, to_path_segment, validate_response from apify_client._utils.time import to_seconds from apify_client.errors import ApifyApiError @@ -134,7 +134,7 @@ def get(self, *, timeout: Timeout = 'short') -> RequestQueueResource | None: result = self._get(timeout=timeout) if result is None: return None - return RequestQueueResponse.model_validate(result).data + return validate_response(RequestQueueResponse, result).data def update( self, @@ -158,7 +158,7 @@ def update( The updated request queue. """ result = self._update(timeout=timeout, name=name, title=title, generalAccess=general_access) - return RequestQueueResponse.model_validate(result).data + return validate_response(RequestQueueResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the request queue. @@ -192,7 +192,7 @@ def list_head(self, *, limit: int | None = None, timeout: Timeout = 'short') -> ) result = response_to_dict(response) - return RequestQueueHeadResponse.model_validate(result).data + return validate_response(RequestQueueHeadResponse, result).data def list_and_lock_head( self, @@ -227,7 +227,7 @@ def list_and_lock_head( ) result = response_to_dict(response) - return LockedRequestQueueHeadResponse.model_validate(result).data + return validate_response(LockedRequestQueueHeadResponse, result).data def add_request( self, @@ -262,7 +262,7 @@ def add_request( ) result = response_to_dict(response) - return AddRequestResponse.model_validate(result).data + return validate_response(AddRequestResponse, result).data def get_request(self, request_id: str, *, timeout: Timeout = 'short') -> RequestResource | None: """Retrieve a request from the queue. @@ -284,7 +284,7 @@ def get_request(self, request_id: str, *, timeout: Timeout = 'short') -> Request timeout=timeout, ) result = response_to_dict(response) - return RequestResponse.model_validate(result).data + return validate_response(RequestResponse, result).data except ApifyApiError as exc: catch_not_found_or_throw(exc) @@ -330,7 +330,7 @@ def update_request( ) result = response_to_dict(response) - return AddRequestResponse.model_validate(result).data + return validate_response(AddRequestResponse, result).data def delete_request(self, request_id: str, *, timeout: Timeout = 'short') -> None: """Delete a request from the queue. @@ -384,7 +384,7 @@ def prolong_request_lock( ) result = response_to_dict(response) - return ProlongRequestLockResponse.model_validate(result).data + return validate_response(ProlongRequestLockResponse, result).data def delete_request_lock( self, @@ -481,7 +481,7 @@ def batch_add_requests( ) result = response_to_dict(response) - batch_response = BatchAddResponse.model_validate(result) + batch_response = validate_response(BatchAddResponse, result) processed_requests.extend(batch_response.data.processed_requests) unprocessed_requests.extend(batch_response.data.unprocessed_requests) @@ -528,7 +528,7 @@ def batch_delete_requests( ) result = response_to_dict(response) - return BatchDeleteResponse.model_validate(result).data + return validate_response(BatchDeleteResponse, result).data def list_requests( self, @@ -563,7 +563,7 @@ def list_requests( ) result = response_to_dict(response) - return ListOfRequestsResponse.model_validate(result).data + return validate_response(ListOfRequestsResponse, result).data def iterate_requests( self, @@ -624,7 +624,7 @@ def unlock_requests(self: RequestQueueClient, *, timeout: Timeout = 'long') -> U ) result = response_to_dict(response) - return UnlockRequestsResponse.model_validate(result).data + return validate_response(UnlockRequestsResponse, result).data @docs_group('Resource clients') @@ -669,7 +669,7 @@ async def get(self, *, timeout: Timeout = 'short') -> RequestQueueResource | Non result = await self._get(timeout=timeout) if result is None: return None - return RequestQueueResponse.model_validate(result).data + return validate_response(RequestQueueResponse, result).data async def update( self, @@ -693,7 +693,7 @@ async def update( The updated request queue. """ result = await self._update(timeout=timeout, name=name, title=title, generalAccess=general_access) - return RequestQueueResponse.model_validate(result).data + return validate_response(RequestQueueResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the request queue. @@ -727,7 +727,7 @@ async def list_head(self, *, limit: int | None = None, timeout: Timeout = 'short ) result = response_to_dict(response) - return RequestQueueHeadResponse.model_validate(result).data + return validate_response(RequestQueueHeadResponse, result).data async def list_and_lock_head( self, @@ -762,7 +762,7 @@ async def list_and_lock_head( ) result = response_to_dict(response) - return LockedRequestQueueHeadResponse.model_validate(result).data + return validate_response(LockedRequestQueueHeadResponse, result).data async def add_request( self, @@ -797,7 +797,7 @@ async def add_request( ) result = response_to_dict(response) - return AddRequestResponse.model_validate(result).data + return validate_response(AddRequestResponse, result).data async def get_request(self, request_id: str, *, timeout: Timeout = 'short') -> RequestResource | None: """Retrieve a request from the queue. @@ -819,7 +819,7 @@ async def get_request(self, request_id: str, *, timeout: Timeout = 'short') -> R timeout=timeout, ) result = response_to_dict(response) - return RequestResponse.model_validate(result).data + return validate_response(RequestResponse, result).data except ApifyApiError as exc: catch_not_found_or_throw(exc) return None @@ -863,7 +863,7 @@ async def update_request( ) result = response_to_dict(response) - return AddRequestResponse.model_validate(result).data + return validate_response(AddRequestResponse, result).data async def delete_request(self, request_id: str, *, timeout: Timeout = 'short') -> None: """Delete a request from the queue. @@ -915,7 +915,7 @@ async def prolong_request_lock( ) result = response_to_dict(response) - return ProlongRequestLockResponse.model_validate(result).data + return validate_response(ProlongRequestLockResponse, result).data async def delete_request_lock( self, @@ -977,7 +977,7 @@ async def _batch_add_requests_worker( ) result = response_to_dict(response) - batch_response = BatchAddResponse.model_validate(result) + batch_response = validate_response(BatchAddResponse, result) processed_requests.extend(batch_response.data.processed_requests) unprocessed_requests.extend(batch_response.data.unprocessed_requests) @@ -1113,7 +1113,7 @@ async def batch_delete_requests( timeout=timeout, ) result = response_to_dict(response) - return BatchDeleteResponse.model_validate(result).data + return validate_response(BatchDeleteResponse, result).data async def list_requests( self, @@ -1148,7 +1148,7 @@ async def list_requests( ) result = response_to_dict(response) - return ListOfRequestsResponse.model_validate(result).data + return validate_response(ListOfRequestsResponse, result).data def iterate_requests( self, @@ -1213,4 +1213,4 @@ async def unlock_requests( ) result = response_to_dict(response) - return UnlockRequestsResponse.model_validate(result).data + return validate_response(UnlockRequestsResponse, result).data diff --git a/src/apify_client/_resource_clients/request_queue_collection.py b/src/apify_client/_resource_clients/request_queue_collection.py index 3844c20f..78149fad 100644 --- a/src/apify_client/_resource_clients/request_queue_collection.py +++ b/src/apify_client/_resource_clients/request_queue_collection.py @@ -11,6 +11,7 @@ ) from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -73,7 +74,7 @@ def list( desc=desc, ownership=ownership, ) - return ListOfRequestQueuesResponse.model_validate(result).data + return validate_response(ListOfRequestQueuesResponse, result).data def iterate( self, @@ -132,7 +133,7 @@ def get_or_create( The retrieved or newly-created request queue. """ result = self._get_or_create(timeout=timeout, name=name) - return RequestQueueResponse.model_validate(result).data + return validate_response(RequestQueueResponse, result).data @docs_group('Resource clients') @@ -188,7 +189,7 @@ async def list( desc=desc, ownership=ownership, ) - return ListOfRequestQueuesResponse.model_validate(result).data + return validate_response(ListOfRequestQueuesResponse, result).data def iterate( self, @@ -247,4 +248,4 @@ async def get_or_create( The retrieved or newly-created request queue. """ result = await self._get_or_create(timeout=timeout, name=name) - return RequestQueueResponse.model_validate(result).data + return validate_response(RequestQueueResponse, result).data diff --git a/src/apify_client/_resource_clients/run.py b/src/apify_client/_resource_clients/run.py index 39cbc399..71bfaa83 100644 --- a/src/apify_client/_resource_clients/run.py +++ b/src/apify_client/_resource_clients/run.py @@ -15,7 +15,7 @@ from apify_client._status_message_watcher import StatusMessageWatcher, StatusMessageWatcherAsync from apify_client._streamed_log import StreamedLog, StreamedLogAsync from apify_client._utils.encoding import encode_key_value_store_record_value -from apify_client._utils.http import response_to_dict, to_safe_id +from apify_client._utils.http import response_to_dict, to_safe_id, validate_response from apify_client._utils.time import to_seconds if TYPE_CHECKING: @@ -77,7 +77,7 @@ def get(self, *, wait_for_finish: timedelta | int | None = None, timeout: Timeou result = self._get(timeout=request_timeout, waitForFinish=wait_for_finish_secs) if result is None: return None - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def update( self, @@ -106,7 +106,7 @@ def update( isStatusMessageTerminal=is_status_message_terminal, generalAccess=general_access, ) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the run. @@ -139,7 +139,7 @@ def abort(self, *, gracefully: bool | None = None, timeout: Timeout = 'medium') timeout=timeout, ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def wait_for_finish( self, @@ -167,7 +167,7 @@ def wait_for_finish( if response is None: return None - return Run.model_validate(response) + return validate_response(Run, response) def metamorph( self, @@ -213,7 +213,7 @@ def metamorph( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def resurrect( self, @@ -268,7 +268,7 @@ def resurrect( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def reboot(self, *, timeout: Timeout = 'medium') -> Run: """Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted. @@ -287,7 +287,7 @@ def reboot(self, *, timeout: Timeout = 'medium') -> Run: timeout=timeout, ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def dataset(self) -> DatasetClient: """Get the client for the default dataset of the Actor run. @@ -638,7 +638,7 @@ async def get(self, *, wait_for_finish: timedelta | int | None = None, timeout: result = await self._get(timeout=request_timeout, waitForFinish=wait_for_finish_secs) if result is None: return None - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data async def update( self, @@ -667,7 +667,7 @@ async def update( isStatusMessageTerminal=is_status_message_terminal, generalAccess=general_access, ) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data async def abort(self, *, gracefully: bool | None = None, timeout: Timeout = 'medium') -> Run: """Abort the Actor run which is starting or currently running and return its details. @@ -690,7 +690,7 @@ async def abort(self, *, gracefully: bool | None = None, timeout: Timeout = 'med timeout=timeout, ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data async def wait_for_finish( self, @@ -714,7 +714,7 @@ async def wait_for_finish( wait_duration=wait_duration, timeout=timeout, ) - return Run.model_validate(response) if response is not None else None + return validate_response(Run, response) if response is not None else None async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the run. @@ -773,7 +773,7 @@ async def metamorph( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data async def resurrect( self, @@ -828,7 +828,7 @@ async def resurrect( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data async def reboot(self, *, timeout: Timeout = 'medium') -> Run: """Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted. @@ -847,7 +847,7 @@ async def reboot(self, *, timeout: Timeout = 'medium') -> Run: timeout=timeout, ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def dataset(self) -> DatasetClientAsync: """Get the client for the default dataset of the Actor run. diff --git a/src/apify_client/_resource_clients/run_collection.py b/src/apify_client/_resource_clients/run_collection.py index 527904f1..35a52777 100644 --- a/src/apify_client/_resource_clients/run_collection.py +++ b/src/apify_client/_resource_clients/run_collection.py @@ -6,6 +6,7 @@ from apify_client._models import ListOfRuns, ListOfRunsResponse from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -77,7 +78,7 @@ def list( startedBefore=started_before, startedAfter=started_after, ) - return ListOfRunsResponse.model_validate(result).data + return validate_response(ListOfRunsResponse, result).data def iterate( self, @@ -188,7 +189,7 @@ async def list( startedBefore=started_before, startedAfter=started_after, ) - return ListOfRunsResponse.model_validate(result).data + return validate_response(ListOfRunsResponse, result).data def iterate( self, diff --git a/src/apify_client/_resource_clients/schedule.py b/src/apify_client/_resource_clients/schedule.py index 28e3b96f..b103be07 100644 --- a/src/apify_client/_resource_clients/schedule.py +++ b/src/apify_client/_resource_clients/schedule.py @@ -12,7 +12,7 @@ ScheduleResponse, ) from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync -from apify_client._utils.http import response_to_dict +from apify_client._utils.http import response_to_dict, validate_response if TYPE_CHECKING: from apify_client.types import Timeout @@ -53,7 +53,7 @@ def get(self, *, timeout: Timeout = 'short') -> Schedule | None: result = self._get(timeout=timeout) if result is None: return None - return ScheduleResponse.model_validate(result).data + return validate_response(ScheduleResponse, result).data def update( self, @@ -102,7 +102,7 @@ def update( notifications=ScheduleNotifications(email=notifications_email) if notifications_email is not None else None, ) result = self._update(timeout=timeout, **schedule_fields.model_dump(by_alias=True, exclude_none=True)) - return ScheduleResponse.model_validate(result).data + return validate_response(ScheduleResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the schedule. @@ -135,7 +135,7 @@ def get_log(self, *, timeout: Timeout = 'medium') -> list[ScheduleLogEntry]: timeout=timeout, ) result = response_to_dict(response) - return ScheduleLogResponse.model_validate(result).data + return validate_response(ScheduleLogResponse, result).data @docs_group('Resource clients') @@ -173,7 +173,7 @@ async def get(self, *, timeout: Timeout = 'short') -> Schedule | None: result = await self._get(timeout=timeout) if result is None: return None - return ScheduleResponse.model_validate(result).data + return validate_response(ScheduleResponse, result).data async def update( self, @@ -222,7 +222,7 @@ async def update( notifications=ScheduleNotifications(email=notifications_email) if notifications_email is not None else None, ) result = await self._update(timeout=timeout, **schedule_fields.model_dump(by_alias=True, exclude_none=True)) - return ScheduleResponse.model_validate(result).data + return validate_response(ScheduleResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the schedule. @@ -255,4 +255,4 @@ async def get_log(self, *, timeout: Timeout = 'medium') -> list[ScheduleLogEntry timeout=timeout, ) result = response_to_dict(response) - return ScheduleLogResponse.model_validate(result).data + return validate_response(ScheduleLogResponse, result).data diff --git a/src/apify_client/_resource_clients/schedule_collection.py b/src/apify_client/_resource_clients/schedule_collection.py index 547383d8..99152f99 100644 --- a/src/apify_client/_resource_clients/schedule_collection.py +++ b/src/apify_client/_resource_clients/schedule_collection.py @@ -13,6 +13,7 @@ ) from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -62,7 +63,7 @@ def list( The list of available schedules matching the specified filters. """ result = self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfSchedulesResponse.model_validate(result).data + return validate_response(ListOfSchedulesResponse, result).data def iterate( self, @@ -146,7 +147,7 @@ def create( notifications=ScheduleNotifications(email=notifications_email) if notifications_email is not None else None, ) result = self._create(timeout=timeout, **schedule_fields.model_dump(by_alias=True, exclude_none=True)) - return ScheduleResponse.model_validate(result).data + return validate_response(ScheduleResponse, result).data @docs_group('Resource clients') @@ -190,7 +191,7 @@ async def list( The list of available schedules matching the specified filters. """ result = await self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfSchedulesResponse.model_validate(result).data + return validate_response(ListOfSchedulesResponse, result).data def iterate( self, @@ -274,4 +275,4 @@ async def create( notifications=ScheduleNotifications(email=notifications_email) if notifications_email is not None else None, ) result = await self._create(timeout=timeout, **schedule_fields.model_dump(by_alias=True, exclude_none=True)) - return ScheduleResponse.model_validate(result).data + return validate_response(ScheduleResponse, result).data diff --git a/src/apify_client/_resource_clients/store_collection.py b/src/apify_client/_resource_clients/store_collection.py index 98f32852..a8526982 100644 --- a/src/apify_client/_resource_clients/store_collection.py +++ b/src/apify_client/_resource_clients/store_collection.py @@ -6,6 +6,7 @@ from apify_client._models import ListOfStoreActors, ListOfStoreActorsResponse from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -78,7 +79,7 @@ def list( pricingModel=pricing_model, includeUnrunnableActors=include_unrunnable_actors, ) - return ListOfStoreActorsResponse.model_validate(result).data + return validate_response(ListOfStoreActorsResponse, result).data def iterate( self, @@ -200,7 +201,7 @@ async def list( pricingModel=pricing_model, includeUnrunnableActors=include_unrunnable_actors, ) - return ListOfStoreActorsResponse.model_validate(result).data + return validate_response(ListOfStoreActorsResponse, result).data def iterate( self, diff --git a/src/apify_client/_resource_clients/task.py b/src/apify_client/_resource_clients/task.py index 3f87d0ff..d9f00ea7 100644 --- a/src/apify_client/_resource_clients/task.py +++ b/src/apify_client/_resource_clients/task.py @@ -15,7 +15,7 @@ ) from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync from apify_client._utils.encoding import encode_webhooks_to_base64 -from apify_client._utils.http import response_to_dict +from apify_client._utils.http import response_to_dict, validate_response from apify_client._utils.server_args import build_actor_standby from apify_client._utils.time import to_seconds from apify_client._utils.wait_for_resources import start_waiting_for_resources, start_waiting_for_resources_async @@ -68,7 +68,7 @@ def get(self, *, timeout: Timeout = 'short') -> Task | None: result = self._get(timeout=timeout) if result is None: return None - return TaskResponse.model_validate(result).data + return validate_response(TaskResponse, result).data def update( self, @@ -193,7 +193,7 @@ def update( ), ) result = self._update(timeout=timeout, **task_fields.model_dump(by_alias=True, exclude_none=True)) - return TaskResponse.model_validate(result).data + return validate_response(TaskResponse, result).data def publish(self, *, timeout: Timeout = 'short') -> Task: """Publish the task on its public landing page. @@ -321,7 +321,7 @@ def start( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data def call( self, @@ -507,7 +507,7 @@ async def get(self, *, timeout: Timeout = 'short') -> Task | None: result = await self._get(timeout=timeout) if result is None: return None - return TaskResponse.model_validate(result).data + return validate_response(TaskResponse, result).data async def update( self, @@ -632,7 +632,7 @@ async def update( ), ) result = await self._update(timeout=timeout, **task_fields.model_dump(by_alias=True, exclude_none=True)) - return TaskResponse.model_validate(result).data + return validate_response(TaskResponse, result).data async def publish(self, *, timeout: Timeout = 'short') -> Task: """Publish the task on its public landing page. @@ -760,7 +760,7 @@ async def start( ) result = response_to_dict(response) - return RunResponse.model_validate(result).data + return validate_response(RunResponse, result).data async def call( self, diff --git a/src/apify_client/_resource_clients/task_collection.py b/src/apify_client/_resource_clients/task_collection.py index ae6e5bcc..49503f74 100644 --- a/src/apify_client/_resource_clients/task_collection.py +++ b/src/apify_client/_resource_clients/task_collection.py @@ -15,6 +15,7 @@ ) from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response from apify_client._utils.server_args import build_actor_standby from apify_client._utils.time import to_seconds @@ -69,7 +70,7 @@ def list( The list of available tasks matching the specified filters. """ result = self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfTasksResponse.model_validate(result).data + return validate_response(ListOfTasksResponse, result).data def iterate( self, @@ -227,7 +228,7 @@ def create( ), ) result = self._create(timeout=timeout, **task_fields.model_dump(by_alias=True, exclude_none=True)) - return TaskResponse.model_validate(result).data + return validate_response(TaskResponse, result).data @docs_group('Resource clients') @@ -271,7 +272,7 @@ async def list( The list of available tasks matching the specified filters. """ result = await self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfTasksResponse.model_validate(result).data + return validate_response(ListOfTasksResponse, result).data def iterate( self, @@ -429,4 +430,4 @@ async def create( ), ) result = await self._create(timeout=timeout, **task_fields.model_dump(by_alias=True, exclude_none=True)) - return TaskResponse.model_validate(result).data + return validate_response(TaskResponse, result).data diff --git a/src/apify_client/_resource_clients/user.py b/src/apify_client/_resource_clients/user.py index d60470b2..077b1c82 100644 --- a/src/apify_client/_resource_clients/user.py +++ b/src/apify_client/_resource_clients/user.py @@ -16,7 +16,7 @@ UserPublicInfoResponse, ) from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync -from apify_client._utils.http import response_to_dict +from apify_client._utils.http import response_to_dict, validate_response if TYPE_CHECKING: from apify_client.types import Timeout @@ -59,10 +59,11 @@ def get(self, *, timeout: Timeout = 'short') -> UserPublicInfo | UserPrivateInfo result = self._get(timeout=timeout) if result is None: return None + # A response that does not fit the private model falls back to the public one, so a failure here is expected. try: return UserPrivateInfoResponse.model_validate(result).data except ValidationError: - return UserPublicInfoResponse.model_validate(result).data + return validate_response(UserPublicInfoResponse, result).data def monthly_usage(self, *, timeout: Timeout = 'short') -> MonthlyUsage: """Return monthly usage of the user account. @@ -89,7 +90,7 @@ def monthly_usage(self, *, timeout: Timeout = 'short') -> MonthlyUsage: timeout=timeout, ) result = response_to_dict(response) - return MonthlyUsageResponse.model_validate(result).data + return validate_response(MonthlyUsageResponse, result).data def limits(self, *, timeout: Timeout = 'short') -> AccountLimits: """Return a complete summary of the user account's limits. @@ -115,7 +116,7 @@ def limits(self, *, timeout: Timeout = 'short') -> AccountLimits: timeout=timeout, ) result = response_to_dict(response) - return AccountLimitsResponse.model_validate(result).data + return validate_response(AccountLimitsResponse, result).data def update_limits( self, @@ -182,10 +183,11 @@ async def get(self, *, timeout: Timeout = 'short') -> UserPublicInfo | UserPriva result = await self._get(timeout=timeout) if result is None: return None + # A response that does not fit the private model falls back to the public one, so a failure here is expected. try: return UserPrivateInfoResponse.model_validate(result).data except ValidationError: - return UserPublicInfoResponse.model_validate(result).data + return validate_response(UserPublicInfoResponse, result).data async def monthly_usage(self, *, timeout: Timeout = 'short') -> MonthlyUsage: """Return monthly usage of the user account. @@ -212,7 +214,7 @@ async def monthly_usage(self, *, timeout: Timeout = 'short') -> MonthlyUsage: timeout=timeout, ) result = response_to_dict(response) - return MonthlyUsageResponse.model_validate(result).data + return validate_response(MonthlyUsageResponse, result).data async def limits(self, *, timeout: Timeout = 'short') -> AccountLimits: """Return a complete summary of the user account's limits. @@ -238,7 +240,7 @@ async def limits(self, *, timeout: Timeout = 'short') -> AccountLimits: timeout=timeout, ) result = response_to_dict(response) - return AccountLimitsResponse.model_validate(result).data + return validate_response(AccountLimitsResponse, result).data async def update_limits( self, diff --git a/src/apify_client/_resource_clients/webhook.py b/src/apify_client/_resource_clients/webhook.py index 93a4a584..9b6d3fe2 100644 --- a/src/apify_client/_resource_clients/webhook.py +++ b/src/apify_client/_resource_clients/webhook.py @@ -14,7 +14,7 @@ WebhookResponse, ) from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync -from apify_client._utils.http import response_to_dict +from apify_client._utils.http import response_to_dict, validate_response if TYPE_CHECKING: from apify_client._literals import WebhookEventType @@ -57,7 +57,7 @@ def get(self, *, timeout: Timeout = 'short') -> WebhookResource | None: result = self._get(timeout=timeout) if result is None: return None - return WebhookResponse.model_validate(result).data + return validate_response(WebhookResponse, result).data def update( self, @@ -117,7 +117,7 @@ def update( ), ) result = self._update(timeout=timeout, **webhook_update.model_dump(by_alias=True, exclude_none=True)) - return WebhookResponse.model_validate(result).data + return validate_response(WebhookResponse, result).data def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the webhook. @@ -153,7 +153,7 @@ def test(self, *, timeout: Timeout = 'medium') -> WebhookDispatch: ) result = response_to_dict(response) - return WebhookDispatchResponse.model_validate(result).data + return validate_response(WebhookDispatchResponse, result).data def dispatches(self) -> WebhookDispatchCollectionClient: """Get dispatches of the webhook. @@ -204,7 +204,7 @@ async def get(self, *, timeout: Timeout = 'short') -> WebhookResource | None: result = await self._get(timeout=timeout) if result is None: return None - return WebhookResponse.model_validate(result).data + return validate_response(WebhookResponse, result).data async def update( self, @@ -264,7 +264,7 @@ async def update( ), ) result = await self._update(timeout=timeout, **webhook_update.model_dump(by_alias=True, exclude_none=True)) - return WebhookResponse.model_validate(result).data + return validate_response(WebhookResponse, result).data async def delete(self, *, timeout: Timeout = 'short') -> None: """Delete the webhook. @@ -300,7 +300,7 @@ async def test(self, *, timeout: Timeout = 'medium') -> WebhookDispatch: ) result = response_to_dict(response) - return WebhookDispatchResponse.model_validate(result).data + return validate_response(WebhookDispatchResponse, result).data def dispatches(self) -> WebhookDispatchCollectionClientAsync: """Get dispatches of the webhook. diff --git a/src/apify_client/_resource_clients/webhook_collection.py b/src/apify_client/_resource_clients/webhook_collection.py index 410dd8af..36d796d2 100644 --- a/src/apify_client/_resource_clients/webhook_collection.py +++ b/src/apify_client/_resource_clients/webhook_collection.py @@ -12,6 +12,7 @@ ) from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -62,7 +63,7 @@ def list( The list of available webhooks matching the specified filters. """ result = self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfWebhooksResponse.model_validate(result).data + return validate_response(ListOfWebhooksResponse, result).data def iterate( self, @@ -160,7 +161,7 @@ def create( ), ) result = self._create(timeout=timeout, **webhook_create.model_dump(by_alias=True, exclude_none=True)) - return WebhookResponse.model_validate(result).data + return validate_response(WebhookResponse, result).data @docs_group('Resource clients') @@ -204,7 +205,7 @@ async def list( The list of available webhooks matching the specified filters. """ result = await self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfWebhooksResponse.model_validate(result).data + return validate_response(ListOfWebhooksResponse, result).data def iterate( self, @@ -302,4 +303,4 @@ async def create( ), ) result = await self._create(timeout=timeout, **webhook_create.model_dump(by_alias=True, exclude_none=True)) - return WebhookResponse.model_validate(result).data + return validate_response(WebhookResponse, result).data diff --git a/src/apify_client/_resource_clients/webhook_dispatch.py b/src/apify_client/_resource_clients/webhook_dispatch.py index a3ed7c86..5d3b3309 100644 --- a/src/apify_client/_resource_clients/webhook_dispatch.py +++ b/src/apify_client/_resource_clients/webhook_dispatch.py @@ -5,6 +5,7 @@ from apify_client._docs import docs_group from apify_client._models import WebhookDispatch, WebhookDispatchResponse from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from apify_client.types import Timeout @@ -45,7 +46,7 @@ def get(self, *, timeout: Timeout = 'short') -> WebhookDispatch | None: result = self._get(timeout=timeout) if result is None: return None - return WebhookDispatchResponse.model_validate(result).data + return validate_response(WebhookDispatchResponse, result).data @docs_group('Resource clients') @@ -83,4 +84,4 @@ async def get(self, *, timeout: Timeout = 'short') -> WebhookDispatch | None: result = await self._get(timeout=timeout) if result is None: return None - return WebhookDispatchResponse.model_validate(result).data + return validate_response(WebhookDispatchResponse, result).data diff --git a/src/apify_client/_resource_clients/webhook_dispatch_collection.py b/src/apify_client/_resource_clients/webhook_dispatch_collection.py index 385554b0..fcf5fbe8 100644 --- a/src/apify_client/_resource_clients/webhook_dispatch_collection.py +++ b/src/apify_client/_resource_clients/webhook_dispatch_collection.py @@ -6,6 +6,7 @@ from apify_client._models import ListOfWebhookDispatches, ListOfWebhookDispatchesResponse from apify_client._pagination import get_items_iterator, get_items_iterator_async from apify_client._resource_clients._resource_client import ResourceClient, ResourceClientAsync +from apify_client._utils.http import validate_response if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterator @@ -55,7 +56,7 @@ def list( The retrieved webhook dispatches of a user. """ result = self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfWebhookDispatchesResponse.model_validate(result).data + return validate_response(ListOfWebhookDispatchesResponse, result).data def iterate( self, @@ -131,7 +132,7 @@ async def list( The retrieved webhook dispatches of a user. """ result = await self._list(timeout=timeout, limit=limit, offset=offset, desc=desc) - return ListOfWebhookDispatchesResponse.model_validate(result).data + return validate_response(ListOfWebhookDispatchesResponse, result).data def iterate( self, diff --git a/src/apify_client/_utils/http.py b/src/apify_client/_utils/http.py index 35ba7f0c..c6f0d729 100644 --- a/src/apify_client/_utils/http.py +++ b/src/apify_client/_utils/http.py @@ -1,9 +1,11 @@ from __future__ import annotations import warnings -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, TypeVar, cast from urllib.parse import quote, urlsplit +from pydantic import BaseModel, ValidationError + from apify_client._consts import ( ALREADY_COMPRESSED_MEDIA_TYPE_PREFIXES, ALREADY_COMPRESSED_MEDIA_TYPES, @@ -12,12 +14,18 @@ COMPRESSIBLE_MEDIA_TYPES, OVERRIDABLE_DEFAULT_HEADERS, ) -from apify_client.errors import InvalidResponseBodyError +from apify_client._logging import log_context +from apify_client.errors import InvalidResponseBodyError, ResponseValidationError if TYPE_CHECKING: + from pydantic_core import InitErrorDetails + from apify_client.http_clients import HttpResponse +_ModelT = TypeVar('_ModelT', bound=BaseModel) + + def to_safe_id(id: str) -> str: """Convert a resource ID to URL-safe format by replacing forward slashes with tildes. @@ -134,6 +142,37 @@ def response_to_dict(response: HttpResponse) -> dict: raise ValueError(f'The response is not a dictionary. Got: {type(data).__name__}') +def validate_response(model: type[_ModelT], data: Any) -> _ModelT: + """Validate a parsed API response body against a model. + + The HTTP method and URL reported on failure are those of the request the current thread or task sent last, which + is the request the validated body came from. + + Args: + model: The model the response body is expected to match. + data: The parsed response body. + + Returns: + The validated model instance. + + Raises: + ResponseValidationError: If the response body does not match the model. + """ + try: + return model.model_validate(data) + except ValidationError as exc: + # The details `errors()` returns are accepted as input details, only their declared types differ. + line_errors = cast('list[InitErrorDetails]', exc.errors(include_url=False)) + error = ResponseValidationError.from_exception_data(exc.title, line_errors) + + error.method = log_context.method.get() + url = log_context.url.get() + if url is not None: + error.url = urlsplit(url)._replace(query='', fragment='').geturl() + + raise error from exc + + def response_to_list(response: HttpResponse) -> list: """Parse the API response as a list and validate its type. diff --git a/src/apify_client/errors.py b/src/apify_client/errors.py index 85b27e08..58350af0 100644 --- a/src/apify_client/errors.py +++ b/src/apify_client/errors.py @@ -4,6 +4,8 @@ from typing import TYPE_CHECKING, Any from urllib.parse import urlsplit +from pydantic import ValidationError + from apify_client._docs import docs_group if TYPE_CHECKING: @@ -161,6 +163,34 @@ def __init__(self, response: HttpResponse) -> None: self.response = response +@docs_group('Errors') +class ResponseValidationError(ApifyClientError, ValidationError): + """Error raised when an API response does not match the expected model. + + This usually means the API returned a shape the client does not know yet, for example after the API changed ahead + of the client. It subclasses `pydantic.ValidationError`, so `errors()` lists the individual mismatches and an + `except pydantic.ValidationError` or `except ValueError` handler catches it too. The original validation error is + available as `__cause__`. + + Attributes: + method: The HTTP method of the request whose response failed validation (if available). + url: The URL of that request, without query parameters (if available). + """ + + method: str | None = None + url: str | None = None + + def __str__(self) -> str: + """Describe the failed request and list the validation errors.""" + request = ' '.join(part for part in (self.method, self.url) if part) + of_request = f' of {request}' if request else '' + return ( + f'The API response{of_request} did not match the expected schema. This is likely a mismatch between the ' + 'client and the API; please report it at https://github.com/apify/apify-client-python/issues.\n\n' + f'{super().__str__()}' + ) + + _STATUS_TO_CLASS: dict[int, type[ApifyApiError]] = { 400: InvalidRequestError, 401: UnauthorizedError, @@ -180,6 +210,7 @@ def __init__(self, response: HttpResponse) -> None: 'InvalidResponseBodyError', 'NotFoundError', 'RateLimitError', + 'ResponseValidationError', 'ServerError', 'UnauthorizedError', ] diff --git a/tests/unit/test_response_validation.py b/tests/unit/test_response_validation.py new file mode 100644 index 00000000..c27188f2 --- /dev/null +++ b/tests/unit/test_response_validation.py @@ -0,0 +1,127 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +import pytest +from pydantic import ValidationError + +from apify_client._models import UserPublicInfo +from apify_client.errors import ApifyClientError, ResponseValidationError + +if TYPE_CHECKING: + from collections.abc import Callable + + from pytest_httpserver import HTTPServer + + from apify_client import ApifyClient, ApifyClientAsync + +pytestmark = pytest.mark.usefixtures('http_client_classes') + +# A body with the response envelope whose `data` fits none of the models. The terminal `status` lets `wait_for_finish` +# stop polling. +_MISMATCHED_BODY = {'data': {'status': 'SUCCEEDED', 'unexpected': 'shape'}} + +_SYNC_CASES = [ + pytest.param('/v2/datasets/ds-1', 'GET', lambda c: c.dataset('ds-1').get(), id='single_get'), + pytest.param('/v2/datasets', 'GET', lambda c: c.datasets().list(), id='collection_list'), + pytest.param('/v2/datasets', 'POST', lambda c: c.datasets().get_or_create(), id='collection_get_or_create'), + pytest.param('/v2/datasets/ds-1', 'PUT', lambda c: c.dataset('ds-1').update(name='x'), id='single_update'), + pytest.param('/v2/actor-runs/run-1', 'GET', lambda c: c.run('run-1').wait_for_finish(), id='wait_for_finish'), +] + +_ASYNC_CASES = [ + pytest.param('/v2/datasets/ds-1', 'GET', lambda c: c.dataset('ds-1').get(), id='single_get'), + pytest.param('/v2/datasets', 'GET', lambda c: c.datasets().list(), id='collection_list'), + pytest.param('/v2/datasets', 'POST', lambda c: c.datasets().get_or_create(), id='collection_get_or_create'), + pytest.param('/v2/datasets/ds-1', 'PUT', lambda c: c.dataset('ds-1').update(name='x'), id='single_update'), + pytest.param('/v2/actor-runs/run-1', 'GET', lambda c: c.run('run-1').wait_for_finish(), id='wait_for_finish'), +] + + +def _assert_response_validation_error(error: ResponseValidationError, *, path: str, method: str) -> None: + assert isinstance(error, ApifyClientError) + assert isinstance(error, ValidationError) + assert isinstance(error, ValueError) + assert error.method == method + assert error.url is not None + assert error.url.endswith(path) + assert error.error_count() > 0 + assert error.errors() + assert isinstance(error.__cause__, ValidationError) + assert f'{method} {error.url}' in str(error) + + +@pytest.mark.parametrize(('path', 'method', 'call'), _SYNC_CASES) +def test_mismatched_response_raises_response_validation_error( + httpserver: HTTPServer, + sync_client: ApifyClient, + path: str, + method: str, + call: Callable[[ApifyClient], Any], +) -> None: + """A response that does not match its model raises `ResponseValidationError` with the request details.""" + httpserver.expect_request(path, method=method).respond_with_json(_MISMATCHED_BODY) + + with pytest.raises(ResponseValidationError) as exc_info: + call(sync_client) + + _assert_response_validation_error(exc_info.value, path=path, method=method) + + +@pytest.mark.parametrize(('path', 'method', 'call'), _ASYNC_CASES) +async def test_mismatched_response_raises_response_validation_error_async( + httpserver: HTTPServer, + async_client: ApifyClientAsync, + path: str, + method: str, + call: Callable[[ApifyClientAsync], Any], +) -> None: + """A response that does not match its model raises `ResponseValidationError` with the request details.""" + httpserver.expect_request(path, method=method).respond_with_json(_MISMATCHED_BODY) + + with pytest.raises(ResponseValidationError) as exc_info: + await call(async_client) + + _assert_response_validation_error(exc_info.value, path=path, method=method) + + +def test_response_validation_error_url_has_no_query_string(httpserver: HTTPServer, sync_client: ApifyClient) -> None: + """The URL on the error leaves out the query parameters of the request.""" + httpserver.expect_request('/v2/datasets', method='GET').respond_with_json(_MISMATCHED_BODY) + + with pytest.raises(ResponseValidationError) as exc_info: + sync_client.datasets().list(limit=1, desc=True) + + assert exc_info.value.url is not None + assert '?' not in exc_info.value.url + + +def test_user_get_falls_back_to_public_info(httpserver: HTTPServer, sync_client: ApifyClient) -> None: + """A user body that fits only the public model still returns the public info.""" + body = {'data': {'username': 'bob', 'email': 'not-an-email'}} + httpserver.expect_request('/v2/users/me').respond_with_json(body) + + user = sync_client.user().get() + + assert isinstance(user, UserPublicInfo) + assert user.username == 'bob' + + +def test_user_get_raises_response_validation_error_when_no_model_fits( + httpserver: HTTPServer, sync_client: ApifyClient +) -> None: + """A user body that fits neither the private nor the public model raises `ResponseValidationError`.""" + httpserver.expect_request('/v2/users/me').respond_with_json(_MISMATCHED_BODY) + + with pytest.raises(ResponseValidationError) as exc_info: + sync_client.user().get() + + _assert_response_validation_error(exc_info.value, path='/v2/users/me', method='GET') + + +def test_invalid_request_input_still_raises_pydantic_validation_error(sync_client: ApifyClient) -> None: + """A validation error on request input is raised as is, since no response is involved.""" + with pytest.raises(ValidationError) as exc_info: + sync_client.actor('actor-1').update(versions=[{'unexpected': 'shape'}]) + + assert not isinstance(exc_info.value, ResponseValidationError)