Merge pull request #2069 from VWS-Python/too-many-requests

Represent and handle 429 error

Author: adamtheturtle

.vscode/settings.json

@@ -5,5 +5,6 @@
         },
         "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.formatOnSave": true
-    }
+    },
+    "esbonio.sphinx.confDir": ""
 }

spelling_private_dict.txt

@@ -19,6 +19,7 @@ TargetProcessingTimeout
 TargetQuotaReached
 TargetStatusNotSuccess
 TargetStatusProcessing
+TooManyRequests
 Ubuntu
 UnknownTarget
 UnknownVWSErrorPossiblyBadName

src/vws/exceptions/vws_exceptions.py

@@ -56,6 +56,13 @@ class RequestQuotaReached(VWSException):  # pragma: no cover
     """
 
 
+class TooManyRequests(VWSException):  # pragma: no cover
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'TooManyRequests'.
+    """
+
+
 class TargetStatusProcessing(VWSException):
     """
     Exception raised when Vuforia returns a response with a result code

src/vws/vws.py

@@ -8,6 +8,7 @@
 import json
 import time
 from datetime import date
+from http import HTTPStatus
 from typing import TYPE_CHECKING, BinaryIO
 from urllib.parse import urljoin
 
@@ -35,6 +36,7 @@
     TargetQuotaReached,
     TargetStatusNotSuccess,
     TargetStatusProcessing,
+    TooManyRequests,
     UnknownTarget,
 )
 from vws.reports import (
@@ -180,6 +182,12 @@ def _make_request(
         if "Oops, an error occurred" in response.text:
             raise UnknownVWSErrorPossiblyBadName
 
+        if (
+            response.status_code == HTTPStatus.TOO_MANY_REQUESTS
+        ):  # pragma: no cover
+            # The Vuforia API returns a 429 response with no JSON body.
+            raise TooManyRequests(response=response)
+
         result_code = response.json()["result_code"]
 
         if result_code == expected_result_code: