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

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

@@ -4,6 +4,14 @@ Changelog
 Next
 ----
 
+2026.02.18.2
+------------
+
+
+2026.02.18.1
+------------
+
+
 2026.02.18
 ----------
 

{vws_python_mock-2026.2.18/src/vws_python_mock.egg-info → vws_python_mock-2026.2.18.2}/PKG-INFO

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

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/docs/source/differences-to-vws.rst

@@ -103,6 +103,13 @@ These are:
 
 When the given ``Content-Length`` header does not match the length of the given data, the mock server (written with Flask) will not behave as the real Vuforia Web Services behaves.
 
+VuMark instance images
+----------------------
+
+The mock returns a fixed minimal image in the requested format.
+The ``instance_id`` value is not encoded into the response image.
+Real Vuforia encodes the instance ID into the VuMark pattern.
+
 Header cases
 ------------
 

vws_python_mock-2026.2.18.2/docs/source/installation.rst

@@ -0,0 +1,34 @@
+Installation
+------------
+
+.. code-block:: console
+
+   $ pip install vws-python-mock
+
+This requires Python |minimum-python-version|\+.
+
+Faster installation
+~~~~~~~~~~~~~~~~~~~
+
+This package depends on `PyTorch`_, which pip installs from PyPI as a large CUDA-enabled build (~873 MB) even on CPU-only machines.
+To get a much smaller CPU-only build (~200 MB, no CUDA dependencies), install ``torch`` and ``torchvision`` from PyTorch's CPU index before installing this package:
+
+.. code-block:: console
+
+   $ pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
+   $ pip install vws-python-mock
+
+If you manage dependencies with ``uv``, add the following to your ``pyproject.toml`` instead:
+
+.. code-block:: toml
+
+   [[tool.uv.index]]
+   name = "pytorch-cpu"
+   url = "https://download.pytorch.org/whl/cpu"
+   explicit = true
+
+   [tool.uv.sources]
+   torch = { index = "pytorch-cpu" }
+   torchvision = { index = "pytorch-cpu" }
+
+.. _PyTorch: https://pytorch.org

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_constants.py

@@ -11,6 +11,21 @@ VUMARK_PNG = (
     b"\xaeB`\x82"
 )
 
+VUMARK_SVG = (
+    b'<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100"></svg>'
+)
+
+VUMARK_PDF = (
+    b"%PDF-1.4\n"
+    b"1 0 obj<</Type /Catalog /Pages 2 0 R>>endobj\n"
+    b"2 0 obj<</Type /Pages /Kids [3 0 R] /Count 1>>endobj\n"
+    b"3 0 obj<</Type /Page /MediaBox [0 0 100 100]>>endobj\n"
+    b"xref\n0 4\n"
+    b"0000000000 65535 f \n"
+    b"trailer<</Size 4/Root 1 0 R>>\n"
+    b"startxref\n9\n%%EOF"
+)
+
 
 @beartype
 @unique
@@ -45,6 +60,9 @@ class ResultCodes(Enum):
     PROJECT_INACTIVE = "ProjectInactive"
     INACTIVE_PROJECT = "InactiveProject"
     TOO_MANY_REQUESTS = "TooManyRequests"
+    INVALID_ACCEPT_HEADER = "InvalidAcceptHeader"
+    INVALID_INSTANCE_ID = "InvalidInstanceId"
+    BAD_REQUEST = "BadRequest"
 
 
 @beartype

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_flask_server/Dockerfile

@@ -1,24 +1,20 @@
-FROM python:3.13-slim AS base
+FROM ghcr.io/astral-sh/uv:0.10.4-python3.13-trixie-slim AS base
 # We set this pretend version as we do not have Git in our path, and we do
 # not care enough about having the version correct inside the Docker container
 # to install it.
 ENV SETUPTOOLS_SCM_PRETEND_VERSION=0.0.0
 # Avoid using root user.
-# This avoids having to use ``--root-user-action=ignore`` with pip.
 RUN useradd -ms /bin/bash myuser
 USER myuser
 COPY --chown=myuser:myuser . /app
 
 # See https://pythonspeed.com/articles/activate-virtualenv-dockerfile/
 # For why we use this method of activating the virtual environment.
-ENV VIRTUAL_ENV=/app/docker_venvs/.venv
 ENV UV_PROJECT_ENVIRONMENT=/app/docker_venvs/.venv
-ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+ENV PATH="$UV_PROJECT_ENVIRONMENT/bin:$PATH"
 
 WORKDIR /app
-RUN python3 -m venv $VIRTUAL_ENV && \
-    pip install --no-cache-dir uv==0.10.4 && \
-    uv sync --no-cache
+RUN uv sync --no-cache
 EXPOSE 5000
 ENTRYPOINT ["python"]
 HEALTHCHECK --interval=1s --timeout=10s --start-period=5s --retries=3 CMD ["python", "/app/src/mock_vws/_flask_server/healthcheck.py"]

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_flask_server/vws.py

@@ -18,12 +18,20 @@ from beartype import beartype
 from flask import Flask, Response, request
 from pydantic_settings import BaseSettings
 
-from mock_vws._constants import VUMARK_PNG, ResultCodes, TargetStatuses
+from mock_vws._constants import (
+    VUMARK_PDF,
+    VUMARK_PNG,
+    VUMARK_SVG,
+    ResultCodes,
+    TargetStatuses,
+)
 from mock_vws._database_matchers import get_database_matching_server_keys
 from mock_vws._mock_common import json_dump
 from mock_vws._services_validators import run_services_validators
 from mock_vws._services_validators.exceptions import (
     FailError,
+    InvalidAcceptHeaderError,
+    InvalidInstanceIdError,
     TargetStatusNotSuccessError,
     TargetStatusProcessingError,
     ValidatorError,
@@ -351,10 +359,27 @@ def generate_vumark_instance(target_id: str) -> Response:
     """
     # ``target_id`` is validated by request validators.
     del target_id
+
+    accept = request.headers.get(key="Accept", default="")
+    valid_accept_types: dict[str, bytes] = {
+        "image/png": VUMARK_PNG,
+        "image/svg+xml": VUMARK_SVG,
+        "application/pdf": VUMARK_PDF,
+    }
+    if accept not in valid_accept_types:
+        raise InvalidAcceptHeaderError
+
+    request_json = json.loads(s=request.data)
+    instance_id = request_json.get("instance_id", "")
+    if not instance_id:
+        raise InvalidInstanceIdError
+
+    response_body = valid_accept_types[accept]
+    content_type = accept
     date = email.utils.formatdate(timeval=None, localtime=False, usegmt=True)
     headers = {
         "Connection": "keep-alive",
-        "Content-Type": "image/png",
+        "Content-Type": content_type,
         "server": "envoy",
         "Date": date,
         "x-envoy-upstream-service-time": "5",
@@ -364,7 +389,7 @@ def generate_vumark_instance(target_id: str) -> Response:
     }
     return Response(
         status=HTTPStatus.OK,
-        response=VUMARK_PNG,
+        response=response_body,
         headers=headers,
     )
 

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_query_validators/image_validators.py

@@ -7,6 +7,7 @@ from email.message import EmailMessage
 
 from beartype import beartype
 from PIL import Image
+from werkzeug.datastructures import FileStorage, MultiDict
 from werkzeug.formparser import MultiPartParser
 
 from mock_vws._query_validators.exceptions import (
@@ -19,19 +20,19 @@ _LOGGER = logging.getLogger(name=__name__)
 
 
 @beartype
-def validate_image_field_given(
+def _parse_multipart_files(
     *,
     request_headers: Mapping[str, str],
     request_body: bytes,
-) -> None:
-    """Validate that the image field is given.
+) -> MultiDict[str, FileStorage]:
+    """Parse the multipart body and return the files section.
 
     Args:
         request_headers: The headers sent with the request.
         request_body: The body of the request.
 
-    Raises:
-        ImageNotGivenError: The image field is not given.
+    Returns:
+        The files parsed from the multipart body.
     """
     email_message = EmailMessage()
     email_message["Content-Type"] = request_headers["Content-Type"]
@@ -42,6 +43,28 @@ def validate_image_field_given(
         boundary=boundary.encode(encoding="utf-8"),
         content_length=len(request_body),
     )
+    return files
+
+
+@beartype
+def validate_image_field_given(
+    *,
+    request_headers: Mapping[str, str],
+    request_body: bytes,
+) -> None:
+    """Validate that the image field is given.
+
+    Args:
+        request_headers: The headers sent with the request.
+        request_body: The body of the request.
+
+    Raises:
+        ImageNotGivenError: The image field is not given.
+    """
+    files = _parse_multipart_files(
+        request_headers=request_headers,
+        request_body=request_body,
+    )
     if files.get(key="image") is not None:
         return
 
