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

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

@@ -4,6 +4,18 @@ Changelog
 Next
 ----
 
+2026.02.22
+----------
+
+
+2026.02.21
+----------
+
+
+- Add ``VuMarkTarget`` class for VuMark template targets, alongside the renamed ``ImageTarget`` class (previously ``Target``).
+  ``ImageTarget`` is for image-based targets and ``VuMarkTarget`` is for VuMark template targets.
+  Both can be stored in a ``VuforiaDatabase``.
+
 2026.02.18.2
 ------------
 

{vws_python_mock-2026.2.18.2/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.18.2
+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,9 +84,9 @@ 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.17.1; extra == "dev"
+Requires-Dist: vws-web-tools==2026.2.20; extra == "dev"
 Requires-Dist: yamlfix==1.19.1; extra == "dev"
 Requires-Dist: zizmor==1.22.0; extra == "dev"
 Provides-Extra: release
@@ -119,11 +121,11 @@ This requires Python |minimum-python-version|\+.
     import requests
 
     from mock_vws import MockVWS
-    from mock_vws.database import VuforiaDatabase
+    from mock_vws.database import CloudDatabase
 
     with MockVWS() as mock:
-        database = VuforiaDatabase()
-        mock.add_database(database=database)
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 
@@ -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.18.2 → vws_python_mock-2026.2.22}/README.rst

@@ -26,11 +26,11 @@ This requires Python |minimum-python-version|\+.
     import requests
 
     from mock_vws import MockVWS
-    from mock_vws.database import VuforiaDatabase
+    from mock_vws.database import CloudDatabase
 
     with MockVWS() as mock:
-        database = VuforiaDatabase()
-        mock.add_database(database=database)
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 
@@ -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.18.2 → 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.18.2 → vws_python_mock-2026.2.22}/docs/source/basic-example.rst

@@ -7,11 +7,11 @@ Using the mock redirects requests to Vuforia made with `requests`_ to an in-memo
     import requests
 
     from mock_vws import MockVWS
-    from mock_vws.database import VuforiaDatabase
+    from mock_vws.database import CloudDatabase
 
     with MockVWS() as mock:
-        database = VuforiaDatabase()
-        mock.add_database(database=database)
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 

{vws_python_mock-2026.2.18.2 → vws_python_mock-2026.2.22}/docs/source/docker.rst

@@ -54,7 +54,7 @@ To mimic this functionality, this mock provides a target manager container which
 To add a database, make a request to the following endpoint against the target manager container:
 
 .. autoflask:: mock_vws._flask_server.target_manager:TARGET_MANAGER_FLASK_APP
-   :endpoints: create_database
+   :endpoints: create_cloud_database
 
 For example, with the containers set up as in :ref:`creating-containers`, use ``curl``:
 
@@ -63,7 +63,7 @@ For example, with the containers set up as in :ref:`creating-containers`, use ``
    $ curl --request POST \
        --header "Content-Type: application/json" \
        --data '{}' \
-       '127.0.0.1:5005/databases'
+       '127.0.0.1:5005/cloud_databases'
    {
        "client_access_key": "2d61c1d17bb94694bee77c1f1f41e5d9",
        "client_secret_key": "b73f8170cf7d42728fa8ce66221ad147",
@@ -80,7 +80,7 @@ Deleting a database
 To delete a database use the following endpoint:
 
 .. autoflask:: mock_vws._flask_server.target_manager:TARGET_MANAGER_FLASK_APP
-   :endpoints: delete_database
+   :endpoints: delete_cloud_database
 
 
 .. _Target Manager: https://developer.vuforia.com/target-manager

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.18.2 → 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.18.2 → vws_python_mock-2026.2.22}/docs/source/mock-api-reference.rst

@@ -7,24 +7,39 @@ API Reference
    :members:
    :undoc-members:
 
+.. autoclass:: mock_vws.MockVWSForHttpx
+   :members:
+   :undoc-members:
+
 .. autoclass:: mock_vws.MissingSchemeError
    :members:
    :undoc-members:
 
