Merge pull request #1070 from adamtheturtle/connection-error

Add custom error for connection error

Author: adamtheturtle

spelling_private_dict.txt

@@ -1,5 +1,6 @@
 AuthenticationFailure
 BadImage
+ConnectionErrorPossiblyImageTooLarge
 ImageTooLarge
 MatchProcessing
 MaxNumResultsOutOfRange

src/vws/exceptions.py

@@ -2,9 +2,19 @@
 Custom exceptions for Vuforia errors.
 """
 
+import requests
 from requests import Response
 
 
+class ConnectionErrorPossiblyImageTooLarge(
+    requests.exceptions.ConnectionError,
+):
+    """
+    Exception raised when a ConnectionError is raised from a query. This has
+    been seen to happen when the given image is too large.
+    """
+
+
 class MatchProcessing(Exception):
     """
     Exception raised when a query is made with an image which matches a target

src/vws/query.py

@@ -11,7 +11,11 @@
 
 from ._authorization import authorization_header, rfc_1123_date
 from ._result_codes import raise_for_result_code
-from .exceptions import MatchProcessing, MaxNumResultsOutOfRange
+from .exceptions import (
+    ConnectionErrorPossiblyImageTooLarge,
+    MatchProcessing,
+    MaxNumResultsOutOfRange,
+)
 from .include_target_data import CloudRecoIncludeTargetData
 
 
@@ -68,6 +72,8 @@ def query(
                 which was recently added, updated or deleted and Vuforia
                 returns an error in this case.
             ~vws.exceptions.ProjectInactive: The project is inactive.
+            ~vws.exceptions.ConnectionErrorPossiblyImageTooLarge: The given
+                image is too large.
 
         Returns:
             An ordered list of target details of matching targets.
@@ -101,12 +107,15 @@ def query(
             'Content-Type': content_type_header,
         }
 
-        response = requests.request(
-            method=method,
-            url=urljoin(base=self._base_vwq_url, url=request_path),
-            headers=headers,
-            data=content,
-        )
+        try:
+            response = requests.request(
+                method=method,
+                url=urljoin(base=self._base_vwq_url, url=request_path),
+                headers=headers,
+                data=content,
+            )
+        except requests.exceptions.ConnectionError as exc:
+            raise ConnectionErrorPossiblyImageTooLarge from exc
 
         if 'Integer out of range' in response.text:
             raise MaxNumResultsOutOfRange(response=response)

tests/test_query.py

@@ -10,7 +10,10 @@
 from mock_vws.database import VuforiaDatabase
 
 from vws import VWS, CloudRecoService
-from vws.exceptions import MaxNumResultsOutOfRange
+from vws.exceptions import (
+    ConnectionErrorPossiblyImageTooLarge,
+    MaxNumResultsOutOfRange,
+)
 from vws.include_target_data import CloudRecoIncludeTargetData
 
 
@@ -48,6 +51,18 @@ def test_match(
         [matching_target] = cloud_reco_client.query(image=high_quality_image)
         assert matching_target['target_id'] == target_id
 
+    def test_too_large(
+        self,
+        cloud_reco_client: CloudRecoService,
+        png_too_large: io.BytesIO,
+    ) -> None:
+        """
+        A ``ConnectionErrorPossiblyImageTooLarge`` exception is raised if an
+        image which is too large is given.
+        """
+        with pytest.raises(ConnectionErrorPossiblyImageTooLarge):
+            cloud_reco_client.query(image=png_too_large)
+
 
 class TestCustomBaseVWQURL:
     """