vws-python-mock 2026.2.21__tar.gz → 2026.2.22__tar.gz

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/CHANGELOG.rst

@@ -4,6 +4,10 @@ Changelog
 Next
 ----
 
+2026.02.22
+----------
+
+
 2026.02.21
 ----------
 

{vws_python_mock-2026.2.21/src/vws_python_mock.egg-info → vws_python_mock-2026.2.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vws-python-mock
-Version: 2026.2.21
+Version: 2026.2.22
 Summary: A mock for the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License-Expression: MIT
@@ -19,12 +19,14 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: beartype>=0.22.9
 Requires-Dist: flask>=3.0.3
+Requires-Dist: httpx>=0.27.0
 Requires-Dist: numpy>=1.26.4
 Requires-Dist: pillow>=11.0.0
 Requires-Dist: piq>=0.8.0
 Requires-Dist: pydantic-settings>=2.6.1
 Requires-Dist: requests>=2.32.3
 Requires-Dist: responses>=0.25.3
+Requires-Dist: respx>=0.21.0
 Requires-Dist: torch>=2.5.1
 Requires-Dist: torchmetrics>=1.5.1
 Requires-Dist: torchvision>=0.20.1
@@ -82,7 +84,7 @@ Requires-Dist: types-pyyaml==6.0.12.20250915; extra == "dev"
 Requires-Dist: types-requests==2.32.4.20260107; extra == "dev"
 Requires-Dist: urllib3==2.6.3; extra == "dev"
 Requires-Dist: vulture==2.14; extra == "dev"
-Requires-Dist: vws-python==2026.2.15; extra == "dev"
+Requires-Dist: vws-python==2026.2.21; extra == "dev"
 Requires-Dist: vws-test-fixtures==2023.3.5; extra == "dev"
 Requires-Dist: vws-web-tools==2026.2.20; extra == "dev"
 Requires-Dist: yamlfix==1.19.1; extra == "dev"
@@ -131,6 +133,30 @@ By default, an exception will be raised if any requests to unmocked addresses ar
 
 .. _requests: https://pypi.org/project/requests/
 
+Mocking calls made to Vuforia with Python ``httpx``
+----------------------------------------------------
+
+Using the mock redirects requests to Vuforia made with `httpx`_ to an in-memory implementation.
+
+.. code-block:: python
+
+    """Make a request to the Vuforia Web Services API mock."""
+
+    import httpx
+
+    from mock_vws import MockVWSForHttpx
+    from mock_vws.database import CloudDatabase
+
+    with MockVWSForHttpx() as mock:
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
+        # This will use the Vuforia mock.
+        httpx.get(url="https://vws.vuforia.com/summary", timeout=30)
+
+By default, an exception will be raised if any requests to unmocked addresses are made.
+
+.. _httpx: https://pypi.org/project/httpx/
+
 Using Docker to mock calls to Vuforia from any language
 -------------------------------------------------------
 

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/README.rst

@@ -38,6 +38,30 @@ By default, an exception will be raised if any requests to unmocked addresses ar
 
 .. _requests: https://pypi.org/project/requests/
 
+Mocking calls made to Vuforia with Python ``httpx``
+----------------------------------------------------
+
+Using the mock redirects requests to Vuforia made with `httpx`_ to an in-memory implementation.
+
+.. code-block:: python
+
+    """Make a request to the Vuforia Web Services API mock."""
+
+    import httpx
+
+    from mock_vws import MockVWSForHttpx
+    from mock_vws.database import CloudDatabase
+
+    with MockVWSForHttpx() as mock:
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
+        # This will use the Vuforia mock.
+        httpx.get(url="https://vws.vuforia.com/summary", timeout=30)
+
+By default, an exception will be raised if any requests to unmocked addresses are made.
+
+.. _httpx: https://pypi.org/project/httpx/
+
 Using Docker to mock calls to Vuforia from any language
 -------------------------------------------------------
 

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/ci/test_custom_linters.py

@@ -83,6 +83,7 @@ def test_ci_patterns_valid(request: pytest.FixtureRequest) -> None:
 
 
 def test_tests_collected_once(
+    *,
     capsys: pytest.CaptureFixture[str],
     request: pytest.FixtureRequest,
 ) -> None:

vws_python_mock-2026.2.22/docs/source/getting-started.rst

@@ -0,0 +1,12 @@
+Getting started
+---------------
+
+Mocking calls made to Vuforia with Python ``requests``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: basic-example.rst
+
+Mocking calls made to Vuforia with Python ``httpx``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: httpx-example.rst

vws_python_mock-2026.2.22/docs/source/httpx-example.rst

@@ -0,0 +1,22 @@
+Using the mock redirects requests to Vuforia made with `httpx`_ to an in-memory implementation.
+
+.. code-block:: python
+
+   """Make a request to the Vuforia Web Services API mock."""
+
+   import httpx
+
+   from mock_vws import MockVWSForHttpx
+   from mock_vws.database import CloudDatabase
+
+   with MockVWSForHttpx() as mock:
+       database = CloudDatabase()
+       mock.add_cloud_database(cloud_database=database)
+       # This will use the Vuforia mock.
+       httpx.get(url="https://vws.vuforia.com/summary", timeout=30)
+
+By default, an exception will be raised if any requests to unmocked addresses are made.
+
+See :ref:`mock-api-reference` for details of what can be changed and how.
+
+.. _httpx: https://pypi.org/project/httpx/

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/docs/source/index.rst

@@ -12,6 +12,11 @@ This requires Python |minimum-python-version|\+.
 
 .. include:: basic-example.rst
 
+Mocking calls made to Vuforia with Python ``httpx``
+----------------------------------------------------
+
+.. include:: httpx-example.rst
+
 Using Docker to mock calls to Vuforia from any language
 -------------------------------------------------------
 

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/docs/source/mock-api-reference.rst

@@ -7,6 +7,10 @@ API Reference
    :members:
    :undoc-members:
 
+.. autoclass:: mock_vws.MockVWSForHttpx
+   :members:
+   :undoc-members:
+
 .. autoclass:: mock_vws.MissingSchemeError
    :members:
    :undoc-members:

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/pyproject.toml

@@ -36,12 +36,14 @@ dynamic = [
 dependencies = [
     "beartype>=0.22.9",
     "flask>=3.0.3",
+    "httpx>=0.27.0",
     "numpy>=1.26.4",
     "pillow>=11.0.0",
     "piq>=0.8.0",
     "pydantic-settings>=2.6.1",
     "requests>=2.32.3",
     "responses>=0.25.3",
+    "respx>=0.21.0",
     "torch>=2.5.1",
     "torchmetrics>=1.5.1",
     "torchvision>=0.20.1",
@@ -103,7 +105,7 @@ optional-dependencies.dev = [
     "types-requests==2.32.4.20260107",
     "urllib3==2.6.3",
     "vulture==2.14",
-    "vws-python==2026.2.15",
+    "vws-python==2026.2.21",
     "vws-test-fixtures==2023.3.5",
     "vws-web-tools==2026.2.20",
     "yamlfix==1.19.1",
@@ -329,18 +331,18 @@ keep_full_version = true
 max_supported_python = "3.13"
 
 [tool.pytest]
-ini_options.xfail_strict = true
-ini_options.log_cli = true
-ini_options.addopts = [
+xfail_strict = true
+log_cli = true
+addopts = [
     "--strict-markers",
 ]
-ini_options.markers = [
+markers = [
     "requires_docker_build",
 ]
 # Options for pytest-retry.
-ini_options.retries = 10
-ini_options.retry_delay = 10
-ini_options.cumulative_timing = false
+retries = "10"
+retry_delay = "10"
+cumulative_timing = false
 
 [tool.coverage]
 run.branch = true

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/spelling_private_dict.txt

@@ -45,6 +45,7 @@ hmac
 html
 http
 https
+httpx
 iff
 io
 issuecomment
@@ -98,6 +99,7 @@ reqjsonarr
 resheader
 resjson
 resjsonarr
+respx
 rfc
 rgb
 str

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/__init__.py

@@ -4,8 +4,10 @@ from mock_vws._requests_mock_server.decorators import (
     MissingSchemeError,
     MockVWS,
 )
+from mock_vws._respx_mock_server.decorators import MockVWSForHttpx
 
 __all__ = [
     "MissingSchemeError",
     "MockVWS",
+    "MockVWSForHttpx",
 ]

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_flask_server/target_manager.py

@@ -91,11 +91,15 @@ def delete_vumark_database(database_name: str) -> Response:
 
     :status 200: The VuMark database has been deleted.
     """
-    (matching_database,) = {
-        database
-        for database in TARGET_MANAGER.vumark_databases
-        if database_name == database.database_name
-    }
+    try:
+        (matching_database,) = {
+            database
+            for database in TARGET_MANAGER.vumark_databases
+            if database_name == database.database_name
+        }
+    except ValueError:
+        return Response(response="", status=HTTPStatus.NOT_FOUND)
+
     TARGET_MANAGER.remove_vumark_database(vumark_database=matching_database)
     return Response(response="", status=HTTPStatus.OK)
 
@@ -365,6 +369,7 @@ def delete_target(database_name: str, target_id: str) -> Response:
     rule="/cloud_databases/<string:database_name>/targets/<string:target_id>",
     methods=[HTTPMethod.PUT],
 )
+@beartype
 def update_target(database_name: str, target_id: str) -> Response:
     """Update a target."""
     (database,) = (

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_flask_server/vwq.py

@@ -113,6 +113,7 @@ def add_response_delay(response: Response) -> Response:
 
 
 @CLOUDRECO_FLASK_APP.errorhandler(code_or_exception=ValidatorError)
+@beartype
 def handle_exceptions(exc: ValidatorError) -> Response:
     """Return the error response associated with the given exception."""
     response = Response(
@@ -127,6 +128,7 @@ def handle_exceptions(exc: ValidatorError) -> Response:
 
 
 @CLOUDRECO_FLASK_APP.route(rule="/v1/query", methods=[HTTPMethod.POST])
+@beartype
 def query() -> Response:
     """Perform an image recognition query."""
     settings = VWQSettings.model_validate(obj={})

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_flask_server/vws.py

@@ -117,6 +117,7 @@ def get_all_vumark_databases() -> set[VuMarkDatabase]:
 
 
 @VWS_FLASK_APP.before_request
+@beartype
 def set_terminate_wsgi_input() -> None:
     """We set ``wsgi.input_terminated`` to ``True`` when going through
     ``requests`` in our tests, so that requests have the given ``Content-
@@ -171,6 +172,7 @@ def add_response_delay(response: Response) -> Response:
 
 
 @VWS_FLASK_APP.errorhandler(code_or_exception=ValidatorError)
+@beartype
 def handle_exceptions(exc: ValidatorError) -> Response:
     """Return the error response associated with the given exception."""
     response = Response(
@@ -319,6 +321,7 @@ def get_target(target_id: str) -> Response:
     rule="/targets/<string:target_id>",
     methods=[HTTPMethod.DELETE],
 )
+@beartype
 def delete_target(target_id: str) -> Response:
     """Delete a target.
 
@@ -395,9 +398,6 @@ def generate_vumark_instance(target_id: str) -> Response:
         databases=all_databases,
     )
 
-    # ``target_id`` is validated by request validators.
-    del target_id
-
     database = get_database_matching_server_keys(
         request_headers=dict(request.headers),
         request_body=request.data,
@@ -408,6 +408,10 @@ def generate_vumark_instance(target_id: str) -> Response:
     if not isinstance(database, VuMarkDatabase):
         raise InvalidTargetTypeError
 
+    target = database.get_vumark_target(target_id=target_id)
+    if target.status != TargetStatuses.SUCCESS.value:
+        raise TargetStatusNotSuccessError
+
     accept = request.headers.get(key="Accept", default="")
     valid_accept_types: dict[str, bytes] = {
         "image/png": VUMARK_PNG,
@@ -499,6 +503,7 @@ def database_summary() -> Response:
     rule="/summary/<string:target_id>",
     methods=[HTTPMethod.GET],
 )
+@beartype
 def target_summary(target_id: str) -> Response:
     """Get a summary report for a target.
 
@@ -616,6 +621,7 @@ def get_duplicates(target_id: str) -> Response:
 
 
 @VWS_FLASK_APP.route(rule="/targets", methods=[HTTPMethod.GET])
+@beartype
 def target_list() -> Response:
     """Get a list of all targets.
 
@@ -658,6 +664,7 @@ def target_list() -> Response:
 @VWS_FLASK_APP.route(
     rule="/targets/<string:target_id>", methods=[HTTPMethod.PUT]
 )
+@beartype
 def update_target(target_id: str) -> Response:
     """Update a target.
 

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_mock_common.py

@@ -1,13 +1,32 @@
 """Common utilities for creating mock routes."""
 
 import json
-from collections.abc import Iterable
+from collections.abc import Iterable, Mapping
 from dataclasses import dataclass
 from typing import Any
 
 from beartype import beartype
 
 
+@beartype
+@dataclass(frozen=True)
+class RequestData:
+    """A library-agnostic representation of an HTTP request.
+
+    Args:
+        method: The HTTP method of the request.
+        path: The path of the request.
+        headers: The headers sent with the request.
+        body: The body of the request.
+    """
+
+    method: str
+    path: str
+    headers: Mapping[str, str]
+    body: bytes
+
+
+@beartype
 @dataclass(frozen=True)
 class Route:
     """A representation of a VWS route.

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_query_validators/content_type_validators.py

@@ -18,6 +18,7 @@ _LOGGER = logging.getLogger(name=__name__)
 
 @beartype
 def validate_content_type_header(
+    *,
     request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_query_validators/date_validators.py

@@ -34,6 +34,7 @@ def validate_date_header_given(*, request_headers: Mapping[str, str]) -> None:
     raise DateHeaderNotGivenError
 
 
+@beartype
 def _accepted_date_formats() -> set[str]:
     """Return all known accepted date formats.
 

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_query_validators/image_validators.py

@@ -171,6 +171,7 @@ def validate_image_format(
 
 @beartype
 def validate_image_is_image(
+    *,
     request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_query_validators/include_target_data_validators.py

@@ -15,6 +15,7 @@ _LOGGER = logging.getLogger(name=__name__)
 
 @beartype
 def validate_include_target_data(
+    *,
     request_headers: Mapping[str, str],
     request_body: bytes,
 ) -> None:

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_query_validators/project_state_validators.py

@@ -15,6 +15,7 @@ _LOGGER = logging.getLogger(name=__name__)
 
 @beartype
 def validate_project_state(
+    *,
     request_path: str,
     request_headers: Mapping[str, str],
     request_body: bytes,

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_requests_mock_server/decorators.py

@@ -12,6 +12,7 @@ from beartype import BeartypeConf, beartype
 from requests import PreparedRequest
 from responses import RequestsMock
 
+from mock_vws._mock_common import RequestData
 from mock_vws.database import CloudDatabase, VuMarkDatabase
 from mock_vws.image_matchers import (
     ImageMatcher,
@@ -27,12 +28,14 @@ from .mock_web_query_api import MockVuforiaWebQueryAPI
 from .mock_web_services_api import MockVuforiaWebServicesAPI
 
 _ResponseType = tuple[int, Mapping[str, str], str | bytes]
-_Callback = Callable[[PreparedRequest], _ResponseType]
+_MockCallback = Callable[[RequestData], _ResponseType]
+_ResponsesCallback = Callable[[PreparedRequest], _ResponseType]
 
 _STRUCTURAL_SIMILARITY_MATCHER = StructuralSimilarityMatcher()
 _BRISQUE_TRACKING_RATER = BrisqueTargetTrackingRater()
 
 
+@beartype
 class MissingSchemeError(Exception):
     """Raised when a URL is missing a schema."""
 
@@ -156,10 +159,10 @@ class MockVWS(ContextDecorator):
 
     @staticmethod
     def _wrap_callback(
-        callback: _Callback,
+        callback: _MockCallback,
         delay_seconds: float,
         sleep_fn: Callable[[float], None],
-    ) -> _Callback:
+    ) -> _ResponsesCallback:
         """Wrap a callback to add a response delay."""
 
         def wrapped(
@@ -186,7 +189,21 @@ class MockVWS(ContextDecorator):
                 sleep_fn(effective)
                 raise requests.exceptions.Timeout
 
-            result = callback(request)
+            raw_body = request.body
+            if raw_body is None:
+                body_bytes = b""
+            elif isinstance(raw_body, str):
+                body_bytes = raw_body.encode(encoding="utf-8")
+            else:
+                body_bytes = raw_body
+
+            request_data = RequestData(
+                method=request.method or "",
+                path=request.path_url,
+                headers=dict(request.headers),
+                body=body_bytes,
+            )
+            result = callback(request_data)
             sleep_fn(delay_seconds)
             return result
 

{vws_python_mock-2026.2.21 → vws_python_mock-2026.2.22}/src/mock_vws/_requests_mock_server/mock_web_query_api.py

@@ -10,9 +10,8 @@ from http import HTTPMethod, HTTPStatus
 from typing import ParamSpec, Protocol, runtime_checkable
 
 from beartype import beartype
-from requests.models import PreparedRequest
 
-from mock_vws._mock_common import Route
+from mock_vws._mock_common import RequestData, Route
 from mock_vws._query_tools import (
     get_query_match_response_text,
 )
@@ -42,6 +41,7 @@ class _RouteMethod(Protocol[_P]):
 
 @beartype
 def route(
+    *,
     path_pattern: str,
     http_methods: Iterable[str],
 ) -> Callable[[_RouteMethod[_P]], _RouteMethod[_P]]:
@@ -78,21 +78,9 @@ def route(
     return decorator
 
 
-@beartype
-def _body_bytes(request: PreparedRequest) -> bytes:
-    """Return the body of a request as bytes."""
-    if request.body is None or isinstance(request.body, str):
-        return b""
-
-    return request.body
-
-
 @beartype
 class MockVuforiaWebQueryAPI:
-    """A fake implementation of the Vuforia Web Query API.
-
-    This implementation is tied to the implementation of ``responses``.
-    """
+    """A fake implementation of the Vuforia Web Query API."""
 
     def __init__(
         self,
@@ -114,14 +102,14 @@ class MockVuforiaWebQueryAPI:
         self._query_match_checker = query_match_checker
 
     @route(path_pattern="/v1/query", http_methods={HTTPMethod.POST})
-    def query(self, request: PreparedRequest) -> _ResponseType:
+    def query(self, request: RequestData) -> _ResponseType:
         """Perform an image recognition query."""
         try:
             run_query_validators(
-                request_path=request.path_url,
+                request_path=request.path,
                 request_headers=request.headers,
-                request_body=_body_bytes(request=request),
-                request_method=request.method or "",
+                request_body=request.body,
+                request_method=request.method,
                 databases=self._target_manager.cloud_databases,
             )
         except ValidatorError as exc:
@@ -129,9 +117,9 @@ class MockVuforiaWebQueryAPI:
 
         response_text = get_query_match_response_text(
             request_headers=request.headers,
-            request_body=_body_bytes(request=request),
-            request_method=request.method or "",
-            request_path=request.path_url,
+            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,
         )