MPT-14266 Add custom exceptions (WIP)

Author: albertsola

mpt_api_client/exceptions.py

@@ -0,0 +1,77 @@
+import json
+from typing import override
+
+from httpx import HTTPStatusError, Response
+
+
+class MPTError(Exception):
+    """Represents a generic MPT error."""
+
+
+class MPTHttpError(MPTError):
+    """Represents an HTTP error."""
+
+    def __init__(self, status_code: int, content: str):  # noqa: WPS110
+        self.status_code = status_code
+        self.content = content  # noqa: WPS110
+        super().__init__(f"{self.status_code} - {self.content}")
+
+
+class MPTAPIError(MPTHttpError):
+    """Represents an API error."""
+
+    def __init__(self, status_code: int, payload: dict[str, str]):
+        super().__init__(status_code, json.dumps(payload))
+        self.payload = payload
+        self.status: str | None = payload.get("status")
+        self.title: str | None = payload.get("title")
+        self.detail: str | None = payload.get("detail")
+        self.trace_id: str | None = payload.get("traceId")
+        self.errors: str | None = payload.get("errors")
+
+    @override
+    def __str__(self) -> str:
+        base = f"{self.status} {self.title} - {self.detail} ({self.trace_id})"
+
+        if self.errors:
+            return f"{base}\n{json.dumps(self.errors, indent=2)}"
+        return base
+
+    @override
+    def __repr__(self) -> str:
+        return str(self.payload)
+
+
+def handle_http_status_exception(http_status_exception: HTTPStatusError) -> None:
+    """Transforms httpx exceptions into MPT exceptions.
+
+    Attempts to extract API related information from HTTPStatusError and
+    raises MPTAPIError or MPTHttpError.
+
+    Args:
+        http_status_exception: Native httpx exception
+
+    Raises:
+        MPTAPIError
+        MPTHttpError
+    """
+    try:  # noqa: WPS229
+        payload = http_status_exception.response.json()
+        raise MPTAPIError(
+            status_code=http_status_exception.response.status_code,
+            payload=payload,
+        ) from http_status_exception
+    except json.JSONDecodeError:
+        payload = http_status_exception.response.content.decode()
+        raise MPTHttpError(
+            status_code=http_status_exception.response.status_code,
+            content=payload,
+        ) from http_status_exception
+
+
+def raise_for_status(response: Response) -> None:
+    """Raise an exception for the given response."""
+    try:
+        response.raise_for_status()
+    except HTTPStatusError as ex:
+        handle_http_status_exception(ex)

mpt_api_client/http/async_client.py

@@ -1,6 +1,21 @@
 import os
+from typing import Any, override
 
-from httpx import AsyncClient, AsyncHTTPTransport
+from httpx import URL, AsyncClient, AsyncHTTPTransport, HTTPError, HTTPStatusError, Response
+from httpx._client import USE_CLIENT_DEFAULT, UseClientDefault  # noqa: PLC2701
+from httpx._types import (  # noqa: WPS235
+    AuthTypes,
+    CookieTypes,
+    HeaderTypes,
+    QueryParamTypes,
+    RequestContent,
+    RequestData,
+    RequestExtensions,
+    RequestFiles,
+    TimeoutTypes,
+)
+
+from mpt_api_client.exceptions import MPTError, handle_http_status_exception
 
 
 class AsyncHTTPClient(AsyncClient):
@@ -40,3 +55,43 @@ def __init__(
             timeout=timeout,
             transport=AsyncHTTPTransport(retries=retries),
         )
+
+    @override
+    async def request(  # noqa: WPS211 type:ignore[return]
+        self,
+        method: str,
+        url: URL | str,
+        *,
+        content: RequestContent | None = None,  # noqa: WPS110
+        data: RequestData | None = None,  # noqa: WPS110
+        files: RequestFiles | None = None,
+        json: Any | None = None,
+        params: QueryParamTypes | None = None,  # noqa: WPS110
+        headers: HeaderTypes | None = None,
+        cookies: CookieTypes | None = None,
+        auth: AuthTypes | UseClientDefault | None = USE_CLIENT_DEFAULT,
+        follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
+        timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
+        extensions: RequestExtensions | None = None,
+    ) -> Response:
+        try:  # noqa: WPS229
+            response = await super().request(
+                method,
+                url,
+                content=content,
+                data=data,
+                files=files,
+                json=json,
+                params=params,
+                headers=headers,
+                cookies=cookies,
+                auth=auth,
+            )
+            response.raise_for_status()
+        except HTTPStatusError as http_status_exception:
+            handle_http_status_exception(http_status_exception)
+        except HTTPError as err:
+            http_error = MPTError()
+            raise http_error from err
+        else:
+            return response

