Merge pull request #2125 from VWS-Python/too-large-response

Include response in RequestEntityTooLarge exception

Author: adamtheturtle

src/vws/exceptions/custom_exceptions.py

@@ -37,6 +37,21 @@ class RequestEntityTooLarge(Exception):
     Exception raised when the given image is too large.
     """
 
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response returned by Vuforia.
+        """
+        super().__init__(response.text)
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
+
 
 class TargetProcessingTimeout(Exception):
     """

src/vws/query.py

@@ -152,7 +152,7 @@ def query(
         )
 
         if response.status_code == HTTPStatus.REQUEST_ENTITY_TOO_LARGE:
-            raise RequestEntityTooLarge
+            raise RequestEntityTooLarge(response=response)
 
         if "Integer out of range" in response.text:
             raise MaxNumResultsOutOfRange(response=response)

tests/test_cloud_reco_exceptions.py

@@ -58,9 +58,13 @@ def test_image_too_large(
     A ``RequestEntityTooLarge`` exception is raised if an image which is too
     large is given.
     """
-    with pytest.raises(RequestEntityTooLarge):
+    with pytest.raises(RequestEntityTooLarge) as exc:
         cloud_reco_client.query(image=png_too_large)
 
+    assert (
+        exc.value.response.status_code == HTTPStatus.REQUEST_ENTITY_TOO_LARGE
+    )
+
 
 def test_cloudrecoexception_inheritance() -> None:
     """