Use beartype in more places

Author: adamtheturtle

src/mock_vws/database.py

@@ -76,6 +76,7 @@ class VuforiaDatabase:
     total_recos: int = 0
     target_quota: int = 1000
 
+    @beartype
     def to_dict(self) -> DatabaseDict:
         """
         Dump a target to a dictionary which can be loaded as JSON.
@@ -120,13 +121,15 @@ def from_dict(cls, database_dict: DatabaseDict) -> Self:
         )
 
     @property
+    @beartype
     def not_deleted_targets(self) -> set[Target]:
         """
         All targets which have not been deleted.
         """
         return {target for target in self.targets if not target.delete_date}
 
     @property
+    @beartype
     def active_targets(self) -> set[Target]:
         """
         All active targets.
@@ -139,6 +142,7 @@ def active_targets(self) -> set[Target]:
         }
 
     @property
+    @beartype
     def inactive_targets(self) -> set[Target]:
         """
         All inactive targets.
@@ -151,6 +155,7 @@ def inactive_targets(self) -> set[Target]:
         }
 
     @property
+    @beartype
     def failed_targets(self) -> set[Target]:
         """
         All failed targets.
@@ -162,6 +167,7 @@ def failed_targets(self) -> set[Target]:
         }
 
     @property
+    @beartype
     def processing_targets(self) -> set[Target]:
         """
         All processing targets.

src/mock_vws/image_matchers.py

@@ -5,6 +5,7 @@
 
 import numpy as np
 import torch
+from beartype import beartype
 from PIL import Image
 from torchmetrics.image import (
     StructuralSimilarityIndexMeasure,
@@ -35,6 +36,7 @@ def __call__(
 class ExactMatcher:
     """A matcher which returns whether two images are exactly equal."""
 
+    @beartype
     def __call__(
         self,
         first_image_content: bytes,
@@ -53,6 +55,7 @@ def __call__(
 class StructuralSimilarityMatcher:
     """A matcher which returns whether two images are similar using SSIM."""
 
+    @beartype
     def __call__(
         self,
         first_image_content: bytes,

src/mock_vws/target.py

@@ -11,6 +11,7 @@
 from typing import Self, TypedDict
 from zoneinfo import ZoneInfo
 
+from beartype import beartype
 from PIL import Image, ImageStat
 
 from mock_vws._constants import TargetStatuses
@@ -77,6 +78,7 @@ class Target:
     upload_date: datetime.datetime = field(default_factory=_time_now)
 
     @property
+    @beartype
     def _post_processing_status(self) -> TargetStatuses:
         """
         Return the status of the target, or what it will be when processing is
@@ -100,6 +102,7 @@ def _post_processing_status(self) -> TargetStatuses:
         return TargetStatuses.FAILED
 
     @property
+    @beartype
     def status(self) -> str:
         """
         Return the status of the target.
@@ -125,11 +128,13 @@ def status(self) -> str:
         return self._post_processing_status.value
 
     @property
+    @beartype
     def _post_processing_target_rating(self) -> int:
         """The rating of the target after processing."""
         return self.target_tracking_rater(image_content=self.image_value)
 
     @property
+    @beartype
     def tracking_rating(self) -> int:
         """
         Return the tracking rating of the target recognition image.

src/mock_vws/target_manager.py

@@ -85,6 +85,7 @@ def add_database(self, database: VuforiaDatabase) -> None:
 
     @property
     @beartype
+    @beartype
     def databases(self) -> set[VuforiaDatabase]:
         """
         All cloud databases.

src/mock_vws/target_raters.py

@@ -9,10 +9,12 @@
 import numpy as np
 import piq  # type: ignore[import-untyped]
 import torch
+from beartype import beartype
 from PIL import Image
 
 
 @functools.cache
+@beartype
 def _get_brisque_target_tracking_rating(*, image_content: bytes) -> int:
     """
     Get a target tracking rating based on a BRISQUE score.

tests/mock_vws/fixtures/credentials.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 
 import pytest
