Merge pull request #826 from adamtheturtle/simpler-exceptions

Simpler exceptions

Author: adamtheturtle

src/vws/vws.py

@@ -5,7 +5,6 @@
 import base64
 import io
 import json
-from enum import Enum
 from time import sleep
 from typing import Dict, List, Optional, Union
 from urllib.parse import urljoin
@@ -82,41 +81,32 @@ def _target_api_request(
     return response
 
 
-class _ResultCodes(Enum):
+def _raise_for_result_code(
+    response: Response,
+    expected_result_code: str,
+) -> None:
     """
-    Constants representing various VWS result codes.
+    Raise an appropriate exception if the expected result code for a successful
+    request is not returned.
 
-    See
-    https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
-
-    Some codes here are not documented in the above link.
+    Args:
+        response: A response from Vuforia.
+        expected_result_code: See
+            https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
     """
+    result_code = response.json()['result_code']
+    if result_code == expected_result_code:
+        return
 
-    SUCCESS = 'Success'
-    TARGET_CREATED = 'TargetCreated'
-    AUTHENTICATION_FAILURE = 'AuthenticationFailure'
-    REQUEST_TIME_TOO_SKEWED = 'RequestTimeTooSkewed'
-    TARGET_NAME_EXIST = 'TargetNameExist'
-    UNKNOWN_TARGET = 'UnknownTarget'
-    BAD_IMAGE = 'BadImage'
-    IMAGE_TOO_LARGE = 'ImageTooLarge'
-    METADATA_TOO_LARGE = 'MetadataTooLarge'
-    DATE_RANGE_ERROR = 'DateRangeError'
-    FAIL = 'Fail'
-    TARGET_STATUS_PROCESSING = 'TargetStatusProcessing'
-    REQUEST_QUOTA_REACHED = 'RequestQuotaReached'
-    TARGET_STATUS_NOT_SUCCESS = 'TargetStatusNotSuccess'
-    PROJECT_INACTIVE = 'ProjectInactive'
-    INACTIVE_PROJECT = 'InactiveProject'
-
-
-_EXCEPTIONS = {
-    _ResultCodes.IMAGE_TOO_LARGE: ImageTooLarge,
-    _ResultCodes.METADATA_TOO_LARGE: MetadataTooLarge,
-    _ResultCodes.TARGET_NAME_EXIST: TargetNameExist,
-    _ResultCodes.TARGET_STATUS_PROCESSING: TargetStatusProcessing,
-    _ResultCodes.UNKNOWN_TARGET: UnknownTarget,
-}
+    exception = {
+        'ImageTooLarge': ImageTooLarge,
+        'MetadataTooLarge': MetadataTooLarge,
+        'TargetNameExist': TargetNameExist,
+        'TargetStatusProcessing': TargetStatusProcessing,
+        'UnknownTarget': UnknownTarget,
+    }[result_code]
+
+    raise exception(response=response)
 
 
 class VWS:
@@ -192,12 +182,12 @@ def add_target(
             base_vws_url=self._base_vws_url,
         )
 
-        result_code = response.json()['result_code']
-        if _ResultCodes(result_code) == _ResultCodes.TARGET_CREATED:
-            return str(response.json()['target_id'])
+        _raise_for_result_code(
+            response=response,
+            expected_result_code='TargetCreated',
+        )
 
-        exception = _EXCEPTIONS[_ResultCodes(result_code)]
-        raise exception(response=response)
+        return str(response.json()['target_id'])
 
     def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
         """
@@ -221,12 +211,11 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
             base_vws_url=self._base_vws_url,
         )
 
-        result_code = response.json()['result_code']
-        if _ResultCodes(result_code) == _ResultCodes.SUCCESS:
-            return dict(response.json()['target_record'])
-
-        exception = _EXCEPTIONS[_ResultCodes(result_code)]
-        raise exception(response=response)
+        _raise_for_result_code(
+            response=response,
+            expected_result_code='Success',
+        )
+        return dict(response.json()['target_record'])
 
     @timeout_decorator.timeout(seconds=60 * 5)
     def wait_for_target_processed(self, target_id: str) -> None:
@@ -270,6 +259,10 @@ def list_targets(self) -> List[str]:
             base_vws_url=self._base_vws_url,
         )
 
+        _raise_for_result_code(
+            response=response,
+            expected_result_code='Success',
+        )
         return list(response.json()['results'])
 
     def get_target_summary_report(
@@ -297,12 +290,11 @@ def get_target_summary_report(
             base_vws_url=self._base_vws_url,
         )
 
-        result_code = response.json()['result_code']
-        if _ResultCodes(result_code) == _ResultCodes.SUCCESS:
-            return dict(response.json())
-
-        exception = _EXCEPTIONS[_ResultCodes(result_code)]
-        raise exception(response=response)
+        _raise_for_result_code(
+            response=response,
+            expected_result_code='Success',
+        )
+        return dict(response.json())
 
     def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
         """
@@ -323,6 +315,11 @@ def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
             base_vws_url=self._base_vws_url,
         )
 
+        _raise_for_result_code(
+            response=response,
+            expected_result_code='Success',
+        )
+
         return dict(response.json())
 
     def delete_target(self, target_id: str) -> None:
@@ -344,9 +341,7 @@ def delete_target(self, target_id: str) -> None:
             base_vws_url=self._base_vws_url,
         )
 
-        result_code = response.json()['result_code']
-        if _ResultCodes(result_code) == _ResultCodes.SUCCESS:
-            return
-
-        exception = _EXCEPTIONS[_ResultCodes(result_code)]
-        raise exception(response=response)
+        _raise_for_result_code(
+            response=response,
+            expected_result_code='Success',
+        )