Repository navigation
PDFCLOUD-6569 Add passwords to image conversions- #52 - #53
Open
datalogics-tsmith wants to merge 3 commits into
Open
datalogics-tsmith wants to merge 3 commits into
datalogics-tsmith wants to merge 3 commits into
Conversation
✅ Deploy Preview for pdfrest-python ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
datalogics-kam
self-requested a review
October 15, 2026 16:59
- Accept open passwords for PNG, BMP, GIF, JPEG, and TIFF helpers - Serialize passwords through the shared sync and async payload contract - Cover request serialization and empty-password rejection Assisted-by: Codex
- Verify encrypted inputs across PNG, BMP, GIF, JPEG, and TIFF - Exercise correct passwords through synchronous and asynchronous clients - Confirm incorrect passwords return an API error Assisted-by: Codex
- Add a runnable protected-PDF-to-PNG workflow using an open password - Link the example from the inventory and API guide for discoverability Assisted-by: Codex
datalogics-tsmith
force-pushed
the
pdfcloud-6569-img-passwords
branch
from
October 16, 2026 18:17
a776995 to
f5837e0
Compare
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PDFCLOUD-6559
Why this change
The pdfRest image conversion routes accept an open password for encrypted PDFs, but the Python SDK did not expose that option. Users therefore could not convert password-protected PDFs through the typed BMP, GIF, JPEG, PNG, or TIFF helpers.
Prerequisite: PR #51 must be merged before this PR. This branch is stacked on the joboptions work from that PR.
What changed (high level)
The shared graphic payload now accepts an optional non-empty password, and all five synchronous and asynchronous image helpers pass it through to the service. Keeping the field on the shared payload gives every image format the same validation and serialization behavior.
The change also adds focused unit and live coverage, documents the option, and provides an end-to-end example that protects a PDF and then converts it to PNG.
Behavior changes
Callers can now pass
password=toconvert_to_bmp,convert_to_gif,convert_to_jpeg,convert_to_png, andconvert_to_tiff, including their asynchronous equivalents. Omitting the argument preserves existing behavior; an empty password is rejected locally before transport execution.This is a backward-compatible public API addition.
Validation
uv run pytest -n auto --maxschedchunk 2 -m 'not live'— 2,883 passed and 10 skippeduv run ruff format .uv run ruff check .uv run mkdocs build --strictuv buildRisks and follow-ups
The primary integration risk is merge ordering: PR #51 must land first because this branch contains its commits. After PR #51 merges, this PR should be refreshed against
mainso reviewers see only the image-password changes.The new argument is optional and uses the existing graphic payload and transport paths, so existing unencrypted conversion calls are unaffected.