vws-python-mock 2026.2.22.2__tar.gz → 2026.2.22.3__tar.gz

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/CHANGELOG.rst

@@ -4,6 +4,13 @@ Changelog
 Next
 ----
 
+2026.02.22.3
+------------
+
+
+- ``MockVWS`` now intercepts both ``requests`` (via ``responses``) and ``httpx`` (via ``respx``) simultaneously.
+  ``MockVWSForHttpx`` has been removed — ``MockVWS`` handles both HTTP libraries.
+
 2026.02.22.2
 ------------
 

{vws_python_mock-2026.2.22.2/src/vws_python_mock.egg-info → vws_python_mock-2026.2.22.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vws-python-mock
-Version: 2026.2.22.2
+Version: 2026.2.22.3
 Summary: A mock for the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License-Expression: MIT
@@ -61,7 +61,6 @@ Requires-Dist: pyroma==5.0.1; extra == "dev"
 Requires-Dist: pytest==9.0.2; extra == "dev"
 Requires-Dist: pytest-retry==1.7.0; extra == "dev"
 Requires-Dist: pytest-xdist==3.8.0; extra == "dev"
-Requires-Dist: python-dotenv==1.2.1; extra == "dev"
 Requires-Dist: pyyaml==6.0.3; extra == "dev"
 Requires-Dist: requests-mock-flask==2026.2.16; extra == "dev"
 Requires-Dist: ruff==0.15.1; extra == "dev"
@@ -86,7 +85,7 @@ Requires-Dist: urllib3==2.6.3; extra == "dev"
 Requires-Dist: vulture==2.14; 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: vws-web-tools==2026.2.22; extra == "dev"
 Requires-Dist: yamlfix==1.19.1; extra == "dev"
 Requires-Dist: zizmor==1.22.0; extra == "dev"
 Provides-Extra: release
@@ -103,10 +102,10 @@ VWS Mock
 
 Mock for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
 
-Mocking calls made to Vuforia with Python ``requests``
-------------------------------------------------------
+Mocking calls made to Vuforia
+------------------------------
 
-Using the mock redirects requests to Vuforia made with `requests`_ to an in-memory implementation.
+``MockVWS`` intercepts requests made with `requests`_ or `httpx`_.
 
 .. code-block:: shell
 
@@ -129,25 +128,18 @@ This requires Python |minimum-python-version|\+.
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 
-By default, an exception will be raised if any requests to unmocked addresses are made.
-
-.. _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.
+``MockVWS`` also intercepts `httpx`_ requests:
 
 .. code-block:: python
 
-    """Make a request to the Vuforia Web Services API mock."""
+    """Make a request to the Vuforia Web Services API mock using httpx."""
 
     import httpx
 
-    from mock_vws import MockVWSForHttpx
+    from mock_vws import MockVWS
     from mock_vws.database import CloudDatabase
 
-    with MockVWSForHttpx() as mock:
+    with MockVWS() as mock:
         database = CloudDatabase()
         mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
@@ -155,6 +147,7 @@ Using the mock redirects requests to Vuforia made with `httpx`_ to an in-memory
 
 By default, an exception will be raised if any requests to unmocked addresses are made.
 
+.. _requests: https://pypi.org/project/requests/
 .. _httpx: https://pypi.org/project/httpx/
 
 Using Docker to mock calls to Vuforia from any language

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/README.rst

@@ -8,10 +8,10 @@ VWS Mock
 
 Mock for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
 
-Mocking calls made to Vuforia with Python ``requests``
-------------------------------------------------------
+Mocking calls made to Vuforia
+------------------------------
 
-Using the mock redirects requests to Vuforia made with `requests`_ to an in-memory implementation.
+``MockVWS`` intercepts requests made with `requests`_ or `httpx`_.
 
 .. code-block:: shell
 
@@ -34,25 +34,18 @@ This requires Python |minimum-python-version|\+.
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 
-By default, an exception will be raised if any requests to unmocked addresses are made.
-
-.. _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.
+``MockVWS`` also intercepts `httpx`_ requests:
 
 .. code-block:: python
 
-    """Make a request to the Vuforia Web Services API mock."""
+    """Make a request to the Vuforia Web Services API mock using httpx."""
 
     import httpx
 
-    from mock_vws import MockVWSForHttpx
+    from mock_vws import MockVWS
     from mock_vws.database import CloudDatabase
 
-    with MockVWSForHttpx() as mock:
+    with MockVWS() as mock:
         database = CloudDatabase()
         mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
@@ -60,6 +53,7 @@ Using the mock redirects requests to Vuforia made with `httpx`_ to an in-memory
 
 By default, an exception will be raised if any requests to unmocked addresses are made.
 
+.. _requests: https://pypi.org/project/requests/
 .. _httpx: https://pypi.org/project/httpx/
 
 Using Docker to mock calls to Vuforia from any language

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/admin/create_secrets_files.py

@@ -11,7 +11,6 @@ from pathlib import Path
 from typing import TYPE_CHECKING
 
 import vws_web_tools
-from dotenv import load_dotenv
 from selenium.common.exceptions import TimeoutException
 
 if TYPE_CHECKING:
@@ -123,6 +122,25 @@ def _create_and_get_vumark_target_id(
     )
 
 
+def _fetch_inactive_database_details(
+    driver: "WebDriver",
+    email_address: str,
+    password: str,
+    database_name: str,
+) -> "DatabaseDict":
+    """Fetch details for an existing inactive database."""
+    vws_web_tools.log_in(
+        driver=driver,
+        email_address=email_address,
+        password=password,
+    )
+    vws_web_tools.wait_for_logged_in(driver=driver)
+    return vws_web_tools.get_database_details(
+        driver=driver,
+        database_name=database_name,
+    )
+
+
 def _create_vuforia_resource_names() -> tuple[str, str, str, str]:
     """Create names for Vuforia resources."""
     time = datetime.datetime.now(tz=datetime.UTC).strftime(
@@ -141,23 +159,18 @@ def main() -> None:
     email_address = os.environ["VWS_EMAIL_ADDRESS"]
     password = os.environ["VWS_PASSWORD"]
     new_secrets_dir = Path(os.environ["NEW_SECRETS_DIR"]).expanduser()
-    existing_secrets_file = Path(
-        os.environ["EXISTING_SECRETS_FILE"]
-    ).expanduser()
-    if not existing_secrets_file.exists():
-        msg = f"Existing secrets file does not exist: {existing_secrets_file}"
-        raise FileNotFoundError(msg)
-    load_dotenv(dotenv_path=existing_secrets_file)
-    inactive_database_details: DatabaseDict = {
-        "database_name": os.environ[
-            "INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME"
-        ],
-        "server_access_key": os.environ["INACTIVE_VUFORIA_SERVER_ACCESS_KEY"],
-        "server_secret_key": os.environ["INACTIVE_VUFORIA_SERVER_SECRET_KEY"],
-        "client_access_key": os.environ["INACTIVE_VUFORIA_CLIENT_ACCESS_KEY"],
-        "client_secret_key": os.environ["INACTIVE_VUFORIA_CLIENT_SECRET_KEY"],
-    }
+    inactive_database_name = os.environ[
+        "INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME"
+    ]
     new_secrets_dir.mkdir(exist_ok=True)
+    inactive_driver = vws_web_tools.create_chrome_driver()
+    inactive_database_details = _fetch_inactive_database_details(
+        driver=inactive_driver,
+        email_address=email_address,
+        password=password,
+        database_name=inactive_database_name,
+    )
+    inactive_driver.quit()
 
     num_databases = 100
     required_files = [

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/docs/source/basic-example.rst

@@ -1,4 +1,4 @@
-Using the mock redirects requests to Vuforia made with `requests`_ to an in-memory implementation.
+``MockVWS`` intercepts requests to Vuforia made with `requests`_ or `httpx`_.
 
 .. code-block:: python
 
@@ -20,3 +20,4 @@ By default, an exception will be raised if any requests to unmocked addresses ar
 See :ref:`mock-api-reference` for details of what can be changed and how.
 
 .. _requests: https://pypi.org/project/requests/
+.. _httpx: https://pypi.org/project/httpx/

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/docs/source/contributing.rst

@@ -102,7 +102,7 @@ To create databases without using the browser, use :file:`admin/create_secrets_f
       $ export VWS_EMAIL_ADDRESS=...
       $ export VWS_PASSWORD=...
       $ export NEW_SECRETS_DIR=...
-      $ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
+      $ export INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME=...
       # You may have to run this a few times, but it is idempotent.
       $ python admin/create_secrets_files.py
       # Each generated file gets its own Cloud database credentials and shares

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

@@ -0,0 +1,9 @@
+Getting started
+---------------
+
+Mocking calls made to Vuforia
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: basic-example.rst
+
+.. include:: httpx-example.rst

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

@@ -0,0 +1,18 @@
+``MockVWS`` also intercepts requests made with `httpx`_.
+
+.. code-block:: python
+
+   """Make a request to the Vuforia Web Services API mock using httpx."""
+
+   import httpx
+
+   from mock_vws import MockVWS
+   from mock_vws.database import CloudDatabase
+
+   with MockVWS() 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)
+
+.. _httpx: https://pypi.org/project/httpx/

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/docs/source/index.rst

@@ -1,8 +1,8 @@
 |project|
 =========
 
-Mocking calls made to Vuforia with Python ``requests``
-------------------------------------------------------
+Mocking calls made to Vuforia
+------------------------------
 
 .. code-block:: console
 
@@ -12,9 +12,6 @@ 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.22.2 → vws_python_mock-2026.2.22.3}/docs/source/mock-api-reference.rst

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

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/pyproject.toml

@@ -79,7 +79,6 @@ optional-dependencies.dev = [
     "pytest==9.0.2",
     "pytest-retry==1.7.0",
     "pytest-xdist==3.8.0",
-    "python-dotenv==1.2.1",
     "pyyaml==6.0.3",
     "requests-mock-flask==2026.2.16",
     "ruff==0.15.1",
@@ -107,7 +106,7 @@ optional-dependencies.dev = [
     "vulture==2.14",
     "vws-python==2026.2.21",
     "vws-test-fixtures==2023.3.5",
-    "vws-web-tools==2026.2.20",
+    "vws-web-tools==2026.2.22",
     "yamlfix==1.19.1",
     "zizmor==1.22.0",
 ]
@@ -453,6 +452,7 @@ ignore_names = [
     "model_config",
     # Used in TYPE_CHECKING for type hints
     "CloudDatabaseDict",
+    "DatabaseDict",
     "VuMarkDatabaseDict",
     "VuMarkTargetDict",
 ]

vws_python_mock-2026.2.22.3/src/mock_vws/__init__.py

@@ -0,0 +1,9 @@
+"""Tools for using a fake implementation of Vuforia."""
+
+from mock_vws._mock_common import MissingSchemeError
+from mock_vws._requests_mock_server.decorators import MockVWS
+
+__all__ = [
+    "MissingSchemeError",
+    "MockVWS",
+]

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/src/mock_vws/_mock_common.py

@@ -8,6 +8,29 @@ from typing import Any
 from beartype import beartype
 
 
+@beartype
+class MissingSchemeError(Exception):
+    """Raised when a URL is missing a schema."""
+
+    def __init__(self, url: str) -> None:
+        """
+        Args:
+            url: The URL which is missing a scheme.
+        """
+        super().__init__()
+        self.url = url
+
+    def __str__(self) -> str:
+        """
+        Give a string representation of this error with a
+        suggestion.
+        """
+        return (
+            f'Invalid URL "{self.url}": No scheme supplied. '
+            f'Perhaps you meant "https://{self.url}".'
+        )
+
+
 @beartype
 @dataclass(frozen=True)
 class RequestData:

{vws_python_mock-2026.2.22.2 → vws_python_mock-2026.2.22.3}/src/mock_vws/_requests_mock_server/decorators.py

@@ -4,7 +4,7 @@ import re
 import time
 from collections.abc import Callable, Mapping
 from contextlib import ContextDecorator
-from typing import Any, Literal, Self
+from typing import TYPE_CHECKING, Any, Literal, Self
 from urllib.parse import urlparse
 
 import requests
@@ -12,7 +12,8 @@ from beartype import BeartypeConf, beartype
 from requests import PreparedRequest
 from responses import RequestsMock
 
-from mock_vws._mock_common import RequestData
+from mock_vws._mock_common import MissingSchemeError, RequestData
+from mock_vws._respx_mock_server.decorators import start_respx_router
 from mock_vws.database import CloudDatabase, VuMarkDatabase
 from mock_vws.image_matchers import (
     ImageMatcher,
@@ -27,6 +28,9 @@ from mock_vws.target_raters import (
 from .mock_web_query_api import MockVuforiaWebQueryAPI
 from .mock_web_services_api import MockVuforiaWebServicesAPI
 
+if TYPE_CHECKING:
+    import respx
+
 _ResponseType = tuple[int, Mapping[str, str], str | bytes]
 _MockCallback = Callable[[RequestData], _ResponseType]
 _ResponsesCallback = Callable[[PreparedRequest], _ResponseType]
@@ -35,32 +39,12 @@ _STRUCTURAL_SIMILARITY_MATCHER = StructuralSimilarityMatcher()
 _BRISQUE_TRACKING_RATER = BrisqueTargetTrackingRater()
 
 
-@beartype
-class MissingSchemeError(Exception):
-    """Raised when a URL is missing a schema."""
-
-    def __init__(self, url: str) -> None:
-        """
-        Args:
-            url: The URL which is missing a scheme.
-        """
-        super().__init__()
-        self.url = url
-
-    def __str__(self) -> str:
-        """
-        Give a string representation of this error with a
-        suggestion.
-        """
-        return (
-            f'Invalid URL "{self.url}": No scheme supplied. '
-            f'Perhaps you meant "https://{self.url}".'
-        )
-
-
 @beartype(conf=BeartypeConf(is_pep484_tower=True))
 class MockVWS(ContextDecorator):
-    """Route requests to Vuforia's Web Service APIs to fakes of those APIs."""
+    """Route requests to Vuforia's Web Service APIs to fakes of those APIs.
+
+    Works with both ``requests`` and ``httpx``.
+    """
 
     def __init__(
         self,
@@ -78,6 +62,8 @@ class MockVWS(ContextDecorator):
         """Route requests to Vuforia's Web Service APIs to fakes of those
         APIs.
 
+        Works with both ``requests`` and ``httpx``.
+
         Args:
             real_http: Whether or not to forward requests to the real
                 server if they are not handled by the mock.
@@ -108,6 +94,7 @@ class MockVWS(ContextDecorator):
         self._response_delay_seconds = response_delay_seconds
         self._sleep_fn = sleep_fn
         self._mock: RequestsMock
+        self._router: respx.MockRouter
         self._target_manager = TargetManager()
 
         self._base_vws_url = base_vws_url
@@ -252,6 +239,16 @@ class MockVWS(ContextDecorator):
         self._mock = mock
         self._mock.start()
 
+        self._router = start_respx_router(
+            mock_vws_api=self._mock_vws_api,
+            mock_vwq_api=self._mock_vwq_api,
+            base_vws_url=self._base_vws_url,
+            base_vwq_url=self._base_vwq_url,
+            response_delay_seconds=self._response_delay_seconds,
+            sleep_fn=self._sleep_fn,
+            real_http=self._real_http,
+        )
+
         return self
 
     def __exit__(self, *exc: object) -> Literal[False]:
@@ -265,4 +262,5 @@ class MockVWS(ContextDecorator):
         del exc
 
         self._mock.stop()
+        self._router.stop()
         return False

vws_python_mock-2026.2.22.3/src/mock_vws/_respx_mock_server/decorators.py

@@ -0,0 +1,183 @@
+"""Helpers for mocking Vuforia with httpx via respx."""
+
+import re
+from collections.abc import Callable, Mapping
+from typing import Protocol
+from urllib.parse import urlparse
+
+import httpx
+import respx
+
+from mock_vws._mock_common import RequestData, Route
+
+_ResponseType = tuple[int, Mapping[str, str], str | bytes]
+
+
+class _APIHandler(Protocol):
+    """An API handler with mock routes."""
+
+    routes: set[Route]
+
+
+def _to_request_data(
+    request: httpx.Request,
+    *,
+    base_path: str,
+) -> RequestData:
+    """Convert an httpx.Request to a RequestData.
+
+    Args:
+        request: The httpx request to convert.
+        base_path: The base path prefix to strip from the request path.
+
+    Returns:
+        A RequestData with method, path, headers, and body set.
+    """
+    path = request.url.raw_path.decode(encoding="ascii")
+    if base_path and path.startswith(base_path):
+        path = path[len(base_path) :]
+    return RequestData(
+        method=request.method,
+        path=path,
+        headers={k.title(): v for k, v in request.headers.items()},
+        body=request.content,
+    )
+
+
+def _block_unmatched(request: httpx.Request) -> httpx.Response:
+    """Raise ConnectError for unmatched requests when real_http=False.
+
+    Args:
+        request: The unmatched httpx request.
+
+    Raises:
+        Exception: A connection error is always raised to block
+            unmatched requests.
+    """
+    raise httpx.ConnectError(
+        message="Connection refused by mock",
+        request=request,
+    )
+
+
+def _make_respx_callback(
+    *,
+    handler: Callable[[RequestData], _ResponseType],
+    base_path: str,
+    delay_seconds: float,
+    sleep_fn: Callable[[float], None],
+) -> Callable[[httpx.Request], httpx.Response]:
+    """Create a respx-compatible callback from a handler.
+
+    Args:
+        handler: A handler that takes a RequestData and returns a
+            response tuple.
+        base_path: The base path prefix to strip from the request path.
+        delay_seconds: The number of seconds to delay the response by.
+        sleep_fn: The function to use for sleeping during delays.
+
+    Returns:
+        A callback that takes an httpx.Request and returns an
+        httpx.Response.
+    """
+
+    def callback(request: httpx.Request) -> httpx.Response:
+        """Handle an httpx request by converting it and calling the
+        handler.
+
+        Args:
+            request: The httpx request to handle.
+
+        Returns:
+            An httpx.Response built from the handler's return value.
+
+        Raises:
+            Exception: A timeout error is raised when the response
+                delay exceeds the read timeout.
+        """
+        request_data = _to_request_data(
+            request=request,
+            base_path=base_path,
+        )
+        timeout_info: dict[str, float | None] = request.extensions.get(
+            "timeout", {}
+        )
+        read_timeout = timeout_info.get("read")
+        if read_timeout is not None and delay_seconds > read_timeout:
+            sleep_fn(read_timeout)
+            raise httpx.ReadTimeout(
+                message="Response delay exceeded read timeout",
+                request=request,
+            )
+        status_code, headers, body = handler(request_data)
+        sleep_fn(delay_seconds)
+        if isinstance(body, str):
+            body = body.encode()
+        return httpx.Response(
+            status_code=status_code,
+            headers=headers,
+            content=body,
+        )
+
+    return callback
+
+
+def start_respx_router(
+    *,
+    mock_vws_api: _APIHandler,
+    mock_vwq_api: _APIHandler,
+    base_vws_url: str,
+    base_vwq_url: str,
+    response_delay_seconds: float,
+    sleep_fn: Callable[[float], None],
+    real_http: bool,
+) -> respx.MockRouter:
+    """Configure and start a respx router with Vuforia routes.
+
+    Args:
+        mock_vws_api: The VWS API handler.
+        mock_vwq_api: The VWQ API handler.
+        base_vws_url: The base URL for the VWS API.
+        base_vwq_url: The base URL for the VWQ API.
+        response_delay_seconds: The number of seconds to delay responses.
+        sleep_fn: The function to use for sleeping during delays.
+        real_http: Whether to pass through unmatched requests.
+
+    Returns:
+        A started respx router.
+    """
+    router = respx.MockRouter(
+        assert_all_called=False,
+        assert_all_mocked=False,
+    )
+
+    for api, base_url in (
+        (mock_vws_api, base_vws_url),
+        (mock_vwq_api, base_vwq_url),
+    ):
+        base_path = urlparse(url=base_url).path.rstrip("/")
+        for route in api.routes:
+            url_pattern = base_url.rstrip("/") + route.path_pattern + "$"
+            compiled_url_pattern = re.compile(pattern=url_pattern)
+
+            for http_method in route.http_methods:
+                original_callback = getattr(api, route.route_name)
+                router.route(
+                    method=http_method,
+                    url=compiled_url_pattern,
+                ).mock(
+                    side_effect=_make_respx_callback(
+                        handler=original_callback,
+                        base_path=base_path,
+                        delay_seconds=response_delay_seconds,
+                        sleep_fn=sleep_fn,
+                    ),
+                )
+
+    if real_http:
+        router.route().pass_through()
+    else:
+        router.route().mock(side_effect=_block_unmatched)
+
+    router.start()
+    return router