Merge pull request #1042 from adamtheturtle/deleted-query

Raise exception when a deleted target is matched

Author: adamtheturtle

src/vws/exceptions.py

@@ -5,6 +5,28 @@
 from requests import Response
 
 
+class MatchDeleted(Exception):
+    """
+    Exception raised when a query is made with an image which matches a target
+    which has recently been deleted.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response to a request to Vuforia.
+        """
+        super().__init__()
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
+
+
 class MaxNumResultsOutOfRange(Exception):
     """
     Exception raised when the ``max_num_results`` given to the Cloud

src/vws/query.py

@@ -11,7 +11,7 @@
 
 from ._authorization import authorization_header, rfc_1123_date
 from ._result_codes import raise_for_result_code
-from .exceptions import MaxNumResultsOutOfRange
+from .exceptions import MatchDeleted, MaxNumResultsOutOfRange
 from .include_target_data import CloudRecoIncludeTargetData
 
 
@@ -105,6 +105,9 @@ def query(
         if 'Integer out of range' in response.text:
             raise MaxNumResultsOutOfRange(response=response)
 
+        if 'No content to map due to end-of-input' in response.text:
+            raise MatchDeleted(response=response)
+
         raise_for_result_code(
             response=response,
             expected_result_code='Success',

tests/test_exceptions.py

@@ -18,6 +18,7 @@
     BadImage,
     Fail,
     ImageTooLarge,
+    MatchDeleted,
     MetadataTooLarge,
     ProjectInactive,
     TargetNameExist,
@@ -270,3 +271,24 @@ def test_target_status_not_success(
         vws_client.update_target(target_id=target_id)
 
     assert exc.value.response.status_code == codes.FORBIDDEN
+
+
+def test_match_deleted(
+    vws_client: VWS,
+    cloud_reco_client: CloudRecoService,
+    high_quality_image: io.BytesIO,
+) -> None:
+    """
+    A ``MatchDeleted`` exception is raised when a deleted target is matched.
+    """
+    target_id = vws_client.add_target(
+        name='x',
+        width=1,
+        image=high_quality_image,
+    )
+    vws_client.wait_for_target_processed(target_id=target_id)
+    vws_client.delete_target(target_id=target_id)
+    with pytest.raises(MatchDeleted) as exc:
+        cloud_reco_client.query(image=high_quality_image)
+
+    assert exc.value.response.status_code == codes.INTERNAL_SERVER_ERROR