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

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

@@ -4,6 +4,14 @@ Changelog
 Next
 ----
 
+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.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vws-python-mock
-Version: 2026.2.18.2
+Version: 2026.2.21
 Summary: A mock for the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License-Expression: MIT
@@ -84,7 +84,7 @@ 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-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 +119,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)
 

{vws_python_mock-2026.2.18.2 → vws_python_mock-2026.2.21}/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)
 

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

@@ -11,20 +11,31 @@ API Reference
    :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.21}/pyproject.toml

@@ -105,7 +105,7 @@ optional-dependencies.dev = [
     "vulture==2.14",
     "vws-python==2026.2.15",
     "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",
 ]
@@ -450,8 +450,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.21}/spelling_private_dict.txt

@@ -3,6 +3,7 @@ MPixel
 MiB
 MissingSchema
 Ubuntu
+VuMark
 admin
 another's
 api

{vws_python_mock-2026.2.18.2 → vws_python_mock-2026.2.21}/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.21}/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.

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

@@ -12,9 +12,10 @@ from beartype import beartype
 from flask import Flask, Response, request
 from pydantic_settings import BaseSettings
 
-from mock_vws.database import VuforiaDatabase
+from mock_vws.database import CloudDatabase, VuMarkDatabase
+from mock_vws.database_type import DatabaseType
 from mock_vws.states import States
