Merge pull request #2259 from VWS-Python/request-headers-type

Change request header type to be a mapping, not just dict

Author: adamtheturtle

src/mock_vws/_database_matchers.py

@@ -2,7 +2,7 @@
 Helpers for getting databases which match keys given in requests.
 """
 
-from collections.abc import Iterable
+from collections.abc import Iterable, Mapping
 
 from vws_auth_tools import authorization_header
 
@@ -11,7 +11,7 @@
 
 def get_database_matching_client_keys(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes | None,
     request_method: str,
     request_path: str,
@@ -56,7 +56,7 @@ def get_database_matching_client_keys(
 
 def get_database_matching_server_keys(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes | None,
     request_method: str,
     request_path: str,

src/mock_vws/_query_tools.py

@@ -5,6 +5,7 @@
 import base64
 import io
 import uuid
+from collections.abc import Mapping
 from email.message import EmailMessage
 from typing import Any
 
@@ -20,7 +21,7 @@
 
 def get_query_match_response_text(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
     request_method: str,
     request_path: str,

src/mock_vws/_query_validators/__init__.py

@@ -2,6 +2,8 @@
 Input validators to use in the mock query API.
 """
 
+from collections.abc import Mapping
+
 from mock_vws.database import VuforiaDatabase
 
 from .accept_header_validators import validate_accept_header
@@ -39,7 +41,7 @@
 def run_query_validators(
     *,
     request_path: str,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
     request_method: str,
     databases: set[VuforiaDatabase],

src/mock_vws/_query_validators/accept_header_validators.py

@@ -3,13 +3,14 @@
 """
 
 import logging
+from collections.abc import Mapping
 
 from mock_vws._query_validators.exceptions import InvalidAcceptHeaderError
 
 _LOGGER = logging.getLogger(name=__name__)
 
 
-def validate_accept_header(request_headers: dict[str, str]) -> None:
+def validate_accept_header(request_headers: Mapping[str, str]) -> None:
     """
     Validate the accept header.
 

src/mock_vws/_query_validators/auth_validators.py

@@ -3,6 +3,7 @@
 """
 
 import logging
+from collections.abc import Mapping
 
 from mock_vws._database_matchers import get_database_matching_client_keys
 from mock_vws._query_validators.exceptions import (
@@ -15,7 +16,7 @@
 _LOGGER = logging.getLogger(name=__name__)
 
 
-def validate_auth_header_exists(*, request_headers: dict[str, str]) -> None:
+def validate_auth_header_exists(*, request_headers: Mapping[str, str]) -> None:
     """
     Validate that there is an authorization header given to the query endpoint.
 
@@ -34,7 +35,7 @@ def validate_auth_header_exists(*, request_headers: dict[str, str]) -> None:
 
 def validate_auth_header_number_of_parts(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
 ) -> None:
     """
     Validate the authorization header includes text either side of a space.
@@ -58,7 +59,7 @@ def validate_auth_header_number_of_parts(
 
 def validate_client_key_exists(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     databases: set[VuforiaDatabase],
 ) -> None:
     """
@@ -83,7 +84,7 @@ def validate_client_key_exists(
 
 
 def validate_auth_header_has_signature(
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
 ) -> None:
     """
     Validate the authorization header includes a signature.
@@ -105,7 +106,7 @@ def validate_auth_header_has_signature(
 def validate_authorization(
     *,
     request_path: str,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
     request_method: str,
     databases: set[VuforiaDatabase],

src/mock_vws/_query_validators/content_length_validators.py

@@ -3,6 +3,7 @@
 """
 
 import logging
+from collections.abc import Mapping
 
 from mock_vws._query_validators.exceptions import (
     AuthenticationFailureGoodFormattingError,
@@ -15,7 +16,7 @@
 
 def validate_content_length_header_is_int(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
 ) -> None:
     """
     Validate the ``Content-Length`` header is an integer.
@@ -38,7 +39,7 @@ def validate_content_length_header_is_int(
 
 def validate_content_length_header_not_too_large(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """
@@ -64,7 +65,7 @@ def validate_content_length_header_not_too_large(
 
 def validate_content_length_header_not_too_small(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """

src/mock_vws/_query_validators/content_type_validators.py

@@ -3,6 +3,7 @@
 """
 
 import logging
+from collections.abc import Mapping
 from email.message import EmailMessage
 
 from mock_vws._query_validators.exceptions import (
@@ -16,7 +17,7 @@
 
 
 def validate_content_type_header(
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """

src/mock_vws/_query_validators/date_validators.py

@@ -5,6 +5,7 @@
 import contextlib
 import datetime
 import logging
+from collections.abc import Mapping
 from zoneinfo import ZoneInfo
 
 from mock_vws._query_validators.exceptions import (
@@ -16,7 +17,7 @@
 _LOGGER = logging.getLogger(name=__name__)
 
 
-def validate_date_header_given(*, request_headers: dict[str, str]) -> None:
+def validate_date_header_given(*, request_headers: Mapping[str, str]) -> None:
     """
     Validate the date header is given to the query endpoint.
 
@@ -52,7 +53,7 @@ def _accepted_date_formats() -> set[str]:
     )
 
 
-def validate_date_format(*, request_headers: dict[str, str]) -> None:
+def validate_date_format(*, request_headers: Mapping[str, str]) -> None:
     """
     Validate the format of the date header given to the query endpoint.
 
@@ -73,7 +74,7 @@ def validate_date_format(*, request_headers: dict[str, str]) -> None:
     raise DateFormatNotValidError
 
 
-def validate_date_in_range(*, request_headers: dict[str, str]) -> None:
+def validate_date_in_range(*, request_headers: Mapping[str, str]) -> None:
     """
     Validate date in the date header given to the query endpoint.
 

src/mock_vws/_query_validators/fields_validators.py

@@ -4,6 +4,7 @@
 
 import io
 import logging
+from collections.abc import Mapping
 from email.message import EmailMessage
 
 from werkzeug.formparser import MultiPartParser
@@ -15,7 +16,7 @@
 
 def validate_extra_fields(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """

src/mock_vws/_query_validators/image_validators.py

@@ -4,6 +4,7 @@
 
 import io
 import logging
+from collections.abc import Mapping
 from email.message import EmailMessage
 
 from PIL import Image
@@ -20,7 +21,7 @@
 
 def validate_image_field_given(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """
@@ -51,7 +52,7 @@ def validate_image_field_given(
 
 def validate_image_file_size(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """
@@ -91,7 +92,7 @@ def validate_image_file_size(
 
 def validate_image_dimensions(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """
@@ -129,7 +130,7 @@ def validate_image_dimensions(
 
 def validate_image_format(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """
@@ -162,7 +163,7 @@ def validate_image_format(
 
 
 def validate_image_is_image(
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:
     """