Return a new error when the server returns a 5xx status code.

Author: adamtheturtle

CHANGELOG.rst

@@ -4,6 +4,8 @@ Changelog
 Next
 ----
 
+* Return a new error (``vws.custom_exceptions.ServerError``) when the server returns a 5xx status code.
+
 2023.12.27
 ------------
 

src/vws/exceptions/custom_exceptions.py

@@ -42,3 +42,24 @@ class TargetProcessingTimeout(Exception):
     """
     Exception raised when waiting for a target to be processed times out.
     """
+
+
+class ServerError(Exception):  # pragma: no cover
+    """
+    Exception raised when VWS returns a server error.
+    """
+
+    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

src/vws/query.py

@@ -22,6 +22,7 @@
 )
 from vws.exceptions.custom_exceptions import (
     RequestEntityTooLarge,
+    ServerError,
 )
 from vws.include_target_data import CloudRecoIncludeTargetData
 from vws.reports import QueryResult, TargetData
@@ -145,6 +146,11 @@ def query(
         if "Integer out of range" in response.text:
             raise MaxNumResultsOutOfRange(response=response)
 
+        if (
+            response.status_code >= HTTPStatus.INTERNAL_SERVER_ERROR
+        ):  # pragma: no cover
+            raise ServerError(response=response)
+
         result_code = response.json()["result_code"]
         if result_code != "Success":
             exception = {

src/vws/vws.py

@@ -18,6 +18,7 @@
 
 from vws.exceptions.custom_exceptions import (
     OopsAnErrorOccurredPossiblyBadName,
+    ServerError,
     TargetProcessingTimeout,
 )
 from vws.exceptions.vws_exceptions import (
@@ -188,6 +189,11 @@ def _make_request(
             # The Vuforia API returns a 429 response with no JSON body.
             raise TooManyRequests(response=response)
 
+        if (
+            response.status_code >= HTTPStatus.INTERNAL_SERVER_ERROR
+        ):  # pragma: no cover
+            raise ServerError(response=response)
+
         result_code = response.json()["result_code"]
 
         if result_code == expected_result_code: