vws-python-mock 2026.8.4__py3-none-any.whl

mock_vws/_requests_mock_server/mock_web_query_api.py

@@ -0,0 +1,139 @@
+"""A fake implementation of the Vuforia Web Query API.
+
+See
+https://developer.vuforia.com/library/web-api/vuforia-query-web-api
+"""
+
+import email.utils
+from collections.abc import Callable, Iterable, Mapping
+from http import HTTPMethod, HTTPStatus
+from typing import ParamSpec, Protocol, runtime_checkable
+
+from beartype import beartype
+
+from mock_vws._mock_common import RequestData, Route
+from mock_vws._query_tools import (
+    get_query_match_response_text,
+)
+from mock_vws._query_validators import run_query_validators
+from mock_vws._query_validators.exceptions import (
+    ValidatorError,
+)
+from mock_vws.image_matchers import ImageMatcher
+from mock_vws.target_manager import TargetManager
+
+_ROUTES: set[Route] = set()
+
+_ResponseType = tuple[int, Mapping[str, str], str]
+_P = ParamSpec("_P")
+
+
+@runtime_checkable
+class _RouteMethod(Protocol[_P]):
+    """Callable used for routing which also exposes ``__name__``."""
+
+    __name__: str
+
+    def __call__(self, *args: _P.args, **kwargs: _P.kwargs) -> _ResponseType:
+        """Return a mock response."""
+        ...  # pylint: disable=unnecessary-ellipsis
+
+
+@beartype
+def route(
+    *,
+    path_pattern: str,
+    http_methods: Iterable[str],
+) -> Callable[[_RouteMethod[_P]], _RouteMethod[_P]]:
+    """Register a decorated method so that it can be recognized as a route.
+
+    Args:
+        path_pattern: The end part of a URL pattern. E.g. `/targets` or
+            `/targets/.+`.
+        http_methods: HTTP methods that map to the route function.
+
+    Returns:
+        A decorator which takes methods and makes them recognizable as routes.
+    """
+
+    def decorator(
+        method: _RouteMethod[_P],
+    ) -> _RouteMethod[_P]:
+        """Register a decorated method so that it can be recognized as a
+        route.
+
+        Returns:
+            The given `method` with multiple changes, including added
+            validators.
+        """
+        new_route = Route(
+            route_name=method.__name__,
+            path_pattern=path_pattern,
+            http_methods=frozenset(http_methods),
+        )
+        _ROUTES.add(new_route)
+
+        return method
+
+    return decorator
+
+
+@beartype
+class MockVuforiaWebQueryAPI:
+    """A fake implementation of the Vuforia Web Query API."""
+
+    def __init__(
+        self,
+        target_manager: TargetManager,
+        query_match_checker: ImageMatcher,
+    ) -> None:
+        """
+        Args:
+            target_manager: The target manager which holds all databases.
+            query_match_checker: A callable which takes two image values
+        and
+                returns whether they match.
+
+        Attributes:
+            routes: The `Route`s to be used in the mock.
+        """
+        self.routes = _ROUTES
+        self._target_manager = target_manager
+        self._query_match_checker = query_match_checker
+
+    @route(path_pattern="/v1/query", http_methods={HTTPMethod.POST})
+    def query(self, request: RequestData) -> _ResponseType:
+        """Perform an image recognition query."""
+        try:
+            run_query_validators(
+                request_path=request.path,
+                request_headers=request.headers,
+                request_body=request.body,
+                request_method=request.method,
+                databases=self._target_manager.cloud_databases,
+            )
+        except ValidatorError as exc:
+            return exc.status_code, exc.headers, exc.response_text
+
+        response_text = get_query_match_response_text(
+            request_headers=request.headers,
+            request_body=request.body,
+            request_method=request.method,
+            request_path=request.path,
+            databases=self._target_manager.cloud_databases,
+            query_match_checker=self._query_match_checker,
+        )
+
+        date = email.utils.formatdate(
+            timeval=None,
+            localtime=False,
+            usegmt=True,
+        )
+        headers = {
+            "Connection": "keep-alive",
+            "Content-Type": "application/json",
+            "Server": "nginx",
+            "Date": date,
+            "Content-Length": str(object=len(response_text)),
+        }
+        return HTTPStatus.OK, headers, response_text