Start using beartype across the library

Author: adamtheturtle

ci/custom_linters.py

@@ -6,8 +6,10 @@
 
 import pytest
 import yaml
+from beartype import beartype
 
 
+@beartype
 def _ci_patterns(*, repository_root: Path) -> set[str]:
     """
     Return the CI patterns given in the CI configuration file.
@@ -21,6 +23,7 @@ def _ci_patterns(*, repository_root: Path) -> set[str]:
     return ci_patterns
 
 
+@beartype
 def _tests_from_pattern(
     *,
     ci_pattern: str,

conftest.py

@@ -13,6 +13,7 @@
 from tests.mock_vws.utils.retries import RETRY_EXCEPTIONS
 
 
+@beartype
 def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
     """
     Apply the beartype decorator to all collected test functions.
@@ -32,6 +33,7 @@ def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
 
 
 @pytest.hookimpl(optionalhook=True)
+@beartype
 def pytest_set_filtered_exceptions() -> tuple[type[Exception], ...]:
     """
     Return exceptions to retry on.

pyproject.toml

@@ -36,6 +36,7 @@ dynamic = [
     "version",
 ]
 dependencies = [
+    "beartype",
     "flask",
     # Pin numpy to avoid:
     # https://github.com/pytorch/pytorch/issues/128860
@@ -53,7 +54,6 @@ dependencies = [
 ]
 optional-dependencies.dev = [
     "actionlint-py==1.7.1.15",
-    "beartype==0.18.5",
     "check-manifest==0.49",
     "check-wheel-contents==0.6.0",
     "deptry==0.20.0",

src/mock_vws/_base64_decoding.py

@@ -6,7 +6,10 @@
 import binascii
 import string
 
+from beartype import beartype
 
+
+@beartype
 def decode_base64(encoded_data: str) -> bytes:
     """
     Decode base64 somewhat like Vuforia does.

src/mock_vws/_database_matchers.py

@@ -2,21 +2,16 @@
 Helpers for getting databases which match keys given in requests.
 """
 
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
+from collections.abc import Iterable, Mapping
 
 from vws_auth_tools import authorization_header
 
-if TYPE_CHECKING:
-    from collections.abc import Iterable
-
-    from mock_vws.database import VuforiaDatabase
+from mock_vws.database import VuforiaDatabase
 
 
 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,

src/mock_vws/_flask_server/vws.py

@@ -14,6 +14,7 @@
 from http import HTTPMethod, HTTPStatus
 
 import requests
+from beartype import beartype
 from flask import Flask, Response, request
 from pydantic_settings import BaseSettings
 
@@ -117,6 +118,7 @@ def set_terminate_wsgi_input() -> None:
 
 
 @VWS_FLASK_APP.before_request
+@beartype
 def validate_request() -> None:
     """
     Run validators on the request.

src/mock_vws/_mock_common.py

@@ -6,6 +6,8 @@
 from dataclasses import dataclass
 from typing import Any
 
+from beartype import beartype
+
 
 @dataclass(frozen=True)
 class Route:
@@ -24,6 +26,7 @@ class Route:
     http_methods: frozenset[str]
 
 
+@beartype
 def json_dump(*, body: dict[str, Any]) -> str:
     """
     Returns:

src/mock_vws/_query_tools.py

@@ -2,29 +2,28 @@
 Tools for making Vuforia queries.
 """
 
-from __future__ import annotations
-
 import base64
 import io
 import uuid
+from collections.abc import Mapping
 from email.message import EmailMessage
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
+from beartype import beartype
 from werkzeug.formparser import MultiPartParser
 
 from mock_vws._base64_decoding import decode_base64
 from mock_vws._constants import ResultCodes, TargetStatuses
 from mock_vws._database_matchers import get_database_matching_client_keys
 from mock_vws._mock_common import json_dump
-
-if TYPE_CHECKING:
-    from mock_vws.database import VuforiaDatabase
-    from mock_vws.image_matchers import ImageMatcher
+from mock_vws.database import VuforiaDatabase
+from mock_vws.image_matchers import ImageMatcher
 
 
+@beartype
 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/accept_header_validators.py

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

src/mock_vws/_query_validators/auth_validators.py

@@ -2,25 +2,24 @@
 Authorization validators to use in the mock query API.
 """
 
-from __future__ import annotations
-
 import logging
-from typing import TYPE_CHECKING
+from collections.abc import Mapping
+
+from beartype import beartype
 
 from mock_vws._database_matchers import get_database_matching_client_keys
 from mock_vws._query_validators.exceptions import (
     AuthenticationFailureError,
     AuthHeaderMissingError,
     MalformedAuthHeaderError,
 )
+from mock_vws.database import VuforiaDatabase
 
 _LOGGER = logging.getLogger(name=__name__)
 
-if TYPE_CHECKING:
-    from mock_vws.database import VuforiaDatabase
-
 
-def validate_auth_header_exists(*, request_headers: dict[str, str]) -> None:
+@beartype
+def validate_auth_header_exists(*, request_headers: Mapping[str, str]) -> None:
     """
     Validate that there is an authorization header given to the query endpoint.
 
@@ -37,9 +36,10 @@ def validate_auth_header_exists(*, request_headers: dict[str, str]) -> None:
     raise AuthHeaderMissingError
 
 
+@beartype
 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.
@@ -61,9 +61,10 @@ def validate_auth_header_number_of_parts(
     raise MalformedAuthHeaderError
 
 
+@beartype
 def validate_client_key_exists(
     *,
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
     databases: set[VuforiaDatabase],
 ) -> None:
     """
@@ -87,8 +88,9 @@ def validate_client_key_exists(
     raise AuthenticationFailureError
 
 
+@beartype
 def validate_auth_header_has_signature(
-    request_headers: dict[str, str],
+    request_headers: Mapping[str, str],
 ) -> None:
     """
     Validate the authorization header includes a signature.
@@ -107,10 +109,11 @@ def validate_auth_header_has_signature(
     raise MalformedAuthHeaderError
 
 
+@beartype
 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],