-from mock_vws.target import Target
+from mock_vws.target import ImageTarget, VuMarkTarget
 from mock_vws.target_manager import TargetManager
 from mock_vws.target_raters import (
     BrisqueTargetTrackingRater,
@@ -58,82 +59,127 @@ class TargetManagerSettings(BaseSettings):
 
 
 @TARGET_MANAGER_FLASK_APP.route(
-    rule="/databases/<string:database_name>",
+    rule="/cloud_databases/<string:database_name>",
     methods=[HTTPMethod.DELETE],
 )
 @beartype
-def delete_database(database_name: str) -> Response:
-    """Delete a database.
+def delete_cloud_database(database_name: str) -> Response:
+    """Delete a cloud database.
 
-    :status 200: The database has been deleted.
+    :status 200: The cloud database has been deleted.
     """
     try:
         (matching_database,) = {
             database
-            for database in TARGET_MANAGER.databases
+            for database in TARGET_MANAGER.cloud_databases
             if database_name == database.database_name
         }
     except ValueError:
         return Response(response="", status=HTTPStatus.NOT_FOUND)
 
-    TARGET_MANAGER.remove_database(database=matching_database)
+    TARGET_MANAGER.remove_cloud_database(cloud_database=matching_database)
     return Response(response="", status=HTTPStatus.OK)
 
 
-@TARGET_MANAGER_FLASK_APP.route(rule="/databases", methods=[HTTPMethod.GET])
+@TARGET_MANAGER_FLASK_APP.route(
+    rule="/vumark_databases/<string:database_name>",
+    methods=[HTTPMethod.DELETE],
+)
+@beartype
+def delete_vumark_database(database_name: str) -> Response:
+    """Delete a VuMark database.
+
+    :status 200: The VuMark database has been deleted.
+    """
+    (matching_database,) = {
+        database
+        for database in TARGET_MANAGER.vumark_databases
+        if database_name == database.database_name
+    }
+    TARGET_MANAGER.remove_vumark_database(vumark_database=matching_database)
+    return Response(response="", status=HTTPStatus.OK)
+
+
+@TARGET_MANAGER_FLASK_APP.route(
+    rule="/cloud_databases", methods=[HTTPMethod.GET]
+)
 @beartype
-def get_databases() -> Response:
-    """Return a list of all databases."""
-    databases = [database.to_dict() for database in TARGET_MANAGER.databases]
+def get_cloud_databases() -> Response:
+    """Return a list of all cloud databases."""
+    databases = [
+        database.to_dict() for database in TARGET_MANAGER.cloud_databases
+    ]
     return Response(
         response=json.dumps(obj=databases),
         status=HTTPStatus.OK,
     )
 
 
-@TARGET_MANAGER_FLASK_APP.route(rule="/databases", methods=[HTTPMethod.POST])
+@TARGET_MANAGER_FLASK_APP.route(
+    rule="/vumark_databases",
+    methods=[HTTPMethod.GET],
+)
 @beartype
-def create_database() -> Response:
-    """Create a new database.
+def get_vumark_databases() -> Response:
+    """Return a list of all VuMark databases."""
+    databases = [
+        database.to_dict() for database in TARGET_MANAGER.vumark_databases
+    ]
+    return Response(
+        response=json.dumps(obj=databases),
+        status=HTTPStatus.OK,
+    )
+
+
+@TARGET_MANAGER_FLASK_APP.route(
+    rule="/cloud_databases", methods=[HTTPMethod.POST]
+)
+@beartype
+def create_cloud_database() -> Response:
+    """Create a new cloud database.
 
     :reqheader Content-Type: application/json
     :resheader Content-Type: application/json
 
     :reqjson string client_access_key: (Optional) The client access key for the
-      database.
+      cloud database.
 
     :reqjson string client_secret_key: (Optional) The client secret key for the
-      database.
+      cloud database.
 
-    :reqjson string database_name: (Optional) The name of the database.
+    :reqjson string database_name: (Optional) The name of the cloud database.
 
     :reqjson string server_access_key: (Optional) The server access key for the
-      database.
+      cloud database.
 
     :reqjson string server_secret_key: (Optional) The server secret key for the
-      database.
+      cloud database.
 
-    :reqjson string state_name: (Optional) The state of the database. This can
-     be "WORKING" or "PROJECT_INACTIVE". This defaults to "WORKING".
+    :reqjson string state_name: (Optional) The state of the cloud database.
+     This can be "WORKING" or "PROJECT_INACTIVE". This defaults to "WORKING".
 
-    :resjson string client_access_key: The client access key for the database.
+    :resjson string client_access_key: The client access key for the cloud
+      database.
 
-    :resjson string client_secret_key: The client secret key for the database.
+    :resjson string client_secret_key: The client secret key for the cloud
+      database.
 
-    :resjson string database_name: The database name.
+    :resjson string database_name: The cloud database name.
 
-    :resjson string server_access_key: The server access key for the database.
+    :resjson string server_access_key: The server access key for the cloud
+      database.
 
-    :resjson string server_secret_key: The server secret key for the database.
+    :resjson string server_secret_key: The server secret key for the cloud
+      database.
 
-    :resjson string state_name: The database state. This will be "WORKING" or
-      "PROJECT_INACTIVE".
+    :resjson string state_name: The cloud database state. This will be
+      "WORKING" or "PROJECT_INACTIVE".
 
-    :reqjsonarr targets: The targets in the database.
+    :reqjsonarr targets: The targets in the cloud database.
 
-    :status 201: The database has been successfully created.
+    :status 201: The cloud database has been successfully created.
     """
-    random_database = VuforiaDatabase()
+    random_database = CloudDatabase()
     request_json = json.loads(s=request.data)
     server_access_key = request_json.get(
         "server_access_key",
@@ -159,19 +205,66 @@ def create_database() -> Response:
         "state_name",
         random_database.state.name,
     )
+    database_type_name = request_json.get(
+        "database_type_name",
+        random_database.database_type.name,
+    )
 
     state = States[state_name]
+    database_type = DatabaseType[database_type_name]
 
-    database = VuforiaDatabase(
+    database = CloudDatabase(
         server_access_key=server_access_key,
         server_secret_key=server_secret_key,
         client_access_key=client_access_key,
         client_secret_key=client_secret_key,
         database_name=database_name,
         state=state,
+        database_type=database_type,
+    )
+    try:
+        TARGET_MANAGER.add_cloud_database(cloud_database=database)
+    except ValueError as exc:
+        return Response(
+            response=str(object=exc),
+            status=HTTPStatus.CONFLICT,
+        )
+
+    return Response(
+        response=json.dumps(obj=database.to_dict()),
+        status=HTTPStatus.CREATED,
+    )
+
+
+@TARGET_MANAGER_FLASK_APP.route(
+    rule="/vumark_databases",
+    methods=[HTTPMethod.POST],
+)
+@beartype
+def create_vumark_database() -> Response:
+    """Create a new VuMark database.
+
+    :status 201: The database has been successfully created.
+    """
+    request_json = json.loads(s=request.data)
+    random_vumark_database = VuMarkDatabase()
+    database = VuMarkDatabase(
+        server_access_key=request_json.get(
+            "server_access_key",
+            random_vumark_database.server_access_key,
+        ),
+        server_secret_key=request_json.get(
+            "server_secret_key",
+            random_vumark_database.server_secret_key,
+        ),
+        database_name=request_json.get(
+            "database_name",
+            random_vumark_database.database_name,
+        ),
     )
+
     try:
-        TARGET_MANAGER.add_database(database=database)
+        TARGET_MANAGER.add_vumark_database(vumark_database=database)
     except ValueError as exc:
         return Response(
             response=str(object=exc),
@@ -185,24 +278,23 @@ def create_database() -> Response:
 
 
 @TARGET_MANAGER_FLASK_APP.route(
-    rule="/databases/<string:database_name>/targets",
+    rule="/cloud_databases/<string:database_name>/targets",
     methods=[HTTPMethod.POST],
 )
 @beartype
 def create_target(database_name: str) -> Response:
-    """Create a new target in a given database."""
+    """Create a new target in a given cloud database."""
     (database,) = (
         database
-        for database in TARGET_MANAGER.databases
+        for database in TARGET_MANAGER.cloud_databases
         if database.database_name == database_name
     )
     request_json = json.loads(s=request.data)
-    image_base64 = request_json["image_base64"]
-    image_bytes = base64.b64decode(s=image_base64)
     settings = TargetManagerSettings.model_validate(obj={})
-    target_tracking_rater = settings.target_rater.to_target_rater()
 
-    target = Target(
+    image_bytes = base64.b64decode(s=request_json["image_base64"])
+    target_tracking_rater = settings.target_rater.to_target_rater()
+    target = ImageTarget(
         name=request_json["name"],
         width=request_json["width"],
         image_value=image_bytes,
@@ -221,7 +313,29 @@ def create_target(database_name: str) -> Response:
 
 
 @TARGET_MANAGER_FLASK_APP.route(
-    rule="/databases/<string:database_name>/targets/<string:target_id>",
+    rule="/vumark_databases/<string:database_name>/vumark_targets",
+    methods=[HTTPMethod.POST],
+)
+@beartype
+def create_vumark_target(database_name: str) -> Response:
+    """Create a new VuMark target in a given database."""
+    (database,) = (
+        database
+        for database in TARGET_MANAGER.vumark_databases
+        if database.database_name == database_name
+    )
+    request_json = json.loads(s=request.data)
+    target = VuMarkTarget.from_dict(target_dict=request_json)
+    database.vumark_targets.add(target)
+
+    return Response(
+        response=json.dumps(obj=target.to_dict()),
+        status=HTTPStatus.CREATED,
+    )
+
+
+@TARGET_MANAGER_FLASK_APP.route(
+    rule="/cloud_databases/<string:database_name>/targets/<string:target_id>",
     methods={HTTPMethod.DELETE},
 )
 @beartype
@@ -229,13 +343,13 @@ def delete_target(database_name: str, target_id: str) -> Response:
     """Delete a target."""
     (database,) = (
         database
-        for database in TARGET_MANAGER.databases
+        for database in TARGET_MANAGER.cloud_databases
         if database.database_name == database_name
     )
     target = database.get_target(target_id=target_id)
     now = datetime.datetime.now(tz=target.upload_date.tzinfo)
     # See https://github.com/facebook/pyrefly/issues/1897
-    new_target = copy.replace(
+    new_target: ImageTarget = copy.replace(
         target,  # pyrefly: ignore[bad-argument-type]
         delete_date=now,
     )
@@ -248,37 +362,35 @@ def delete_target(database_name: str, target_id: str) -> Response:
 
 
 @TARGET_MANAGER_FLASK_APP.route(
-    rule="/databases/<string:database_name>/targets/<string:target_id>",
+    rule="/cloud_databases/<string:database_name>/targets/<string:target_id>",
     methods=[HTTPMethod.PUT],
 )
 def update_target(database_name: str, target_id: str) -> Response:
     """Update a target."""
     (database,) = (
         database
-        for database in TARGET_MANAGER.databases
+        for database in TARGET_MANAGER.cloud_databases
         if database.database_name == database_name
     )
     target = database.get_target(target_id=target_id)
 
     request_json = json.loads(s=request.data)
-    width = request_json.get("width", target.width)
     name = request_json.get("name", target.name)
     active_flag = request_json.get("active_flag", target.active_flag)
+
+    gmt = ZoneInfo(key="GMT")
+    last_modified_date = datetime.datetime.now(tz=gmt)
+
+    width = request_json.get("width", target.width)
     application_metadata = request_json.get(
         "application_metadata",
         target.application_metadata,
     )
-
     image_value = target.image_value
-    request_json = json.loads(s=request.data)
     if "image" in request_json:
         image_value = base64.b64decode(s=request_json["image"])
-
-    gmt = ZoneInfo(key="GMT")
-    last_modified_date = datetime.datetime.now(tz=gmt)
-
     # See https://github.com/facebook/pyrefly/issues/1897
-    new_target = copy.replace(
+    new_target: ImageTarget = copy.replace(
         target,  # pyrefly: ignore[bad-argument-type]
         name=name,
         width=width,

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

@@ -21,7 +21,7 @@ from mock_vws._query_validators import run_query_validators
 from mock_vws._query_validators.exceptions import (
     ValidatorError,
 )
-from mock_vws.database import VuforiaDatabase
+from mock_vws.database import CloudDatabase
 from mock_vws.image_matchers import (
     ExactMatcher,
     ImageMatcher,
@@ -63,15 +63,15 @@ class VWQSettings(BaseSettings):
 
 
 @beartype
-def get_all_databases() -> set[VuforiaDatabase]:
+def get_all_cloud_databases() -> set[CloudDatabase]:
     """Get all database objects from the target manager back-end."""
     settings = VWQSettings.model_validate(obj={})
     response = requests.get(
-        url=f"{settings.target_manager_base_url}/databases",
+        url=f"{settings.target_manager_base_url}/cloud_databases",
         timeout=30,
     )
     return {
-        VuforiaDatabase.from_dict(database_dict=database_dict)
+        CloudDatabase.from_dict(database_dict=database_dict)
         for database_dict in response.json()
     }
 
@@ -132,7 +132,7 @@ def query() -> Response:
     settings = VWQSettings.model_validate(obj={})
     query_match_checker = settings.query_image_matcher.to_image_matcher()
 
-    databases = get_all_databases()
+    databases = get_all_cloud_databases()
     request_body = request.stream.read()
     run_query_validators(
         request_headers=dict(request.headers),