Merge pull request #2030 from VWS-Python/check-N818

Check and fix N818 ruff rule

Author: adamtheturtle

pyproject.toml

@@ -215,9 +215,6 @@ ignore = [
     "D415",
     # Ruff warns that this conflicts with the formatter.
     "ISC001",
-    # We have an existing interface to support and so we do not want to change
-    # exception names.
-    "N818",
     # Ignore "too-many-*" errors as they seem to get in the way more than
     # helping.
     "PLR0913",

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

@@ -22,10 +22,10 @@
 from mock_vws._mock_common import json_dump
 from mock_vws._services_validators import run_services_validators
 from mock_vws._services_validators.exceptions import (
-    Fail,
-    TargetStatusNotSuccess,
-    TargetStatusProcessing,
-    ValidatorException,
+    FailError,
+    TargetStatusNotSuccessError,
+    TargetStatusProcessingError,
+    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.
     """
@@ -299,7 +299,7 @@ def delete_target(target_id: str) -> Response:
     )
 
     if target.status == TargetStatuses.PROCESSING.value:
-        raise TargetStatusProcessing
+        raise TargetStatusProcessingError
 
     databases_url = f"{settings.target_manager_base_url}/databases"
     requests.delete(
@@ -563,7 +563,7 @@ def update_target(target_id: str) -> Response:
     )
 
     if target.status != TargetStatuses.SUCCESS.value:
-        raise TargetStatusNotSuccess
+        raise TargetStatusNotSuccessError
 
     update_values: dict[str, str | int | float | bool | None] = {}
     if "width" in request_json:
@@ -578,7 +578,7 @@ def update_target(target_id: str) -> Response:
                     "This is not allowed. "
                 ),
             )
-            raise Fail(status_code=HTTPStatus.BAD_REQUEST)
+            raise FailError(status_code=HTTPStatus.BAD_REQUEST)
         update_values["active_flag"] = active_flag
 
     if "application_metadata" in request_json:
@@ -590,7 +590,7 @@ def update_target(target_id: str) -> Response:
                     "This is not allowed."
                 ),
             )
-            raise Fail(status_code=HTTPStatus.BAD_REQUEST)
+            raise FailError(status_code=HTTPStatus.BAD_REQUEST)
         update_values["application_metadata"] = application_metadata
 
     if "name" in request_json:

src/mock_vws/_query_validators/accept_header_validators.py

@@ -4,7 +4,7 @@
 
 import logging
 
-from mock_vws._query_validators.exceptions import InvalidAcceptHeader
+from mock_vws._query_validators.exceptions import InvalidAcceptHeaderError
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -17,7 +17,7 @@ def validate_accept_header(request_headers: dict[str, str]) -> None:
         request_headers: The headers sent with the request.
 
     Raises:
-        InvalidAcceptHeader: The Accept header is given and is not
+        InvalidAcceptHeaderError: The Accept header is given and is not
             'application/json' or '*/*'.
     """
     accept = request_headers.get("Accept")
@@ -27,4 +27,4 @@ def validate_accept_header(request_headers: dict[str, str]) -> None:
     _LOGGER.warning(
         msg="The Accept header is not 'application/json' or '*/*'.",
     )
-    raise InvalidAcceptHeader
+    raise InvalidAcceptHeaderError

src/mock_vws/_query_validators/auth_validators.py

@@ -9,9 +9,9 @@
 
 from mock_vws._database_matchers import get_database_matching_client_keys
 from mock_vws._query_validators.exceptions import (
-    AuthenticationFailure,
-    AuthHeaderMissing,
-    MalformedAuthHeader,
+    AuthenticationFailureError,
+    AuthHeaderMissingError,
+    MalformedAuthHeaderError,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -28,13 +28,13 @@ def validate_auth_header_exists(request_headers: dict[str, str]) -> None:
         request_headers: The headers sent with the request.
 
     Raises:
-        AuthHeaderMissing: There is no "Authorization" header.
+        AuthHeaderMissingError: There is no "Authorization" header.
     """
     if "Authorization" in request_headers:
         return
 
     _LOGGER.warning(msg="There is no authorization header.")
-    raise AuthHeaderMissing
+    raise AuthHeaderMissingError
 
 
 def validate_auth_header_number_of_parts(
@@ -47,7 +47,8 @@ def validate_auth_header_number_of_parts(
         request_headers: The headers sent with the request.
 
     Raises:
-        MalformedAuthHeader: The "Authorization" header is not as expected.
+        MalformedAuthHeaderError: The "Authorization" header is not as
+            expected.
     """
     header = request_headers["Authorization"]
     parts = header.split(" ")
@@ -56,7 +57,7 @@ def validate_auth_header_number_of_parts(
         return
 
     _LOGGER.warning(msg="The authorization header is malformed.")
-    raise MalformedAuthHeader
+    raise MalformedAuthHeaderError
 
 
 def validate_client_key_exists(
@@ -71,7 +72,7 @@ def validate_client_key_exists(
         databases: All Vuforia databases.
 
     Raises:
-        AuthenticationFailure: The client key is unknown.
+        AuthenticationFailureError: The client key is unknown.
     """
     header = request_headers["Authorization"]
     first_part, _ = header.split(":")
@@ -81,7 +82,7 @@ def validate_client_key_exists(
             return
 
     _LOGGER.warning(msg="The client key is unknown.")
-    raise AuthenticationFailure
+    raise AuthenticationFailureError
 
 
 def validate_auth_header_has_signature(
@@ -94,14 +95,14 @@ def validate_auth_header_has_signature(
         request_headers: The headers sent with the request.
 
     Raises:
-        MalformedAuthHeader: The "Authorization" header has no signature.
+        MalformedAuthHeaderError: The "Authorization" header has no signature.
     """
     header = request_headers["Authorization"]
     if header.count(":") == 1 and header.split(":")[1]:
         return
 
     _LOGGER.warning(msg="The authorization header has no signature.")
-    raise MalformedAuthHeader
+    raise MalformedAuthHeaderError
 
 
 def validate_authorization(
@@ -122,7 +123,8 @@ def validate_authorization(
         databases: All Vuforia databases.
 
     Raises:
-        AuthenticationFailure: The "Authorization" header is not as expected.
+        AuthenticationFailureError: The "Authorization" header is not as
+            expected.
     """
     try:
         get_database_matching_client_keys(
@@ -136,4 +138,4 @@ def validate_authorization(
         _LOGGER.warning(
             msg="The authorization header does not match any databases.",
         )
-        raise AuthenticationFailure from ValueError
+        raise AuthenticationFailureError from ValueError

src/mock_vws/_query_validators/content_length_validators.py

@@ -5,9 +5,9 @@
 import logging
 
 from mock_vws._query_validators.exceptions import (
-    AuthenticationFailureGoodFormatting,
-    ContentLengthHeaderNotInt,
-    ContentLengthHeaderTooLarge,
+    AuthenticationFailureGoodFormattingError,
+    ContentLengthHeaderNotIntError,
+    ContentLengthHeaderTooLargeError,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -23,15 +23,16 @@ def validate_content_length_header_is_int(
         request_headers: The headers sent with the request.
 
     Raises:
-        ContentLengthHeaderNotInt: ``Content-Length`` header is not an integer.
+        ContentLengthHeaderNotIntError: ``Content-Length`` header is not an
+            integer.
     """
     given_content_length = request_headers["Content-Length"]
 
     try:
         int(given_content_length)
     except ValueError as exc:
         _LOGGER.warning(msg="The Content-Length header is not an integer.")
-        raise ContentLengthHeaderNotInt from exc
+        raise ContentLengthHeaderNotIntError from exc
 
 
 def validate_content_length_header_not_too_large(
@@ -46,8 +47,8 @@ def validate_content_length_header_not_too_large(
         request_body: The body of the request.
 
     Raises:
-        ContentLengthHeaderTooLarge: The given content length header says that
-            the content length is greater than the body length.
+        ContentLengthHeaderTooLargeError: The given content length header says
+            that the content length is greater than the body length.
     """
     given_content_length = request_headers["Content-Length"]
 
@@ -56,7 +57,7 @@ def validate_content_length_header_not_too_large(
     # We skip coverage here as running a test to cover this is very slow.
     if given_content_length_value > body_length:  # pragma: no cover
         _LOGGER.warning(msg="The Content-Length header is too large.")
-        raise ContentLengthHeaderTooLarge
+        raise ContentLengthHeaderTooLargeError
 
 
 def validate_content_length_header_not_too_small(
@@ -71,8 +72,9 @@ def validate_content_length_header_not_too_small(
         request_body: The body of the request.
 
     Raises:
-        AuthenticationFailureGoodFormatting: The given content length header
-            says that the content length is smaller than the body length.
+        AuthenticationFailureGoodFormattingError: The given content length
+            header says that the content length is smaller than the body
+            length.
     """
     given_content_length = request_headers["Content-Length"]
 
@@ -81,4 +83,4 @@ def validate_content_length_header_not_too_small(
 
     if given_content_length_value < body_length:
         _LOGGER.warning(msg="The Content-Length header is too small.")
-        raise AuthenticationFailureGoodFormatting
+        raise AuthenticationFailureGoodFormattingError

src/mock_vws/_query_validators/content_type_validators.py

@@ -6,10 +6,10 @@
 from email.message import EmailMessage
 
 from mock_vws._query_validators.exceptions import (
-    ImageNotGiven,
-    NoBoundaryFound,
-    NoContentType,
-    UnsupportedMediaType,
+    ImageNotGivenError,
+    NoBoundaryFoundError,
+    NoContentTypeError,
+    UnsupportedMediaTypeError,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -27,17 +27,18 @@ def validate_content_type_header(
         request_body: The body of the request.
 
     Raises:
-        UnsupportedMediaType: The ``Content-Type`` header main part is not
+        UnsupportedMediaTypeError: The ``Content-Type`` header main part is not
             'multipart/form-data'.
-        NoBoundaryFound: The ``Content-Type`` header does not contain a
+        NoBoundaryFoundError: The ``Content-Type`` header does not contain a
             boundary.
-        ImageNotGiven: The boundary is not in the request body.
-        NoContentType: The content type header is either empty or not given.
+        ImageNotGivenError: The boundary is not in the request body.
+        NoContentTypeError: The content type header is either empty or not
+            given.
     """
     content_type_header = request_headers.get("Content-Type", "")
     if not content_type_header:
         _LOGGER.warning(msg="The content type header is empty.")
-        raise NoContentType
+        raise NoContentTypeError
 
     email_message = EmailMessage()
     email_message["Content-Type"] = request_headers["Content-Type"]
@@ -47,15 +48,15 @@ def validate_content_type_header(
                 "The content type header main part is not multipart/form-data."
             ),
         )
-        raise UnsupportedMediaType
+        raise UnsupportedMediaTypeError
 
     boundary = email_message.get_boundary()
     if boundary is None:
         _LOGGER.warning(
             msg="The content type header does not contain a boundary.",
         )
-        raise NoBoundaryFound
+        raise NoBoundaryFoundError
 
     if boundary.encode() not in request_body:
         _LOGGER.warning(msg="The boundary is not in the request body.")
-        raise ImageNotGiven
+        raise ImageNotGivenError