Merge pull request #2070 from VWS-Python/oops-error-occurred-rename

Rename UnknownVWSErrorPossiblyBadName and give it a response param/at…

Author: adamtheturtle

CHANGELOG.rst

@@ -4,6 +4,9 @@ Changelog
 Next
 ----
 
+* Breaking change: The ``vws.exceptions.cloud_reco_exceptions.UnknownVWSErrorPossiblyBadName`` is now ``vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName``.
+* ``vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName`` now has a ``response`` parameter and attribute.
+
 2023.12.26
 ------------
 

spelling_private_dict.txt

@@ -22,7 +22,7 @@ TargetStatusProcessing
 TooManyRequests
 Ubuntu
 UnknownTarget
-UnknownVWSErrorPossiblyBadName
+OopsAnErrorOccurredPossiblyBadName
 admin
 api
 args

src/vws/exceptions/custom_exceptions.py

@@ -5,14 +5,32 @@
 """
 
 
-class UnknownVWSErrorPossiblyBadName(Exception):
+from requests import Response
+
+
+class OopsAnErrorOccurredPossiblyBadName(Exception):
     """
     Exception raised when VWS returns an HTML page which says "Oops, an error
     occurred".
 
     This has been seen to happen when the given name includes a bad character.
     """
 
+    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 RequestEntityTooLarge(Exception):
     """

src/vws/vws.py

@@ -17,8 +17,8 @@
 from vws_auth_tools import authorization_header, rfc_1123_date
 
 from vws.exceptions.custom_exceptions import (
+    OopsAnErrorOccurredPossiblyBadName,
     TargetProcessingTimeout,
-    UnknownVWSErrorPossiblyBadName,
 )
 from vws.exceptions.vws_exceptions import (
     AuthenticationFailure,
@@ -162,8 +162,8 @@ def _make_request(
             The response to the request made by `requests`.
 
         Raises:
-            ~vws.exceptions.UnknownVWSErrorPossiblyBadName: Vuforia returns an
-                HTML page with the text "Oops, an error occurred". This has
+            ~vws.exceptions.OopsAnErrorOccurredPossiblyBadName: Vuforia returns
+                an HTML page with the text "Oops, an error occurred". This has
                 been seen to happen when the given name includes a bad
                 character.
             json.decoder.JSONDecodeError: The server did not respond with valid
@@ -180,7 +180,7 @@ def _make_request(
         )
 
         if "Oops, an error occurred" in response.text:
-            raise UnknownVWSErrorPossiblyBadName
+            raise OopsAnErrorOccurredPossiblyBadName(response=response)
 
         if (
             response.status_code == HTTPStatus.TOO_MANY_REQUESTS
@@ -264,7 +264,7 @@ def add_target(
                 inactive.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
-            ~vws.exceptions.custom_exceptions.UnknownVWSErrorPossiblyBadName:
+            ~vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName:
                 Vuforia returns an HTML page with the text "Oops, an error
                 occurred". This has been seen to happen when the given name
                 includes a bad character.

tests/test_vws_exceptions.py

@@ -13,7 +13,7 @@
 from mock_vws.states import States
 from vws import VWS
 from vws.exceptions.base_exceptions import VWSException
-from vws.exceptions.custom_exceptions import UnknownVWSErrorPossiblyBadName
+from vws.exceptions.custom_exceptions import OopsAnErrorOccurredPossiblyBadName
 from vws.exceptions.vws_exceptions import (
     AuthenticationFailure,
     BadImage,
@@ -69,11 +69,11 @@ def test_invalid_given_id(vws_client: VWS) -> None:
 def test_add_bad_name(vws_client: VWS, high_quality_image: io.BytesIO) -> None:
     """
     When a name with a bad character is given, an
-    ``UnknownVWSErrorPossiblyBadName`` exception is raised.
+    ``OopsAnErrorOccurredPossiblyBadName`` exception is raised.
     """
     max_char_value = 65535
     bad_name = chr(max_char_value + 1)
-    with pytest.raises(UnknownVWSErrorPossiblyBadName):
+    with pytest.raises(OopsAnErrorOccurredPossiblyBadName) as exc:
         vws_client.add_target(
             name=bad_name,
             width=1,
@@ -82,6 +82,8 @@ def test_add_bad_name(vws_client: VWS, high_quality_image: io.BytesIO) -> None:
             application_metadata=None,
         )
 
+    assert exc.value.response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR
+
 
 def test_request_quota_reached() -> None:
     """