Start of moving VWS exceptions around so we separate VWS exceptions from Cloud Reco exceptions and custom exceptions

Author: adamtheturtle

src/vws/_result_codes.py

@@ -6,7 +6,8 @@
 
 from requests import Response
 
-from vws.exceptions import (
+from vws.exceptions.custom_exceptions import UnknownVWSErrorPossiblyBadName
+from vws.exceptions.vws_exceptions import (
     AuthenticationFailure,
     BadImage,
     DateRangeError,
@@ -23,7 +24,6 @@
     TargetStatusNotSuccess,
     TargetStatusProcessing,
     UnknownTarget,
-    UnknownVWSErrorPossiblyBadName,
 )
 
 
@@ -49,7 +49,7 @@ def raise_for_result_code(
         result_code = response.json()['result_code']
     except json.decoder.JSONDecodeError as exc:
         assert 'Oops' in response.text
-        raise UnknownVWSErrorPossiblyBadName(response=response) from exc
+        raise UnknownVWSErrorPossiblyBadName() from exc
 
     if result_code == expected_result_code:
         return

src/vws/exceptions/__init__.py

@@ -0,0 +1,43 @@
+from requests import Response
+
+
+class CloudRecoException(Exception):
+    """
+    Base class for Vuforia Cloud Recognition Web API exceptions.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response to a request to 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 VWSException(Exception):
+    """
+    Base class for Vuforia Web Service errors.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response to a request to 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/exceptions/base_exceptions.py

@@ -0,0 +1,15 @@
+from vws.exceptions.base_exceptions import CloudRecoException
+
+
+class MatchProcessing(CloudRecoException):
+    """
+    Exception raised when a query is made with an image which matches a target
+    which is processing or has recently been deleted.
+    """
+
+
+class MaxNumResultsOutOfRange(CloudRecoException):
+    """
+    Exception raised when the ``max_num_results`` given to the Cloud
+    Recognition Web API query endpoint is out of range.
+    """

src/vws/exceptions/cloud_reco_exceptions.py

@@ -0,0 +1,23 @@
+import requests
+
+
+class UnknownVWSErrorPossiblyBadName(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.
+    """
+
+
+class ConnectionErrorPossiblyImageTooLarge(requests.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 TargetProcessingTimeout(Exception):
+    """
+    Exception raised when waiting for a target to be processed times out.
+    """

src/vws/exceptions/custom_exceptions.py

@@ -1,84 +1,7 @@
-"""
-Custom exceptions for Vuforia errors.
-"""
-
 import json
 from urllib.parse import urlparse
 
-import requests
-from requests import Response
-
-
-class CloudRecoException(Exception):
-    """
-    Base class for Vuforia Cloud Recognition Web API exceptions.
-    """
-
-    def __init__(self, response: Response) -> None:
-        """
-        Args:
-            response: The response to a request to 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 VWSException(Exception):
-    """
-    Base class for Vuforia Web Service errors.
-    """
-
-    def __init__(self, response: Response) -> None:
-        """
-        Args:
-            response: The response to a request to 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 UnknownVWSErrorPossiblyBadName(VWSException):
-    """
-    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.
-    """
-
-
-class ConnectionErrorPossiblyImageTooLarge(requests.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(CloudRecoException):
-    """
-    Exception raised when a query is made with an image which matches a target
-    which is processing or has recently been deleted.
-    """
-
-
-class MaxNumResultsOutOfRange(CloudRecoException):
-    """
-    Exception raised when the ``max_num_results`` given to the Cloud
-    Recognition Web API query endpoint is out of range.
-    """
+from vws.exceptions.base_exceptions import VWSException
 
 
 class UnknownTarget(VWSException):
@@ -144,6 +67,39 @@ def target_id(self) -> str:
         return path.split(sep='/', maxsplit=2)[-1]
 
 
+# This is not simulated by the mock.
+class DateRangeError(VWSException):  # pragma: no cover
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'DateRangeError'.
+    """
+
+
+# This is not simulated by the mock.
+class TargetQuotaReached(VWSException):  # pragma: no cover
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'TargetQuotaReached'.
+    """
+
+
+# This is not simulated by the mock.
+class ProjectSuspended(VWSException):  # pragma: no cover
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'ProjectSuspended'.
+    """
+
+
+# This is not simulated by the mock.
+class ProjectHasNoAPIAccess(VWSException):  # pragma: no cover
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'ProjectHasNoAPIAccess'.
+    """
+
+
+# TODO separate InactiveProject
 class ProjectInactive(VWSException):
     """
     Exception raised when Vuforia returns a response with a result code
@@ -203,41 +159,3 @@ def target_id(self) -> str:
         # Every HTTP path which can raise this error is in the format
         # `/something/{target_id}`.
         return path.split(sep='/', maxsplit=2)[-1]
-
-
-# This is not simulated by the mock.
-class DateRangeError(VWSException):  # pragma: no cover
-    """
-    Exception raised when Vuforia returns a response with a result code
-    'DateRangeError'.
-    """
-
-
-# This is not simulated by the mock.
-class TargetQuotaReached(VWSException):  # pragma: no cover
-    """
-    Exception raised when Vuforia returns a response with a result code
-    'TargetQuotaReached'.
-    """
-
-
-# This is not simulated by the mock.
-class ProjectSuspended(VWSException):  # pragma: no cover
-    """
-    Exception raised when Vuforia returns a response with a result code
-    'ProjectSuspended'.
-    """
-
-
-# This is not simulated by the mock.
-class ProjectHasNoAPIAccess(VWSException):  # pragma: no cover
-    """
-    Exception raised when Vuforia returns a response with a result code
-    'ProjectHasNoAPIAccess'.
-    """
-
-
-class TargetProcessingTimeout(Exception):
-    """
-    Exception raised when waiting for a target to be processed times out.
-    """

src/vws/exceptions.py src/vws/exceptions/vws_exceptions.pysrc/vws/exceptions.py renamed to src/vws/exceptions/vws_exceptions.py

@@ -12,11 +12,13 @@
 from vws_auth_tools import authorization_header, rfc_1123_date
 
 from vws._result_codes import raise_for_result_code
-from vws.exceptions import (
-    ConnectionErrorPossiblyImageTooLarge,
+from vws.exceptions.cloud_reco_exceptions import (
     MatchProcessing,
     MaxNumResultsOutOfRange,
 )
+from vws.exceptions.custom_exceptions import (
+    ConnectionErrorPossiblyImageTooLarge,
+)
 from vws.include_target_data import CloudRecoIncludeTargetData
 from vws.reports import QueryResult, TargetData
 

src/vws/query.py

@@ -17,7 +17,7 @@
 from vws_auth_tools import authorization_header, rfc_1123_date
 
 from vws._result_codes import raise_for_result_code
-from vws.exceptions import TargetProcessingTimeout
+from vws.exceptions.custom_exceptions import TargetProcessingTimeout
 from vws.reports import (
     DatabaseSummaryReport,
     TargetRecord,