@@ -64,14 +87,9 @@ def validate_image_file_size(
     Raises:
         RequestEntityTooLargeError: The image file size is too large.
     """
-    email_message = EmailMessage()
-    email_message["Content-Type"] = request_headers["Content-Type"]
-    boundary = email_message.get_boundary(failobj="")
-    parser = MultiPartParser()
-    _, files = parser.parse(
-        stream=io.BytesIO(initial_bytes=request_body),
-        boundary=boundary.encode(encoding="utf-8"),
-        content_length=len(request_body),
+    files = _parse_multipart_files(
+        request_headers=request_headers,
+        request_body=request_body,
     )
     image_part = files["image"]
     image_value = image_part.stream.read()
@@ -105,14 +123,9 @@ def validate_image_dimensions(
         BadImageError: The image is given and is not within the maximum width
             and height limits.
     """
-    email_message = EmailMessage()
-    email_message["Content-Type"] = request_headers["Content-Type"]
-    boundary = email_message.get_boundary(failobj="")
-    parser = MultiPartParser()
-    _, files = parser.parse(
-        stream=io.BytesIO(initial_bytes=request_body),
-        boundary=boundary.encode(encoding="utf-8"),
-        content_length=len(request_body),
+    files = _parse_multipart_files(
+        request_headers=request_headers,
+        request_body=request_body,
     )
     image_part = files["image"]
     image_value = image_part.stream.read()
@@ -142,14 +155,9 @@ def validate_image_format(
     Raises:
         BadImageError: The image is given and is not either a PNG or a JPEG.
     """
-    email_message = EmailMessage()
-    email_message["Content-Type"] = request_headers["Content-Type"]
-    boundary = email_message.get_boundary(failobj="")
-    parser = MultiPartParser()
-    _, files = parser.parse(
-        stream=io.BytesIO(initial_bytes=request_body),
-        boundary=boundary.encode(encoding="utf-8"),
-        content_length=len(request_body),
+    files = _parse_multipart_files(
+        request_headers=request_headers,
+        request_body=request_body,
     )
     image_part = files["image"]
     pil_image = Image.open(fp=image_part.stream)
@@ -175,17 +183,11 @@ def validate_image_is_image(
     Raises:
         BadImageError: Image data is given and it is not an image file.
     """
-    email_message = EmailMessage()
-    email_message["Content-Type"] = request_headers["Content-Type"]
-    boundary = email_message.get_boundary(failobj="")
-    parser = MultiPartParser()
-    _, files = parser.parse(
-        stream=io.BytesIO(initial_bytes=request_body),
-        boundary=boundary.encode(encoding="utf-8"),
-        content_length=len(request_body),
+    files = _parse_multipart_files(
+        request_headers=request_headers,
+        request_body=request_body,
     )
-    image_part = files["image"]
-    image_file = image_part.stream
+    image_file = files["image"].stream
 
     try:
         Image.open(fp=image_file)

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_requests_mock_server/mock_web_services_api.py

@@ -18,12 +18,20 @@ from zoneinfo import ZoneInfo
 from beartype import BeartypeConf, beartype
 from requests.models import PreparedRequest
 
-from mock_vws._constants import VUMARK_PNG, ResultCodes, TargetStatuses
+from mock_vws._constants import (
+    VUMARK_PDF,
+    VUMARK_PNG,
+    VUMARK_SVG,
+    ResultCodes,
+    TargetStatuses,
+)
 from mock_vws._database_matchers import get_database_matching_server_keys
 from mock_vws._mock_common import Route, json_dump
 from mock_vws._services_validators import run_services_validators
 from mock_vws._services_validators.exceptions import (
     FailError,
+    InvalidAcceptHeaderError,
+    InvalidInstanceIdError,
     TargetStatusNotSuccessError,
     TargetStatusProcessingError,
     ValidatorError,
@@ -295,14 +303,33 @@ class MockVuforiaWebServicesAPI:
         self, request: PreparedRequest
     ) -> _ResponseType:
         """Generate a VuMark instance."""
-        run_services_validators(
-            request_headers=request.headers,
-            request_body=_body_bytes(request=request),
-            request_method=request.method or "",
-            request_path=request.path_url,
-            databases=self._target_manager.databases,
-        )
+        valid_accept_types: dict[str, bytes] = {
+            "image/png": VUMARK_PNG,
+            "image/svg+xml": VUMARK_SVG,
+            "application/pdf": VUMARK_PDF,
+        }
+        try:
+            run_services_validators(
+                request_headers=request.headers,
+                request_body=_body_bytes(request=request),
+                request_method=request.method or "",
+                request_path=request.path_url,
+                databases=self._target_manager.databases,
+            )
+
+            accept = dict(request.headers).get("Accept", "")
+            if accept not in valid_accept_types:
+                raise InvalidAcceptHeaderError
+
+            request_json = json.loads(s=_body_bytes(request=request))
+            instance_id = request_json.get("instance_id", "")
+            if not instance_id:
+                raise InvalidInstanceIdError
+        except ValidatorError as exc:
+            return exc.status_code, exc.headers, exc.response_text
 
+        response_body = valid_accept_types[accept]
+        content_type = accept
         date = email.utils.formatdate(
             timeval=None,
             localtime=False,
@@ -310,7 +337,7 @@ class MockVuforiaWebServicesAPI:
         )
         headers = {
             "Connection": "keep-alive",
-            "Content-Type": "image/png",
+            "Content-Type": content_type,
             "Date": date,
             "server": "envoy",
             "x-envoy-upstream-service-time": "5",
@@ -318,7 +345,7 @@ class MockVuforiaWebServicesAPI:
             "x-aws-region": "us-east-2, us-west-2",
             "x-content-type-options": "nosniff",
         }
-        return HTTPStatus.OK, headers, VUMARK_PNG
+        return HTTPStatus.OK, headers, response_body
 
     @route(path_pattern="/summary", http_methods={HTTPMethod.GET})
     def database_summary(self, request: PreparedRequest) -> _ResponseType:

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_services_validators/__init__.py

@@ -103,7 +103,7 @@ def run_services_validators(
     validate_date_format(request_headers=request_headers)
     validate_date_in_range(request_headers=request_headers)
 
-    validate_json(request_body=request_body)
+    validate_json(request_body=request_body, request_path=request_path)
 
     validate_keys(
         request_body=request_body,

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_services_validators/exceptions.py

@@ -184,6 +184,46 @@ class FailError(ValidatorError):
         }
 
 
+@beartype
+class BadRequestError(ValidatorError):
+    """Exception raised when Vuforia returns a response with a result code
+    'BadRequest'.
+    """
+
+    def __init__(self) -> None:
+        """
+        Attributes:
+            status_code: The status code to use in a response if this is
+                raised.
+            response_text: The response text to use in a response if this
+        is
+                raised.
+        """
+        super().__init__()
+        self.status_code = HTTPStatus.BAD_REQUEST
+        body = {
+            "transaction_id": uuid.uuid4().hex,
+            "result_code": ResultCodes.BAD_REQUEST.value,
+        }
+        self.response_text = json_dump(body=body)
+        date = email.utils.formatdate(
+            timeval=None,
+            localtime=False,
+            usegmt=True,
+        )
+        self.headers = {
+            "Connection": "keep-alive",
+            "Content-Type": "application/json",
+            "server": "envoy",
+            "Date": date,
+            "x-envoy-upstream-service-time": "5",
+            "Content-Length": str(object=len(self.response_text)),
+            "strict-transport-security": "max-age=31536000",
+            "x-aws-region": "us-east-2, us-west-2",
+            "x-content-type-options": "nosniff",
+        }
+
+
 @beartype
 class MetadataTooLargeError(ValidatorError):
     """Exception raised when Vuforia returns a response with a result code
@@ -530,6 +570,82 @@ class TargetStatusNotSuccessError(ValidatorError):
         }
 
 
+@beartype
+class InvalidAcceptHeaderError(ValidatorError):
+    """Exception raised when an unsupported Accept header is given."""
+
+    def __init__(self) -> None:
+        """
+        Attributes:
+            status_code: The status code to use in a response if this is
+                raised.
+            response_text: The response text to use in a response if this
+        is
+                raised.
+        """
+        super().__init__()
+        self.status_code = HTTPStatus.BAD_REQUEST
+        body = {
+            "transaction_id": uuid.uuid4().hex,
+            "result_code": ResultCodes.INVALID_ACCEPT_HEADER.value,
+        }
+        self.response_text = json_dump(body=body)
+        date = email.utils.formatdate(
+            timeval=None,
+            localtime=False,
+            usegmt=True,
+        )
+        self.headers = {
+            "Connection": "keep-alive",
+            "Content-Type": "application/json",
+            "server": "envoy",
+            "Date": date,
+            "x-envoy-upstream-service-time": "5",
+            "Content-Length": str(object=len(self.response_text)),
+            "strict-transport-security": "max-age=31536000",
+            "x-aws-region": "us-east-2, us-west-2",
+            "x-content-type-options": "nosniff",
+        }
+
+
+@beartype
+class InvalidInstanceIdError(ValidatorError):
+    """Exception raised when an invalid instance_id is given."""
+
+    def __init__(self) -> None:
+        """
+        Attributes:
+            status_code: The status code to use in a response if this is
+                raised.
+            response_text: The response text to use in a response if this
+        is
+                raised.
+        """
+        super().__init__()
+        self.status_code = HTTPStatus.UNPROCESSABLE_ENTITY
+        body = {
+            "transaction_id": uuid.uuid4().hex,
+            "result_code": ResultCodes.INVALID_INSTANCE_ID.value,
+        }
+        self.response_text = json_dump(body=body)
+        date = email.utils.formatdate(
+            timeval=None,
+            localtime=False,
+            usegmt=True,
+        )
+        self.headers = {
+            "Connection": "keep-alive",
+            "Content-Type": "application/json",
+            "server": "envoy",
+            "Date": date,
+            "x-envoy-upstream-service-time": "5",
+            "Content-Length": str(object=len(self.response_text)),
+            "strict-transport-security": "max-age=31536000",
+            "x-aws-region": "us-east-2, us-west-2",
+            "x-content-type-options": "nosniff",
+        }
+
+
 @beartype
 class TargetStatusProcessingError(ValidatorError):
     """Exception raised when trying to delete a target which is processing."""

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/src/mock_vws/_services_validators/json_validators.py

@@ -8,6 +8,7 @@ from json.decoder import JSONDecodeError
 from beartype import beartype
 
 from mock_vws._services_validators.exceptions import (
+    BadRequestError,
     FailError,
     UnnecessaryRequestBodyError,
 )
@@ -43,14 +44,18 @@ def validate_body_given(*, request_body: bytes, request_method: str) -> None:
 
 
 @beartype
-def validate_json(*, request_body: bytes) -> None:
+def validate_json(*, request_body: bytes, request_path: str) -> None:
     """Validate that any given body is valid JSON.
 
     Args:
         request_body: The body of the request.
+        request_path: The path of the request.
 
     Raises:
-        FailError: The request body includes invalid JSON.
+        BadRequestError: The request body includes invalid JSON for the
+            VuMark instance generation endpoint.
+        FailError: The request body includes invalid JSON for other
+            endpoints.
     """
     if not request_body:
         return
@@ -59,4 +64,6 @@ def validate_json(*, request_body: bytes) -> None:
         json.loads(s=request_body.decode())
     except JSONDecodeError as exc:
         _LOGGER.warning(msg="The request body is not valid JSON.")
+        if request_path.endswith("/instances"):
+            raise BadRequestError from exc
         raise FailError(status_code=HTTPStatus.BAD_REQUEST) from exc

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2/src/vws_python_mock.egg-info}/PKG-INFO

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

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/tests/conftest.py

@@ -85,6 +85,7 @@ def target_id(
         "target_summary",
         "update_target",
         "query",
+        "vumark_generate_instance",
     ],
 )
 def endpoint(request: pytest.FixtureRequest) -> Endpoint:

{vws_python_mock-2026.2.18 → vws_python_mock-2026.2.18.2}/tests/mock_vws/fixtures/credentials.py

@@ -42,7 +42,7 @@ class _VuMarkVuforiaDatabaseSettings(BaseSettings):
     target_manager_database_name: str
     server_access_key: str
     server_secret_key: str
-    target_id: str = "MockVuMarkTargetID00"
+    target_id: str
 
     model_config = SettingsConfigDict(
         env_prefix="VUMARK_VUFORIA_",