mpt_api_client/http/async_service.py

@@ -101,10 +101,7 @@ async def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> ht
             HTTPStatusError: if the response status code is not 200.
         """
         pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
-        response = await self.http_client.get(self.build_url(pagination_params))
-        response.raise_for_status()
-
-        return response
+        return await self.http_client.get(self.build_url(pagination_params))
 
     async def _resource_do_request(  # noqa: WPS211
         self,
@@ -133,11 +130,9 @@ async def _resource_do_request(  # noqa: WPS211
         """
         resource_url = urljoin(f"{self.endpoint}/", resource_id)
         url = urljoin(f"{resource_url}/", action) if action else resource_url
-        response = await self.http_client.request(
+        return await self.http_client.request(
             method, url, json=json, params=query_params, headers=headers
         )
-        response.raise_for_status()
-        return response
 
     async def _resource_action(
         self,

mpt_api_client/http/client.py

@@ -1,6 +1,32 @@
 import os
+from typing import Any, override
 
-from httpx import Client, HTTPTransport
+from httpx import (
+    URL,
+    USE_CLIENT_DEFAULT,
+    Client,
+    HTTPError,
+    HTTPStatusError,
+    HTTPTransport,
+    Response,
+)
+from httpx._client import UseClientDefault
+from httpx._types import (
+    AuthTypes,
+    CookieTypes,
+    HeaderTypes,
+    QueryParamTypes,
+    RequestContent,
+    RequestData,
+    RequestExtensions,
+    TimeoutTypes,
+)
+from respx.types import RequestFiles
+
+from mpt_api_client.exceptions import (
+    MPTError,
+    handle_http_status_exception,
+)
 
 
 class HTTPClient(Client):
@@ -40,3 +66,43 @@ def __init__(
             timeout=timeout,
             transport=HTTPTransport(retries=retries),
         )
+
+    @override
+    def request(  # noqa: WPS211
+        self,
+        method: str,
+        url: URL | str,
+        *,
+        content: RequestContent | None = None,  # noqa: WPS110
+        data: RequestData | None = None,  # noqa: WPS110
+        files: RequestFiles | None = None,
+        json: Any | None = None,
+        params: QueryParamTypes | None = None,  # noqa: WPS110
+        headers: HeaderTypes | None = None,
+        cookies: CookieTypes | None = None,
+        auth: AuthTypes | UseClientDefault | None = USE_CLIENT_DEFAULT,
+        follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
+        timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
+        extensions: RequestExtensions | None = None,
+    ) -> Response:
+        try:  # noqa: WPS229
+            response = super().request(
+                method,
+                url,
+                content=content,
+                data=data,
+                files=files,
+                json=json,
+                params=params,
+                headers=headers,
+                cookies=cookies,
+                auth=auth,
+            )
+            response.raise_for_status()
+        except HTTPStatusError as http_status_exception:
+            handle_http_status_exception(http_status_exception)
+        except HTTPError as err:
+            http_error = MPTError()
+            raise http_error from err
+        else:
+            return response

mpt_api_client/http/mixins.py

@@ -23,7 +23,7 @@ def create(self, resource_data: ResourceData) -> Model:
             New resource created.
         """
         response = self.http_client.post(self.endpoint, json=resource_data)  # type: ignore[attr-defined]
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)  # type: ignore[attr-defined]
 
         return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
 
@@ -38,7 +38,7 @@ def delete(self, resource_id: str) -> None:
             resource_id: Resource ID.
         """
         response = self._resource_do_request(resource_id, "DELETE")  # type: ignore[attr-defined]
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)  # type: ignore[attr-defined]
 
 
 class UpdateMixin[Model]:
@@ -87,7 +87,7 @@ def create(
             )
 
         response = self.http_client.post(self.endpoint, files=files)  # type: ignore[attr-defined]
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)  # type: ignore[attr-defined]
         return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
 
     def download(self, resource_id: str) -> FileModel:
