Merge pull request #2257 from VWS-Python/beartype

Run beartype instead of typeguard

Author: adamtheturtle

conftest.py

@@ -3,6 +3,7 @@
 from doctest import ELLIPSIS
 
 import pytest
+from beartype import beartype
 from sybil import Sybil
 from sybil.parsers.rest import (
     DocTestParser,
@@ -11,6 +12,16 @@
 
 from tests.mock_vws.utils.retries import RETRY_EXCEPTIONS
 
+
+def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
+    """
+    Apply the beartype decorator to all collected test functions.
+    """
+    for item in items:
+        if isinstance(item, pytest.Function):
+            item.obj = beartype(obj=item.obj)
+
+
 pytest_collect_file = Sybil(
     parsers=[
         DocTestParser(optionflags=ELLIPSIS),

pyproject.toml

@@ -53,6 +53,7 @@ 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",
@@ -88,7 +89,6 @@ optional-dependencies.dev = [
     "sphinxcontrib-spelling==8",
     "sybil==6.1.1",
     "tenacity==9.0.0",
-    "typeguard==4.3.0",
     "types-docker==7.1.0.20240827",
     "types-pillow==10.2.0.20240822",
     "types-pyyaml==6.0.12.20240808",
@@ -323,9 +323,6 @@ keep_full_version = true
 
 xfail_strict = true
 log_cli = true
-typeguard-packages = """
-tests
-"""
 addopts = [
     "--strict-markers",
 ]

spelling_private_dict.txt

@@ -11,6 +11,7 @@ ascii
 auth
 backend
 backends
+beartype
 binascii
 bool
 boolean

tests/conftest.py

@@ -2,21 +2,16 @@
 Configuration, plugins and fixtures for `pytest`.
 """
 
-from __future__ import annotations
-
 import base64
 import binascii
+import io
 import uuid
-from typing import TYPE_CHECKING
 
 import pytest
 from vws import VWS, CloudRecoService
 
-if TYPE_CHECKING:
-    import io
-
-    from mock_vws.database import VuforiaDatabase
-    from tests.mock_vws.utils import Endpoint
+from mock_vws.database import VuforiaDatabase
+from tests.mock_vws.utils import Endpoint
 
 pytest_plugins = [
     "tests.mock_vws.fixtures.prepared_requests",

tests/mock_vws/fixtures/vuforia_backends.py

@@ -2,12 +2,10 @@
 Choose which backends to use for the tests.
 """
 
-from __future__ import annotations
-
 import contextlib
 import logging
+from collections.abc import Generator
 from enum import Enum
-from typing import TYPE_CHECKING
 
 import pytest
 import requests
@@ -26,10 +24,6 @@
 from mock_vws.states import States
 from tests.mock_vws.utils.retries import RETRY_ON_TOO_MANY_REQUESTS
 
-if TYPE_CHECKING:
-    from collections.abc import Generator
-
-
 LOGGER = logging.getLogger(name=__name__)
 LOGGER.setLevel(level=logging.DEBUG)
 

tests/mock_vws/test_add_target.py

@@ -2,21 +2,21 @@
 Tests for the mock of the add target endpoint.
 """
 
-from __future__ import annotations
-
 import base64
 import io
 import json
 from http import HTTPMethod, HTTPStatus
 from string import hexdigits
-from typing import TYPE_CHECKING, Any, Final
+from typing import Any, Final
 from urllib.parse import urljoin
 
 import pytest
 import requests
 from dirty_equals import IsInstance
 from requests.structures import CaseInsensitiveDict
+from vws import VWS
 from vws.exceptions.custom_exceptions import OopsAnErrorOccurredPossiblyBadName
+from vws.exceptions.response import Response
 from vws.exceptions.vws_exceptions import (
     BadImage,
     Fail,
@@ -28,6 +28,7 @@
 from vws_auth_tools import authorization_header, rfc_1123_date
 
 from mock_vws._constants import ResultCodes
+from mock_vws.database import VuforiaDatabase
 from tests.mock_vws.utils import make_image_file
 from tests.mock_vws.utils.assertions import (
     assert_valid_date_header,
@@ -36,12 +37,6 @@
 )
 from tests.mock_vws.utils.too_many_requests import handle_server_errors
 
-if TYPE_CHECKING:
-    from vws import VWS
-    from vws.exceptions.response import Response
-
-    from mock_vws.database import VuforiaDatabase
-
 _MAX_METADATA_BYTES: Final[int] = 1024 * 1024 - 1
 
 

tests/mock_vws/test_authorization_header.py

@@ -2,12 +2,10 @@
 Tests for the `Authorization` header.
 """
 
-from __future__ import annotations
-
+import io
 import json
 import uuid
 from http import HTTPStatus
-from typing import TYPE_CHECKING
 from urllib.parse import urlparse
 
 import pytest
@@ -18,19 +16,15 @@
 from vws_auth_tools import rfc_1123_date
 
 from mock_vws._constants import ResultCodes
+from mock_vws.database import VuforiaDatabase
+from tests.mock_vws.utils import Endpoint
 from tests.mock_vws.utils.assertions import (
     assert_valid_transaction_id,
     assert_vwq_failure,
     assert_vws_failure,
 )
 from tests.mock_vws.utils.too_many_requests import handle_server_errors
 
-if TYPE_CHECKING:
-    import io
-
-    from mock_vws.database import VuforiaDatabase
-    from tests.mock_vws.utils import Endpoint
-
 
 @pytest.mark.usefixtures("verify_mock_vuforia")
 class TestAuthorizationHeader:

tests/mock_vws/test_content_length.py

@@ -2,28 +2,23 @@
 Tests for the ``Content-Length`` header.
 """
 
-from __future__ import annotations
-
 import textwrap
 from http import HTTPStatus
-from typing import TYPE_CHECKING
 from urllib.parse import urlparse
 
 import pytest
 import requests
 from requests.structures import CaseInsensitiveDict
 
 from mock_vws._constants import ResultCodes
+from tests.mock_vws.utils import Endpoint
 from tests.mock_vws.utils.assertions import (
     assert_valid_date_header,
     assert_vwq_failure,
     assert_vws_failure,
 )
 from tests.mock_vws.utils.too_many_requests import handle_server_errors
 
-if TYPE_CHECKING:
-    from tests.mock_vws.utils import Endpoint
-
 
 @pytest.mark.usefixtures("verify_mock_vuforia")
 class TestIncorrect:

tests/mock_vws/test_database_summary.py

@@ -2,12 +2,10 @@
 Tests for the mock of the database summary endpoint.
 """
 
-from __future__ import annotations
-
+import io
 import logging
 import uuid
 from http import HTTPStatus
-from typing import TYPE_CHECKING
 
 import pytest
 from tenacity import RetryCallState, retry
@@ -20,9 +18,6 @@
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 
-if TYPE_CHECKING:
-    import io
-
 LOGGER = logging.getLogger(name=__name__)
 LOGGER.setLevel(level=logging.DEBUG)
 

tests/mock_vws/test_date_header.py

@@ -2,11 +2,8 @@
 Tests for the `Date` header.
 """
 
-from __future__ import annotations
-
 from datetime import datetime, timedelta
 from http import HTTPStatus
-from typing import TYPE_CHECKING
 from urllib.parse import urlparse
 from zoneinfo import ZoneInfo
 
@@ -16,6 +13,7 @@
 from vws_auth_tools import authorization_header, rfc_1123_date
 
 from mock_vws._constants import ResultCodes
+from tests.mock_vws.utils import Endpoint
 from tests.mock_vws.utils.assertions import (
     assert_query_success,
     assert_valid_transaction_id,
@@ -25,9 +23,6 @@
 )
 from tests.mock_vws.utils.too_many_requests import handle_server_errors
 
-if TYPE_CHECKING:
-    from tests.mock_vws.utils import Endpoint
-
 _VWS_MAX_TIME_SKEW = timedelta(minutes=5)
 _VWQ_MAX_TIME_SKEW = timedelta(minutes=65)
 _LEEWAY = timedelta(seconds=10)