MPT-14266 Add custom exceptions

Author: albertsola

mpt_api_client/exceptions.py

@@ -0,0 +1,11 @@
+class MPTAPIError(Exception):
+    """Base class for all MPT API exceptions."""
+
+
+class MPTHTTPError(MPTAPIError):
+    """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}")

mpt_api_client/http/async_client.py

@@ -1,6 +1,8 @@
 import os
 
-from httpx import AsyncClient, AsyncHTTPTransport
+from httpx import AsyncClient, AsyncHTTPTransport, HTTPStatusError, Response
+
+from mpt_api_client.exceptions import MPTHTTPError
 
 
 class AsyncHTTPClient(AsyncClient):
@@ -40,3 +42,12 @@ def __init__(
             timeout=timeout,
             transport=AsyncHTTPTransport(retries=retries),
         )
+
+    def raise_for_status(self, response: Response) -> None:
+        """Raise an exception for the given response."""
+        try:
+            response.raise_for_status()
+        except HTTPStatusError as ex:
+            raise MPTHTTPError(
+                status_code=ex.response.status_code, content=ex.response.text
+            ) from ex

mpt_api_client/http/async_service.py

@@ -102,7 +102,7 @@ async def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> ht
         """
         pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
         response = await self.http_client.get(self.build_url(pagination_params))
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)
 
         return response
 
@@ -136,7 +136,7 @@ async def _resource_do_request(  # noqa: WPS211
         response = await self.http_client.request(
             method, url, json=json, params=query_params, headers=headers
         )
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)
         return response
 
     async def _resource_action(

mpt_api_client/http/client.py

@@ -1,6 +1,8 @@
 import os
 
-from httpx import Client, HTTPTransport
+from httpx import Client, HTTPStatusError, HTTPTransport, Response
+
+from mpt_api_client.exceptions import MPTHTTPError
 
 
 class HTTPClient(Client):
@@ -40,3 +42,12 @@ def __init__(
             timeout=timeout,
             transport=HTTPTransport(retries=retries),
         )
+
+    def raise_for_status(self, response: Response) -> None:
+        """Raise an exception for the given response."""
+        try:
+            response.raise_for_status()
+        except HTTPStatusError as ex:
+            raise MPTHTTPError(
+                status_code=ex.response.status_code, content=ex.response.text
+            ) from ex

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,7 @@ 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()
+        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]
 
@@ -131,7 +131,7 @@ async def delete(self, resource_id: str) -> None:
         """
         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()
+        self.http_client.raise_for_status(response)  # type: ignore[attr-defined]
 
 
 class AsyncUpdateMixin[Model]:
@@ -180,7 +180,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

@@ -102,7 +102,7 @@ def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> httpx.Re
         """
         pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
         response = self.http_client.get(self.build_url(pagination_params))
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)
 
         return response
 
@@ -136,7 +136,7 @@ def _resource_do_request(  # noqa: WPS211
         response = self.http_client.request(
             method, url, json=json, params=query_params, headers=headers
         )
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)
         return response
 
     def _resource_action(
@@ -164,4 +164,5 @@ def _resource_action(
             query_params=query_params,
             headers={"Accept": "application/json"},
         )
+        self.http_client.raise_for_status(response)
         return self._model_class.from_response(response)

mpt_api_client/resources/notifications/accounts.py

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

mpt_api_client/resources/notifications/batches.py

@@ -49,7 +49,7 @@ def create(
             )
 
         response = self.http_client.post(self.endpoint, files=files)
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)
         return self._model_class.from_response(response)
 
     def get_batch_attachment(self, batch_id: str, attachment_id: str) -> FileModel:
@@ -63,7 +63,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()
+        self.http_client.raise_for_status(response)
         return FileModel(response)
 
 
@@ -99,7 +99,7 @@ async def create(
             )
 
         response = await self.http_client.post(self.endpoint, files=files)
-        response.raise_for_status()
+        self.http_client.raise_for_status(response)
         return self._model_class.from_response(response)
 
     async def get_batch_attachment(self, batch_id: str, attachment_id: str) -> FileModel:
@@ -115,5 +115,5 @@ 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()
+        self.http_client.raise_for_status(response)
         return FileModel(response)

tests/http/test_service.py

@@ -2,6 +2,7 @@
 import pytest
 import respx
 
+from mpt_api_client.exceptions import MPTHTTPError
 from tests.conftest import DummyModel
 from tests.http.conftest import DummyService
 
@@ -263,5 +264,5 @@ def test_sync_iterate_handles_api_errors(dummy_service):
 
         iterator = dummy_service.iterate()
 
-        with pytest.raises(httpx.HTTPStatusError):
+        with pytest.raises(MPTHTTPError):
             list(iterator)

tests/test_exceptions.py

@@ -0,0 +1,8 @@
+from mpt_api_client.exceptions import MPTHTTPError
+
+
+def test_http_error():
+    exception = MPTHTTPError(status_code=400, content="Content")
+
+    assert exception.status_code == 400
+    assert exception.content == "Content"