@@ -115,7 +115,6 @@ async def create(self, resource_data: ResourceData) -> Model:
             New resource created.
         """
         response = await self.http_client.post(self.endpoint, json=resource_data)  # type: ignore[attr-defined]
-        response.raise_for_status()
 
         return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
 
@@ -130,8 +129,7 @@ async def delete(self, resource_id: str) -> None:
             resource_id: Resource ID.
         """
         url = urljoin(f"{self.endpoint}/", resource_id)  # type: ignore[attr-defined]
-        response = await self.http_client.delete(url)  # type: ignore[attr-defined]
-        response.raise_for_status()
+        await self.http_client.delete(url)  # type: ignore[attr-defined]
 
 
 class AsyncUpdateMixin[Model]:
@@ -180,7 +178,7 @@ async def create(
             )
 
         response = await self.http_client.post(self.endpoint, files=files)  # type: ignore[attr-defined]
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)  # type: ignore[attr-defined]
         return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
 
     async def download(self, resource_id: str) -> FileModel:

mpt_api_client/http/service.py

@@ -101,10 +101,7 @@ def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> httpx.Re
             HTTPStatusError: if the response status code is not 200.
         """
         pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
-        response = self.http_client.get(self.build_url(pagination_params))
-        response.raise_for_status()
-
-        return response
+        return self.http_client.get(self.build_url(pagination_params))
 
     def _resource_do_request(  # noqa: WPS211
         self,
@@ -133,11 +130,9 @@ def _resource_do_request(  # noqa: WPS211
         """
         resource_url = urljoin(f"{self.endpoint}/", resource_id)
         url = urljoin(f"{resource_url}/", action) if action else resource_url
-        response = self.http_client.request(
+        return self.http_client.request(
             method, url, json=json, params=query_params, headers=headers
         )
-        response.raise_for_status()
-        return response
 
     def _resource_action(
         self,

mpt_api_client/resources/notifications/accounts.py

@@ -1,10 +1,11 @@
 from typing import override
 
+from mpt_api_client.exceptions import MPTError
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.models import Model
 
 
-class MethodNotAllowedError(Exception):
+class MethodNotAllowedError(MPTError):
     """Method not allowed error."""
 
 

mpt_api_client/resources/notifications/batches.py

@@ -49,7 +49,6 @@ def create(
             )
 
         response = self.http_client.post(self.endpoint, files=files)
-        response.raise_for_status()
         return self._model_class.from_response(response)
 
     def get_batch_attachment(self, batch_id: str, attachment_id: str) -> FileModel:
@@ -63,7 +62,7 @@ def get_batch_attachment(self, batch_id: str, attachment_id: str) -> FileModel:
             FileModel containing the attachment.
         """
         response = self.http_client.get(f"{self.endpoint}/{batch_id}/attachments/{attachment_id}")
-        response.raise_for_status()
+
         return FileModel(response)
 
 
@@ -99,7 +98,6 @@ async def create(
             )
 
         response = await self.http_client.post(self.endpoint, files=files)
-        response.raise_for_status()
         return self._model_class.from_response(response)
 
     async def get_batch_attachment(self, batch_id: str, attachment_id: str) -> FileModel:
@@ -115,5 +113,4 @@ async def get_batch_attachment(self, batch_id: str, attachment_id: str) -> FileM
         response = await self.http_client.get(
             f"{self.endpoint}/{batch_id}/attachments/{attachment_id}"
         )
-        response.raise_for_status()
         return FileModel(response)

tests/http/test_async_client.py

@@ -1,7 +1,8 @@
 import pytest
 import respx
-from httpx import ConnectTimeout, Response, codes
+from httpx import ConnectTimeout, Request, Response, codes
 
+from mpt_api_client.exceptions import MPTHTTPError
 from mpt_api_client.http.async_client import AsyncHTTPClient
 from tests.conftest import API_TOKEN, API_URL
 
@@ -55,3 +56,11 @@ async def test_async_http_call_failure(async_http_client):
         await async_http_client.get("/timeout")
 
     assert timeout_route.called
+
+
+def test_raise_for_status(async_http_client):
+    request = Request("GET", f"{API_URL}/")
+    response = Response(400, text="response content", request=request)
+
+    with pytest.raises(MPTHTTPError, match="400 - response content"):
+        async_http_client.raise_for_status(response)