-.. Many parts of the VuforiaDatabase API are used for the Flask target
+.. Many parts of the CloudDatabase API are used for the Flask target
 .. database app, but Python users are not expected to use them.
 .. Therefore, they are not documented.
 
-.. autoclass:: mock_vws.database.VuforiaDatabase
+.. autoclass:: mock_vws.database.CloudDatabase
    :members:
    :undoc-members:
    :exclude-members: to_dict, get_target, from_dict, not_deleted_targets, active_targets, inactive_targets, failed_targets, processing_targets
 
+.. autoclass:: mock_vws.database.VuMarkDatabase
+   :members:
+   :undoc-members:
+   :exclude-members: to_dict, from_dict, not_deleted_targets
+
 .. autoenum:: mock_vws.states.States
    :members:
    :undoc-members:
 
-.. autoclass:: mock_vws.target.Target
+.. autoenum:: mock_vws.database_type.DatabaseType
+   :members:
+   :undoc-members:
+
+.. autoclass:: mock_vws.target.ImageTarget
+
+.. autoclass:: mock_vws.target.VuMarkTarget
 
 Image matchers
 --------------

{vws_python_mock-2026.2.18.2 → 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,9 +105,9 @@ 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.17.1",
+    "vws-web-tools==2026.2.20",
     "yamlfix==1.19.1",
     "zizmor==1.22.0",
 ]
@@ -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
@@ -450,8 +452,9 @@ ignore_names = [
     # pydantic-settings
     "model_config",
     # Used in TYPE_CHECKING for type hints
-    "DatabaseDict",
+    "CloudDatabaseDict",
     "VuMarkDatabaseDict",
+    "VuMarkTargetDict",
 ]
 # Duplicate some of .gitignore
 exclude = [ ".venv" ]

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

@@ -3,6 +3,7 @@ MPixel
 MiB
 MissingSchema
 Ubuntu
+VuMark
 admin
 another's
 api
@@ -44,6 +45,7 @@ hmac
 html
 http
 https
+httpx
 iff
 io
 issuecomment
@@ -97,6 +99,7 @@ reqjsonarr
 resheader
 resjson
 resjsonarr
+respx
 rfc
 rgb
 str

{vws_python_mock-2026.2.18.2 → 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.18.2 → vws_python_mock-2026.2.22}/src/mock_vws/_constants.py

@@ -63,6 +63,7 @@ class ResultCodes(Enum):
     INVALID_ACCEPT_HEADER = "InvalidAcceptHeader"
     INVALID_INSTANCE_ID = "InvalidInstanceId"
     BAD_REQUEST = "BadRequest"
+    INVALID_TARGET_TYPE = "InvalidTargetType"
 
 
 @beartype

{vws_python_mock-2026.2.18.2 → vws_python_mock-2026.2.22}/src/mock_vws/_database_matchers.py

@@ -5,7 +5,9 @@ from collections.abc import Iterable, Mapping
 from beartype import beartype
 from vws_auth_tools import authorization_header
 
-from mock_vws.database import VuforiaDatabase
+from mock_vws.database import CloudDatabase, VuMarkDatabase
+
+AnyDatabase = CloudDatabase | VuMarkDatabase
 
 
 @beartype
@@ -15,8 +17,8 @@ def get_database_matching_client_keys(
     request_body: bytes | None,
     request_method: str,
     request_path: str,
-    databases: Iterable[VuforiaDatabase],
-) -> VuforiaDatabase:
+    databases: Iterable[CloudDatabase],
+) -> CloudDatabase:
     """Return the first of the given databases which is being accessed by
     the
     given client request.
@@ -58,14 +60,14 @@ def get_database_matching_client_keys(
 
 
 @beartype
-def get_database_matching_server_keys(
+def get_database_matching_server_keys[DatabaseT: AnyDatabase](
     *,
     request_headers: Mapping[str, str],
     request_body: bytes | None,
     request_method: str,
     request_path: str,
-    databases: Iterable[VuforiaDatabase],
-) -> VuforiaDatabase:
+    databases: Iterable[DatabaseT],
+) -> DatabaseT:
     """Return the first of the given databases which is being accessed by
     the
     given server request.