Change base ValidatorException name

Author: adamtheturtle

src/mock_vws/_flask_server/vwq.py

@@ -18,7 +18,7 @@
 )
 from mock_vws._query_validators import run_query_validators
 from mock_vws._query_validators.exceptions import (
-    ValidatorException,
+    ValidatorError,
 )
 from mock_vws.database import VuforiaDatabase
 from mock_vws.image_matchers import (
@@ -100,8 +100,8 @@ def set_terminate_wsgi_input() -> None:
         request.environ["wsgi.input_terminated"] = True
 
 
-@CLOUDRECO_FLASK_APP.errorhandler(ValidatorException)
-def handle_exceptions(exc: ValidatorException) -> Response:
+@CLOUDRECO_FLASK_APP.errorhandler(ValidatorError)
+def handle_exceptions(exc: ValidatorError) -> Response:
     """
     Return the error response associated with the given exception.
     """

src/mock_vws/_flask_server/vws.py

@@ -25,7 +25,7 @@
     Fail,
     TargetStatusNotSuccess,
     TargetStatusProcessing,
-    ValidatorException,
+    ValidatorError,
 )
 from mock_vws.database import VuforiaDatabase
 from mock_vws.image_matchers import (
@@ -131,8 +131,8 @@ def validate_request() -> None:
     )
 
 
-@VWS_FLASK_APP.errorhandler(ValidatorException)
-def handle_exceptions(exc: ValidatorException) -> Response:
+@VWS_FLASK_APP.errorhandler(ValidatorError)
+def handle_exceptions(exc: ValidatorError) -> Response:
     """
     Return the error response associated with the given exception.
     """

src/mock_vws/_query_validators/exceptions.py

@@ -11,7 +11,7 @@
 from mock_vws._mock_common import json_dump
 
 
-class ValidatorException(Exception):
+class ValidatorError(Exception):
     """
     A base class for exceptions thrown from mock Vuforia cloud recognition
     client endpoints.
@@ -22,7 +22,7 @@ class ValidatorException(Exception):
     headers: dict[str, str]
 
 
-class DateHeaderNotGiven(ValidatorException):
+class DateHeaderNotGiven(ValidatorError):
     """
     Exception raised when a date header is not given.
     """
@@ -48,7 +48,7 @@ def __init__(self) -> None:
         }
 
 
-class DateFormatNotValid(ValidatorException):
+class DateFormatNotValid(ValidatorError):
     """
     Exception raised when the date format is not valid.
     """
@@ -75,7 +75,7 @@ def __init__(self) -> None:
         }
 
 
-class RequestTimeTooSkewed(ValidatorException):
+class RequestTimeTooSkewed(ValidatorError):
     """
     Exception raised when Vuforia returns a response with a result code
     'RequestTimeTooSkewed'.
@@ -106,7 +106,7 @@ def __init__(self) -> None:
         }
 
 
-class BadImage(ValidatorException):
+class BadImage(ValidatorError):
     """
     Exception raised when Vuforia returns a response with a result code
     'BadImage'.
@@ -144,7 +144,7 @@ def __init__(self) -> None:
         }
 
 
-class AuthenticationFailure(ValidatorException):
+class AuthenticationFailure(ValidatorError):
     """
     Exception raised when Vuforia returns a response with a result code
     'AuthenticationFailure'.
@@ -182,7 +182,7 @@ def __init__(self) -> None:
         }
 
 
-class AuthenticationFailureGoodFormatting(ValidatorException):
+class AuthenticationFailureGoodFormatting(ValidatorError):
     """
     Exception raised when Vuforia returns a response with a result code
     'AuthenticationFailure' with a standard JSON formatting.
@@ -215,7 +215,7 @@ def __init__(self) -> None:
         }
 
 
-class ImageNotGiven(ValidatorException):
+class ImageNotGiven(ValidatorError):
     """
     Exception raised when an image is not given.
     """
@@ -242,7 +242,7 @@ def __init__(self) -> None:
         }
 
 
-class AuthHeaderMissing(ValidatorException):
+class AuthHeaderMissing(ValidatorError):
     """
     Exception raised when an auth header is not given.
     """
@@ -270,7 +270,7 @@ def __init__(self) -> None:
         }
 
 
-class MalformedAuthHeader(ValidatorException):
+class MalformedAuthHeader(ValidatorError):
     """
     Exception raised when an auth header is not given.
     """
@@ -299,7 +299,7 @@ def __init__(self) -> None:
         }
 
 
-class UnknownParameters(ValidatorException):
+class UnknownParameters(ValidatorError):
     """
     Exception raised when unknown parameters are given.
     """
@@ -326,7 +326,7 @@ def __init__(self) -> None:
         }
 
 
-class InactiveProject(ValidatorException):
+class InactiveProject(ValidatorError):
     """
     Exception raised when Vuforia returns a response with a result code
     'InactiveProject'.
