Neaten some of the codebase

adamtheturtle · adamtheturtle · commit 446187b0803f · 2024-07-13T23:26:08.000+01:00
Remove unnecessary casts
Use keyword arguments more
Require keyword arguments
diff --git a/src/mock_vws/_database_matchers.py b/src/mock_vws/_database_matchers.py
@@ -15,6 +15,7 @@
 
 
 def get_database_matching_client_keys(
+    *,
     request_headers: dict[str, str],
     request_body: bytes | None,
     request_method: str,
@@ -59,6 +60,7 @@ def get_database_matching_client_keys(
 
 
 def get_database_matching_server_keys(
+    *,
     request_headers: dict[str, str],
     request_body: bytes | None,
     request_method: str,
diff --git a/src/mock_vws/_flask_server/vws.py b/src/mock_vws/_flask_server/vws.py
@@ -42,7 +42,7 @@
 VWS_FLASK_APP.config["PROPAGATE_EXCEPTIONS"] = True
 
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 class _ImageMatcherChoice(StrEnum):
diff --git a/src/mock_vws/_query_validators/accept_header_validators.py b/src/mock_vws/_query_validators/accept_header_validators.py
@@ -6,7 +6,7 @@
 
 from mock_vws._query_validators.exceptions import InvalidAcceptHeaderError
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_accept_header(request_headers: dict[str, str]) -> None:
diff --git a/src/mock_vws/_query_validators/auth_validators.py b/src/mock_vws/_query_validators/auth_validators.py
@@ -14,7 +14,7 @@
     MalformedAuthHeaderError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 if TYPE_CHECKING:
     from mock_vws.database import VuforiaDatabase
diff --git a/src/mock_vws/_query_validators/content_length_validators.py b/src/mock_vws/_query_validators/content_length_validators.py
@@ -10,7 +10,7 @@
     ContentLengthHeaderTooLargeError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_content_length_header_is_int(
diff --git a/src/mock_vws/_query_validators/content_type_validators.py b/src/mock_vws/_query_validators/content_type_validators.py
@@ -12,7 +12,7 @@
     UnsupportedMediaTypeError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_content_type_header(
diff --git a/src/mock_vws/_query_validators/date_validators.py b/src/mock_vws/_query_validators/date_validators.py
@@ -13,7 +13,7 @@
     RequestTimeTooSkewedError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_date_header_given(*, request_headers: dict[str, str]) -> None:
diff --git a/src/mock_vws/_query_validators/fields_validators.py b/src/mock_vws/_query_validators/fields_validators.py
@@ -10,10 +10,11 @@
 
 from mock_vws._query_validators.exceptions import UnknownParametersError
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_extra_fields(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
diff --git a/src/mock_vws/_query_validators/image_validators.py b/src/mock_vws/_query_validators/image_validators.py
@@ -15,10 +15,11 @@
     RequestEntityTooLargeError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_image_field_given(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
@@ -49,6 +50,7 @@ def validate_image_field_given(
 
 
 def validate_image_file_size(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
@@ -88,6 +90,7 @@ def validate_image_file_size(
 
 
 def validate_image_dimensions(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
@@ -125,6 +128,7 @@ def validate_image_dimensions(
 
 
 def validate_image_format(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
diff --git a/src/mock_vws/_query_validators/include_target_data_validators.py b/src/mock_vws/_query_validators/include_target_data_validators.py
@@ -10,7 +10,7 @@
 
 from mock_vws._query_validators.exceptions import InvalidIncludeTargetDataError
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_include_target_data(
diff --git a/src/mock_vws/_query_validators/num_results_validators.py b/src/mock_vws/_query_validators/num_results_validators.py
@@ -13,10 +13,11 @@
     MaxNumResultsOutOfRangeError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_max_num_results(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
diff --git a/src/mock_vws/_query_validators/project_state_validators.py b/src/mock_vws/_query_validators/project_state_validators.py
@@ -9,7 +9,7 @@
 from mock_vws.database import VuforiaDatabase
 from mock_vws.states import States
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_project_state(
diff --git a/src/mock_vws/_requests_mock_server/mock_web_query_api.py b/src/mock_vws/_requests_mock_server/mock_web_query_api.py
@@ -95,7 +95,7 @@ def __init__(
         self._query_match_checker = query_match_checker
 
     @route(path_pattern="/v1/query", http_methods={HTTPMethod.POST})
-    def query(self, request: Request, context: Context) -> str:
+    def query(self, *, request: Request, context: Context) -> str:
         """
         Perform an image recognition query.
         """
diff --git a/src/mock_vws/_requests_mock_server/mock_web_services_api.py b/src/mock_vws/_requests_mock_server/mock_web_services_api.py
@@ -90,6 +90,7 @@ class MockVuforiaWebServicesAPI:
 
     def __init__(
         self,
+        *,
         target_manager: TargetManager,
         processing_time_seconds: float,
         duplicate_match_checker: ImageMatcher,
@@ -118,7 +119,7 @@ def __init__(
         path_pattern="/targets",
         http_methods={HTTPMethod.POST},
     )
-    def add_target(self, request: Request, context: Context) -> str:
+    def add_target(self, *, request: Request, context: Context) -> str:
         """
         Add a target.
 
@@ -195,7 +196,7 @@ def add_target(self, request: Request, context: Context) -> str:
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.DELETE},
     )
-    def delete_target(self, request: Request, context: Context) -> str:
+    def delete_target(self, *, request: Request, context: Context) -> str:
         """
         Delete a target.
 
@@ -262,7 +263,7 @@ def delete_target(self, request: Request, context: Context) -> str:
         return body_json
 
     @route(path_pattern="/summary", http_methods={HTTPMethod.GET})
-    def database_summary(self, request: Request, context: Context) -> str:
+    def database_summary(self, *, request: Request, context: Context) -> str:
         """
         Get a database summary report.
 
@@ -328,7 +329,7 @@ def database_summary(self, request: Request, context: Context) -> str:
         return body_json
 
     @route(path_pattern="/targets", http_methods={HTTPMethod.GET})
-    def target_list(self, request: Request, context: Context) -> str:
+    def target_list(self, *, request: Request, context: Context) -> str:
         """
         Get a list of all targets.
 
@@ -388,7 +389,7 @@ def target_list(self, request: Request, context: Context) -> str:
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def get_target(self, request: Request, context: Context) -> str:
+    def get_target(self, *, request: Request, context: Context) -> str:
         """
         Get details of a target.
 
@@ -456,7 +457,7 @@ def get_target(self, request: Request, context: Context) -> str:
         path_pattern=f"/duplicates/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def get_duplicates(self, request: Request, context: Context) -> str:
+    def get_duplicates(self, *, request: Request, context: Context) -> str:
         """
         Get targets which may be considered duplicates of a given target.
 
@@ -530,7 +531,7 @@ def get_duplicates(self, request: Request, context: Context) -> str:
         path_pattern=f"/targets/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.PUT},
     )
-    def update_target(self, request: Request, context: Context) -> str:
+    def update_target(self, *, request: Request, context: Context) -> str:
         """
         Update a target.
 
@@ -639,7 +640,7 @@ def update_target(self, request: Request, context: Context) -> str:
         path_pattern=f"/summary/{_TARGET_ID_PATTERN}",
         http_methods={HTTPMethod.GET},
     )
-    def target_summary(self, request: Request, context: Context) -> str:
+    def target_summary(self, *, request: Request, context: Context) -> str:
         """
         Get a summary report for a target.
 
diff --git a/src/mock_vws/_services_validators/active_flag_validators.py b/src/mock_vws/_services_validators/active_flag_validators.py
@@ -8,7 +8,7 @@
 
 from mock_vws._services_validators.exceptions import FailError
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_active_flag(*, request_body: bytes) -> None:
diff --git a/src/mock_vws/_services_validators/auth_validators.py b/src/mock_vws/_services_validators/auth_validators.py
@@ -18,10 +18,10 @@
     from mock_vws.database import VuforiaDatabase
 
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
-def validate_auth_header_exists(request_headers: dict[str, str]) -> None:
+def validate_auth_header_exists(*, request_headers: dict[str, str]) -> None:
     """
     Validate that there is an authorization header given to a VWS endpoint.
 
@@ -37,6 +37,7 @@ def validate_auth_header_exists(request_headers: dict[str, str]) -> None:
 
 
 def validate_access_key_exists(
+    *,
     request_headers: dict[str, str],
     databases: set[VuforiaDatabase],
 ) -> None:
@@ -65,6 +66,7 @@ def validate_access_key_exists(
 
 
 def validate_auth_header_has_signature(
+    *,
     request_headers: dict[str, str],
 ) -> None:
     """
@@ -87,6 +89,7 @@ def validate_auth_header_has_signature(
 
 
 def validate_authorization(
+    *,
     request_path: str,
     request_headers: dict[str, str],
     request_body: bytes,
@@ -115,8 +118,8 @@ def validate_authorization(
             request_path=request_path,
             databases=databases,
         )
-    except ValueError:
+    except ValueError as exc:
         _LOGGER.warning(
             msg="No database matches the given authorization header.",
         )
-        raise AuthenticationFailureError from ValueError
+        raise AuthenticationFailureError from exc
diff --git a/src/mock_vws/_services_validators/content_length_validators.py b/src/mock_vws/_services_validators/content_length_validators.py
@@ -10,10 +10,11 @@
     ContentLengthHeaderTooLargeError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_content_length_header_is_int(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
@@ -39,6 +40,7 @@ def validate_content_length_header_is_int(
 
 
 def validate_content_length_header_not_too_large(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
@@ -63,6 +65,7 @@ def validate_content_length_header_not_too_large(
 
 
 def validate_content_length_header_not_too_small(
+    *,
     request_headers: dict[str, str],
     request_body: bytes,
 ) -> None:
diff --git a/src/mock_vws/_services_validators/content_type_validators.py b/src/mock_vws/_services_validators/content_type_validators.py
@@ -7,10 +7,11 @@
 
 from mock_vws._services_validators.exceptions import AuthenticationFailureError
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_content_type_header_given(
+    *,
     request_headers: dict[str, str],
     request_method: str,
 ) -> None:
diff --git a/src/mock_vws/_services_validators/date_validators.py b/src/mock_vws/_services_validators/date_validators.py
@@ -12,10 +12,10 @@
     RequestTimeTooSkewedError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
-def validate_date_header_given(request_headers: dict[str, str]) -> None:
+def validate_date_header_given(*, request_headers: dict[str, str]) -> None:
     """
     Validate the date header is given to a VWS endpoint.
 
@@ -32,7 +32,7 @@ def validate_date_header_given(request_headers: dict[str, str]) -> None:
     raise FailError(status_code=HTTPStatus.BAD_REQUEST)
 
 
-def validate_date_format(request_headers: dict[str, str]) -> None:
+def validate_date_format(*, request_headers: dict[str, str]) -> None:
     """
     Validate the format of the date header given to a VWS endpoint.
 
@@ -51,7 +51,7 @@ def validate_date_format(request_headers: dict[str, str]) -> None:
         raise FailError(status_code=HTTPStatus.BAD_REQUEST) from exc
 
 
-def validate_date_in_range(request_headers: dict[str, str]) -> None:
+def validate_date_in_range(*, request_headers: dict[str, str]) -> None:
     """
     Validate the date header given to a VWS endpoint is in range.
 
diff --git a/src/mock_vws/_services_validators/image_validators.py b/src/mock_vws/_services_validators/image_validators.py
@@ -17,7 +17,7 @@
     ImageTooLargeError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_image_format(*, request_body: bytes) -> None:
diff --git a/src/mock_vws/_services_validators/json_validators.py b/src/mock_vws/_services_validators/json_validators.py
@@ -12,7 +12,7 @@
     UnnecessaryRequestBodyError,
 )
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 def validate_body_given(*, request_body: bytes, request_method: str) -> None:
diff --git a/src/mock_vws/_services_validators/key_validators.py b/src/mock_vws/_services_validators/key_validators.py
@@ -10,7 +10,7 @@
 
 from .exceptions import FailError
 
-_LOGGER = logging.getLogger(__name__)
+_LOGGER = logging.getLogger(name=__name__)
 
 
 @dataclass
diff --git a/src/mock_vws/_services_validators/metadata_validators.py b/src/mock_vws/_services_validators/metadata_validators.py
diff --git a/src/mock_vws/_services_validators/name_validators.py b/src/mock_vws/_services_validators/name_validators.py
diff --git a/src/mock_vws/_services_validators/project_state_validators.py b/src/mock_vws/_services_validators/project_state_validators.py
diff --git a/src/mock_vws/_services_validators/target_validators.py b/src/mock_vws/_services_validators/target_validators.py
diff --git a/src/mock_vws/_services_validators/width_validators.py b/src/mock_vws/_services_validators/width_validators.py
diff --git a/tests/mock_vws/fixtures/vuforia_backends.py b/tests/mock_vws/fixtures/vuforia_backends.py
diff --git a/tests/mock_vws/test_database_summary.py b/tests/mock_vws/test_database_summary.py
diff --git a/tests/mock_vws/test_get_target.py b/tests/mock_vws/test_get_target.py

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`MalformedAuthHeaderError,`
`15`	`15`	`)`
`16`	`16`
`17`		`-_LOGGER = logging.getLogger(__name__)`
	`17`	`+_LOGGER = logging.getLogger(name=__name__)`
`18`	`18`
`19`	`19`	`if TYPE_CHECKING:`
`20`	`20`	`from mock_vws.database import VuforiaDatabase`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`ContentLengthHeaderTooLargeError,`
`11`	`11`	`)`
`12`	`12`
`13`		`-_LOGGER = logging.getLogger(__name__)`
	`13`	`+_LOGGER = logging.getLogger(name=__name__)`
`14`	`14`
`15`	`15`
`16`	`16`	`def validate_content_length_header_is_int(`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`UnsupportedMediaTypeError,`
`13`	`13`	`)`
`14`	`14`
`15`		`-_LOGGER = logging.getLogger(__name__)`
	`15`	`+_LOGGER = logging.getLogger(name=__name__)`
`16`	`16`
`17`	`17`
`18`	`18`	`def validate_content_type_header(`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`RequestTimeTooSkewedError,`
`14`	`14`	`)`
`15`	`15`
`16`		`-_LOGGER = logging.getLogger(__name__)`
	`16`	`+_LOGGER = logging.getLogger(name=__name__)`
`17`	`17`
`18`	`18`
`19`	`19`	`def validate_date_header_given(*, request_headers: dict[str, str]) -> None:`