+from beartype import beartype
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 from mock_vws.database import VuforiaDatabase
@@ -38,6 +39,7 @@ class _InactiveVuforiaDatabaseSettings(_VuforiaDatabaseSettings):
 
 
 @pytest.fixture
+@beartype
 def vuforia_database() -> VuforiaDatabase:
     """
     Return VWS credentials from environment variables.

tests/mock_vws/fixtures/vuforia_backends.py

@@ -10,6 +10,7 @@
 import pytest
 import requests
 import responses
+from beartype import beartype
 from requests_mock_flask import add_flask_app_to_mock
 from vws import VWS
 from vws.exceptions.vws_exceptions import (
@@ -29,6 +30,7 @@
 
 
 @RETRY_ON_TOO_MANY_REQUESTS
+@beartype
 def _delete_all_targets(*, database_keys: VuforiaDatabase) -> None:
     """
     Delete all targets.
@@ -59,6 +61,7 @@ def _delete_all_targets(*, database_keys: VuforiaDatabase) -> None:
         vws_client.delete_target(target_id=target)
 
 
+@beartype
 def _enable_use_real_vuforia(
     *,
     working_database: VuforiaDatabase,
@@ -72,6 +75,7 @@ def _enable_use_real_vuforia(
     yield
 
 
+@beartype
 def _enable_use_mock_vuforia(
     *,
     working_database: VuforiaDatabase,
@@ -103,6 +107,7 @@ def _enable_use_mock_vuforia(
         yield
 
 
+@beartype
 def _enable_use_docker_in_memory(
     *,
     working_database: VuforiaDatabase,
@@ -183,6 +188,7 @@ class VuforiaBackend(Enum):
     DOCKER_IN_MEMORY = "In Memory version of Docker application"
 
 
+@beartype
 def pytest_addoption(parser: pytest.Parser) -> None:
     """
     Add options to the pytest command line for skipping tests with particular
@@ -204,6 +210,7 @@ def pytest_addoption(parser: pytest.Parser) -> None:
     )
 
 
+@beartype
 def pytest_collection_modifyitems(
     config: pytest.Config,
     items: list[pytest.Function],
@@ -270,6 +277,7 @@ def verify_mock_vuforia(
         ]
     ],
 )
+@beartype
 def mock_only_vuforia(
     request: pytest.FixtureRequest,
     vuforia_database: VuforiaDatabase,

tests/mock_vws/test_database_summary.py

@@ -8,6 +8,7 @@
 from http import HTTPStatus
 
 import pytest
+from beartype import beartype
 from tenacity import RetryCallState, retry
 from tenacity.retry import retry_if_exception_type
 from tenacity.stop import stop_after_delay
@@ -22,6 +23,7 @@
 LOGGER.setLevel(level=logging.DEBUG)
 
 
+@beartype
 def _log_attempt_number(retry_state: RetryCallState) -> None:
     """
     Log the attempt number of a retry.

tests/mock_vws/test_requests_mock_usage.py

@@ -11,6 +11,7 @@
 
 import pytest
 import requests
+from beartype import beartype
 from freezegun import freeze_time
 from PIL import Image
 from requests.exceptions import MissingSchema
@@ -27,6 +28,7 @@
 )
 
 
+@beartype
 def _not_exact_matcher(
     first_image_content: bytes,
     second_image_content: bytes,
@@ -35,6 +37,7 @@ def _not_exact_matcher(
     return first_image_content != second_image_content
 
 
+@beartype
 def request_unmocked_address() -> None:
     """
     Make a request, using `requests` to an unmocked, free local address.
@@ -53,6 +56,7 @@ def request_unmocked_address() -> None:
     requests.get(url=f"http://localhost:{port}", timeout=30)
 
 
+@beartype
 def request_mocked_address() -> None:
     """
     Make a request, using `requests` to an address that is mocked by `MockVWS`.

tests/mock_vws/utils/assertions.py

@@ -102,6 +102,7 @@ def assert_valid_transaction_id(
     assert all(char in hexdigits for char in transaction_id)
 
 
+@beartype
 def assert_json_separators(*, response: requests.Response | Response) -> None:
     """
     Assert that a JSON response is formatted correctly.