@@ -363,7 +363,7 @@ def __init__(self) -> None:
         }
 
 
-class InvalidMaxNumResults(ValidatorException):
+class InvalidMaxNumResults(ValidatorError):
     """
     Exception raised when an invalid value is given as the
     "max_num_results" field.
@@ -395,7 +395,7 @@ def __init__(self, given_value: str) -> None:
         }
 
 
-class MaxNumResultsOutOfRange(ValidatorException):
+class MaxNumResultsOutOfRange(ValidatorError):
     """
     Exception raised when an integer value is given as the "max_num_results"
     field which is out of range.
@@ -427,7 +427,7 @@ def __init__(self, given_value: str) -> None:
         }
 
 
-class InvalidIncludeTargetData(ValidatorException):
+class InvalidIncludeTargetData(ValidatorError):
     """
     Exception raised when an invalid value is given as the
     "include_target_data" field.
@@ -461,7 +461,7 @@ def __init__(self, given_value: str) -> None:
         }
 
 
-class UnsupportedMediaType(ValidatorException):
+class UnsupportedMediaType(ValidatorError):
     """
     Exception raised when no boundary is found for multipart data.
     """
@@ -487,7 +487,7 @@ def __init__(self) -> None:
         }
 
 
-class InvalidAcceptHeader(ValidatorException):
+class InvalidAcceptHeader(ValidatorError):
     """
     Exception raised when there is an invalid accept header given.
     """
@@ -513,7 +513,7 @@ def __init__(self) -> None:
         }
 
 
-class NoBoundaryFound(ValidatorException):
+class NoBoundaryFound(ValidatorError):
     """
     Exception raised when an invalid media type is given.
     """
@@ -543,7 +543,7 @@ def __init__(self) -> None:
         }
 
 
-class ContentLengthHeaderTooLarge(ValidatorException):
+class ContentLengthHeaderTooLarge(ValidatorError):
     """
     Exception raised when the given content length header is too large.
     """
@@ -566,7 +566,7 @@ def __init__(self) -> None:  # pragma: no cover
         }
 
 
-class ContentLengthHeaderNotInt(ValidatorException):
+class ContentLengthHeaderNotInt(ValidatorError):
     """
     Exception raised when the given content length header is not an integer.
     """
@@ -588,7 +588,7 @@ def __init__(self) -> None:
         }
 
 
-class RequestEntityTooLarge(ValidatorException):
+class RequestEntityTooLarge(ValidatorError):
     """
     Exception raised when the given image file size is too large.
     """
@@ -627,7 +627,7 @@ def __init__(self) -> None:  # pragma: no cover
         }
 
 
-class NoContentType(ValidatorException):
+class NoContentType(ValidatorError):
     """
     Exception raised when a content type is either not given or is empty.
     """

src/mock_vws/_requests_mock_server/mock_web_query_api.py

@@ -17,7 +17,7 @@
 )
 from mock_vws._query_validators import run_query_validators
 from mock_vws._query_validators.exceptions import (
-    ValidatorException,
+    ValidatorError,
 )
 
 if TYPE_CHECKING:
@@ -107,7 +107,7 @@ def query(self, request: Request, context: Context) -> str:
                 request_method=request.method,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text

src/mock_vws/_requests_mock_server/mock_web_services_api.py

@@ -24,7 +24,7 @@
     Fail,
     TargetStatusNotSuccess,
     TargetStatusProcessing,
-    ValidatorException,
+    ValidatorError,
 )
 from mock_vws.target import Target
 
@@ -133,7 +133,7 @@ def add_target(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text
@@ -206,7 +206,7 @@ def delete_target(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text
@@ -269,7 +269,7 @@ def database_summary(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text
@@ -331,7 +331,7 @@ def target_list(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text
@@ -387,7 +387,7 @@ def get_target(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text
@@ -451,7 +451,7 @@ def get_duplicates(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text
@@ -521,7 +521,7 @@ def update_target(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text
@@ -626,7 +626,7 @@ def target_summary(self, request: Request, context: Context) -> str:
                 request_path=request.path,
                 databases=self._target_manager.databases,
             )
-        except ValidatorException as exc:
+        except ValidatorError as exc:
             context.headers = exc.headers
             context.status_code = exc.status_code
             return exc.response_text