Merge pull request #2266 from VWS-Python/more-beartype

Use beartype on many functions

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

@@ -4,11 +4,13 @@
 
 from collections.abc import Iterable, Mapping
 
+from beartype import beartype
 from vws_auth_tools import authorization_header
 
 from mock_vws.database import VuforiaDatabase
 
 
+@beartype
 def get_database_matching_client_keys(
     *,
     request_headers: Mapping[str, str],
@@ -54,6 +56,7 @@ def get_database_matching_client_keys(
     raise ValueError
 
 
+@beartype
 def get_database_matching_server_keys(
     *,
     request_headers: Mapping[str, str],

src/mock_vws/_flask_server/target_manager.py

@@ -10,6 +10,7 @@
 from http import HTTPMethod, HTTPStatus
 from zoneinfo import ZoneInfo
 
+from beartype import beartype
 from flask import Flask, Response, request
 from pydantic_settings import BaseSettings
 
@@ -78,6 +79,7 @@ def delete_database(database_name: str) -> Response:
 
 
 @TARGET_MANAGER_FLASK_APP.route("/databases", methods=[HTTPMethod.GET])
+@beartype
 def get_databases() -> Response:
     """
     Return a list of all databases.

src/mock_vws/_flask_server/vwq.py

@@ -10,6 +10,7 @@
 from http import HTTPMethod, HTTPStatus
 
 import requests
+from beartype import beartype
 from flask import Flask, Response, request
 from pydantic_settings import BaseSettings
 
@@ -58,6 +59,7 @@ class VWQSettings(BaseSettings):
     )
 
 
+@beartype
 def get_all_databases() -> set[VuforiaDatabase]:
     """
     Get all database objects from the target manager back-end.

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
 
@@ -73,6 +74,7 @@ class VWSSettings(BaseSettings):
     )
 
 
+@beartype
 def get_all_databases() -> set[VuforiaDatabase]:
     """
     Get all database objects from the task manager back-end.
@@ -117,6 +119,7 @@ def set_terminate_wsgi_input() -> None:
 
 
 @VWS_FLASK_APP.before_request
+@beartype
 def validate_request() -> None:
     """
     Run validators on the request.
@@ -220,6 +223,7 @@ def add_target() -> Response:
 
 
 @VWS_FLASK_APP.route("/targets/<string:target_id>", methods=[HTTPMethod.GET])
+@beartype
 def get_target(target_id: str) -> Response:
     """
     Get details of a target.
@@ -437,6 +441,7 @@ def target_summary(target_id: str) -> Response:
     "/duplicates/<string:target_id>",
     methods=[HTTPMethod.GET],
 )
+@beartype
 def get_duplicates(target_id: str) -> Response:
     """
     Get targets which may be considered duplicates of a given target.

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

@@ -9,6 +9,7 @@
 from email.message import EmailMessage
 from typing import Any
 
+from beartype import beartype
 from werkzeug.formparser import MultiPartParser
 
 from mock_vws._base64_decoding import decode_base64
@@ -19,6 +20,7 @@
 from mock_vws.image_matchers import ImageMatcher
 
 
+@beartype
 def get_query_match_response_text(
     *,
     request_headers: Mapping[str, str],