Add VuMark generation support by adamtheturtle · Pull Request #2858 · VWS-Python/vws-python

adamtheturtle · 2026-02-18T23:29:04Z

Summary

Implement VuMark instance generation API with support for multiple image formats (PNG, SVG, PDF). Add InvalidAcceptHeaderError and InvalidInstanceIdError exceptions for proper error handling.

Changes

New VuMarkAccept enum with format options (PNG, SVG, PDF)
generate_vumark_instance method on VWS class for generating VuMark instances
Comprehensive test coverage for all formats
Updated documentation and dependencies

Test Plan

Tests verify all VuMark accept formats return bytes
Tests verify default PNG format behavior
Tests verify InvalidInstanceId error handling

🤖 Generated with Claude Code

Note

Medium Risk
Introduces a new API surface and adjusts core request/response handling to support binary responses and extra headers, which could affect multiple endpoints if misused. Test coverage helps, but reviewers should double-check header merging and the expected_result_code=None control flow.

Overview
Adds VuMark instance generation support via a new VuMarkService.generate_vumark_instance, backed by a VuMarkAccept enum (PNG/SVG/PDF) and exported from vws.__init__.

Extends the shared request/response plumbing to support binary success bodies (Response.content, extra_headers on _target_api_request/VWS.make_request, and expected_result_code=None for non-JSON OK responses), and introduces new Vuforia result-code exceptions (InvalidAcceptHeaderError, InvalidInstanceIdError, InvalidTargetTypeError, BadRequestError) plus a fix to target-id extraction for errors on nested paths.

Updates docs to include vws.vumark_accept, bumps vws-python-mock, adds spelling dictionary entry, and adds tests/fixtures validating format-specific bytes and new error cases.

^{Written by Cursor Bugbot for commit 5eb207d. This will update automatically on new commits. Configure here.}

Implement VuMark instance generation API with support for multiple image formats (PNG, SVG, PDF). Add InvalidAcceptHeaderError and InvalidInstanceIdError exceptions for proper error handling. Includes comprehensive tests for all VuMark formats. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

src/vws/vws.py

Add BadRequestError exception for the BadRequest result code returned by the VuMark endpoint when invalid JSON is sent. Map it in generate_vumark_instance and include it in the exception inheritance test. Bump vws-python-mock to 2026.2.18.2 which adds full VuMark auth endpoint testing support. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

Fix pylint wrong-spelling-in-comment (C0401) for the word 'enum' in the VuMark exception comments. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

Check magic bytes/prefix for each format (PNG, SVG, PDF) rather than just asserting non-empty bytes are returned. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

They are now referenced explicitly in the parametrized test. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Fix Sphinx spell checker failures for the result code names used in the new exception docstrings. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Replace single-quoted result code names with double backticks so the Sphinx spell checker treats them as inline code rather than words. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Adds extra_headers parameter to _target_api_request and content field to Response, allowing generate_vumark_instance to reuse shared auth/signing logic instead of duplicating it. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Centralises TooManyRequestsError and ServerError raising so callers (make_request, generate_vumark_instance) no longer duplicate the logic. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Adds extra_headers and optional expected_result_code (None = binary/HTTP-200 success) to make_request, and adds VuMark-specific result codes to its error dispatch dict, so generate_vumark_instance no longer needs to call _target_api_request directly. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Now that generate_vumark_instance uses make_request, _target_api_request can be a pure sign-and-send function again. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle · 2026-02-19T10:07:09Z

tests/test_vws.py

