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

Do runtime type checking

Author: adamtheturtle

pyproject.toml

@@ -33,13 +33,13 @@ dynamic = [
     "version",
 ]
 dependencies = [
+    "beartype>=0.18.5",
     "requests",
     "urllib3",
     "vws-auth-tools",
 ]
 optional-dependencies.dev = [
     "actionlint-py==1.7.1.15",
-    "beartype==0.18.5",
     "check-manifest==0.49",
     "deptry==0.20.0",
     "doc8==1.1.1",

src/vws/exceptions/base_exceptions.py

@@ -3,9 +3,12 @@
 Cloud Recognition Web API.
 """
 
+from beartype import beartype
+
 from .response import Response
 
 
+@beartype
 class CloudRecoError(Exception):
     """
     Base class for Vuforia Cloud Recognition Web API exceptions.
@@ -27,6 +30,7 @@ def response(self) -> Response:
         return self._response
 
 
+@beartype
 class VWSError(Exception):
     """
     Base class for Vuforia Web Services errors.

src/vws/exceptions/cloud_reco_exceptions.py

@@ -2,37 +2,44 @@
 Exceptions which match errors raised by the Vuforia Cloud Recognition Web APIs.
 """
 
+from beartype import beartype
+
 from vws.exceptions.base_exceptions import CloudRecoError
 
 
+@beartype
 class MaxNumResultsOutOfRangeError(CloudRecoError):
     """
     Exception raised when the ``max_num_results`` given to the Cloud
     Recognition Web API query endpoint is out of range.
     """
 
 
+@beartype
 class InactiveProjectError(CloudRecoError):
     """
     Exception raised when Vuforia returns a response with a result code
     'InactiveProject'.
     """
 
 
+@beartype
 class BadImageError(CloudRecoError):
     """
     Exception raised when Vuforia returns a response with a result code
     'BadImage'.
     """
 
 
+@beartype
 class AuthenticationFailureError(CloudRecoError):
     """
     Exception raised when Vuforia returns a response with a result code
     'AuthenticationFailure'.
     """
 
 
+@beartype
 class RequestTimeTooSkewedError(CloudRecoError):
     """
     Exception raised when Vuforia returns a response with a result code

src/vws/exceptions/custom_exceptions.py

@@ -4,9 +4,12 @@
 or simple errors given by the cloud recognition service.
 """
 
+from beartype import beartype
+
 from .response import Response
 
 
+@beartype
 class OopsAnErrorOccurredPossiblyBadNameError(Exception):
     """
     Exception raised when VWS returns an HTML page which says "Oops, an error
@@ -31,6 +34,7 @@ def response(self) -> Response:
         return self._response
 
 
+@beartype
 class RequestEntityTooLargeError(Exception):
     """
     Exception raised when the given image is too large.
@@ -52,12 +56,14 @@ def response(self) -> Response:
         return self._response
 
 
+@beartype
 class TargetProcessingTimeoutError(Exception):
     """
     Exception raised when waiting for a target to be processed times out.
     """
 
 
+@beartype
 class ServerError(Exception):  # pragma: no cover
     """
     Exception raised when VWS returns a server error.

src/vws/exceptions/response.py

@@ -2,8 +2,11 @@
 
 from dataclasses import dataclass
 
+from beartype import beartype
+
 
 @dataclass
+@beartype
 class Response:
     """
     A response from a request.

src/vws/exceptions/vws_exceptions.py

@@ -7,9 +7,12 @@
 import json
 from urllib.parse import urlparse
 
+from beartype import beartype
+
 from vws.exceptions.base_exceptions import VWSError
 
 
+@beartype
 class UnknownTargetError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
@@ -27,20 +30,23 @@ def target_id(self) -> str:
         return path.split(sep="/", maxsplit=2)[-1]
 
 
+@beartype
 class FailError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
     'Fail'.
     """
 
 
+@beartype
 class BadImageError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
     'BadImage'.
     """
 
 
+@beartype
 class AuthenticationFailureError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
@@ -49,13 +55,15 @@ class AuthenticationFailureError(VWSError):
 
 
 # See https://github.com/VWS-Python/vws-python/issues/822.
+@beartype
 class RequestQuotaReachedError(VWSError):  # pragma: no cover
     """
     Exception raised when Vuforia returns a response with a result code
     'RequestQuotaReached'.
     """
 
 
+@beartype
 class TargetStatusProcessingError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
@@ -74,6 +82,7 @@ def target_id(self) -> str:
 
 
 # This is not simulated by the mock.
+@beartype
 class DateRangeError(VWSError):  # pragma: no cover
     """
     Exception raised when Vuforia returns a response with a result code
@@ -82,6 +91,7 @@ class DateRangeError(VWSError):  # pragma: no cover
 
 
 # This is not simulated by the mock.
+@beartype
 class TargetQuotaReachedError(VWSError):  # pragma: no cover
     """
     Exception raised when Vuforia returns a response with a result code
@@ -90,6 +100,7 @@ class TargetQuotaReachedError(VWSError):  # pragma: no cover
 
 
 # This is not simulated by the mock.
+@beartype
 class ProjectSuspendedError(VWSError):  # pragma: no cover
     """
     Exception raised when Vuforia returns a response with a result code
@@ -98,34 +109,39 @@ class ProjectSuspendedError(VWSError):  # pragma: no cover
 
 
 # This is not simulated by the mock.
+@beartype
 class ProjectHasNoAPIAccessError(VWSError):  # pragma: no cover
     """
     Exception raised when Vuforia returns a response with a result code
     'ProjectHasNoAPIAccess'.
     """
 
 
+@beartype
 class ProjectInactiveError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
     'ProjectInactive'.
     """
 
 
+@beartype
 class MetadataTooLargeError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
     'MetadataTooLarge'.
     """
 
 
+@beartype
 class RequestTimeTooSkewedError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
     'RequestTimeTooSkewed'.
     """
 
 
+@beartype
 class TargetNameExistError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
@@ -142,13 +158,15 @@ def target_name(self) -> str:
         return str(request_json["name"])
 
 
+@beartype
 class ImageTooLargeError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
     'ImageTooLarge'.
     """
 
 
+@beartype
 class TargetStatusNotSuccessError(VWSError):
     """
     Exception raised when Vuforia returns a response with a result code
@@ -166,6 +184,7 @@ def target_id(self) -> str:
         return path.split(sep="/", maxsplit=2)[-1]
 
 
+@beartype
 class TooManyRequestsError(VWSError):  # pragma: no cover
     """
     Exception raised when Vuforia returns a response with a result code

src/vws/include_target_data.py

@@ -4,7 +4,10 @@
 
 from enum import StrEnum, auto
 
+from beartype import beartype
 
+
+@beartype
 class CloudRecoIncludeTargetData(StrEnum):
     """
     Options for the ``include_target_data`` parameter of

src/vws/query.py

@@ -10,6 +10,7 @@
 from urllib.parse import urljoin
 
 import requests
+from beartype import beartype
 from urllib3.filepost import encode_multipart_formdata
 from vws_auth_tools import authorization_header, rfc_1123_date
 
@@ -31,6 +32,7 @@
 _ImageType = io.BytesIO | BinaryIO
 
 
+@beartype
 def _get_image_data(image: _ImageType) -> bytes:
     """Get the data of an image file."""
     original_tell = image.tell()
@@ -40,6 +42,7 @@ def _get_image_data(image: _ImageType) -> bytes:
     return image_data
 
 
+@beartype
 class CloudRecoService:
     """
     An interface to the Vuforia Cloud Recognition Web APIs.

src/vws/reports.py

@@ -6,7 +6,10 @@
 from dataclasses import dataclass
 from enum import Enum
 
+from beartype import BeartypeConf, beartype
 
+
+@beartype
 @dataclass
 class DatabaseSummaryReport:
     """
@@ -30,6 +33,7 @@ class DatabaseSummaryReport:
     total_recos: int
 
 
+@beartype
 class TargetStatuses(Enum):
     """Constants representing VWS target statuses.
 
@@ -42,6 +46,7 @@ class TargetStatuses(Enum):
     FAILED = "failed"
 
 
+@beartype
 @dataclass
 class TargetSummaryReport:
     """
@@ -62,6 +67,7 @@ class TargetSummaryReport:
     previous_month_recos: int
 
 
+@beartype(conf=BeartypeConf(is_pep484_tower=True))
 @dataclass
 class TargetRecord:
     """
@@ -79,6 +85,7 @@ class TargetRecord:
     reco_rating: str
 
 
+@beartype
 @dataclass
 class TargetData:
     """
@@ -90,6 +97,7 @@ class TargetData:
     target_timestamp: datetime.datetime
 
 
+@beartype
 @dataclass
 class QueryResult:
     """
@@ -103,6 +111,7 @@ class QueryResult:
     target_data: TargetData | None
 
 
+@beartype
 @dataclass
 class TargetStatusAndRecord:
     """

src/vws/vws.py

@@ -12,6 +12,7 @@
 from urllib.parse import urljoin
 
 import requests
+from beartype import BeartypeConf, beartype
 from vws_auth_tools import authorization_header, rfc_1123_date
 
 from vws.exceptions.custom_exceptions import (
@@ -51,6 +52,7 @@
 _ImageType = io.BytesIO | BinaryIO
 
 
+@beartype
 def _get_image_data(image: _ImageType) -> bytes:
     """Get the data of an image file."""
     original_tell = image.tell()
@@ -60,6 +62,7 @@ def _get_image_data(image: _ImageType) -> bytes:
     return image_data
 
 
+@beartype
 def _target_api_request(
     server_access_key: str,
     server_secret_key: str,
@@ -125,6 +128,7 @@ def _target_api_request(
     )
 
 
+@beartype(conf=BeartypeConf(is_pep484_tower=True))
 class VWS:
     """
     An interface to Vuforia Web Services APIs.