+        expected_prefix: bytes,
+    ) -> None:
+        """The returned bytes match the requested format."""
+        target_id = vws_client.add_target(


This isn't right. We should be (here and elsewhere) working with a VuMark target, not a cloud target.

See VWS-Python/vws-python-mock#2962 for enabling this.

See VWS-Python/vws-python-mock#2961 for getting the right error with this test.

- Fix target_id property extraction for /targets/{id}/instances URL pattern - Add InvalidTargetTypeError exception - Add vumark_vws_client and vumark_target_id fixtures using a pre-populated VuMark template target (requires vws-python-mock#2962) - Update tests to use VuMark target instead of a standard cloud target - Add test_invalid_target_type test (requires vws-python-mock#2961) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

VuMark generation targets a different database type (VuMark vs Cloud Reco), so it belongs in its own class rather than VWS, mirroring how CloudRecoService is separate from VWS. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

cursor · 2026-02-19T14:58:14Z

src/vws/vumark_service.py

+            "UnknownTarget": UnknownTargetError,
+        }[result_code]
+
+        raise exception(response=response)


Duplicated request/error handling in VuMarkService

Low Severity

VuMarkService.generate_vumark_instance directly calls _target_api_request and reimplements the entire error-handling pattern (rate-limit check, server-error check, result-code parsing, exception-dict lookup) that VWS.make_request already provides. The PR even modified VWS.make_request to accept expected_result_code=None and extra_headers, which were seemingly designed to support this exact use case, but VuMarkService doesn't use them. Extracting the error-code-to-exception mapping as a parameter would allow both classes to share the request/error plumbing.

adamtheturtle temporarily deployed to development February 18, 2026 23:29 — with GitHub Actions Inactive

cursor bot reviewed Feb 18, 2026

View reviewed changes

src/vws/vws.py Outdated Show resolved Hide resolved

adamtheturtle temporarily deployed to development February 18, 2026 23:34 — with GitHub Actions Inactive

Add 'enum' to spelling private dict

b4e4d23

Fix pylint wrong-spelling-in-comment (C0401) for the word 'enum' in the VuMark exception comments. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:03 — with GitHub Actions Inactive

Assert format-specific content in VuMark tests

5b2c7c7

Check magic bytes/prefix for each format (PNG, SVG, PDF) rather than just asserting non-empty bytes are returned. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:25 — with GitHub Actions Inactive

Remove default for accept parameter in generate_vumark_instance

5318e39

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:27 — with GitHub Actions Inactive

Remove now-unnecessary vulture ignore for SVG and PDF enum members

924a1d4

They are now referenced explicitly in the parametrized test. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:28 — with GitHub Actions Inactive

Add BadRequest, InvalidAcceptHeader, InvalidInstanceId to spelling dict

c41af76

Fix Sphinx spell checker failures for the result code names used in the new exception docstrings. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:29 — with GitHub Actions Inactive

Use double backticks for result codes in exception docstrings

e48dd8c

Replace single-quoted result code names with double backticks so the Sphinx spell checker treats them as inline code rather than words. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:31 — with GitHub Actions Inactive

adamtheturtle temporarily deployed to development February 19, 2026 09:37 — with GitHub Actions Inactive

Move 429/5xx handling into _target_api_request

939cd41

Centralises TooManyRequestsError and ServerError raising so callers (make_request, generate_vumark_instance) no longer duplicate the logic. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:40 — with GitHub Actions Inactive

adamtheturtle temporarily deployed to development February 19, 2026 09:46 — with GitHub Actions Inactive

Move 429/5xx handling back to make_request

9ee1439

Now that generate_vumark_instance uses make_request, _target_api_request can be a pure sign-and-send function again. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:48 — with GitHub Actions Inactive

Make extra_headers required in _target_api_request

7171df9

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

adamtheturtle temporarily deployed to development February 19, 2026 09:49 — with GitHub Actions Inactive

adamtheturtle commented Feb 19, 2026

View reviewed changes

adamtheturtle mentioned this pull request Feb 19, 2026

Add vws generate-vumark command VWS-Python/vws-cli#1968

Open

adamtheturtle temporarily deployed to development February 19, 2026 10:29 — with GitHub Actions Inactive

adamtheturtle deployed to development February 19, 2026 14:51 — with GitHub Actions Active

cursor bot reviewed Feb 19, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VuMark generation support#2858

Add VuMark generation support#2858
adamtheturtle wants to merge 15 commits intomainfrom
adamtheturtle/add-vumark-support

adamtheturtle commented Feb 18, 2026 •

edited by cursor bot

Loading

Uh oh!

Uh oh!

adamtheturtle Feb 19, 2026

Uh oh!

adamtheturtle Feb 19, 2026

Uh oh!

adamtheturtle Feb 19, 2026

Uh oh!

cursor bot left a comment

Uh oh!

cursor bot Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

Conversation

adamtheturtle commented Feb 18, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Test Plan

Uh oh!

Uh oh!

adamtheturtle Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

adamtheturtle Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

adamtheturtle Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Feb 19, 2026

Choose a reason for hiding this comment

Duplicated request/error handling in VuMarkService

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

adamtheturtle commented Feb 18, 2026 •

edited by cursor bot

Loading