Skip to content

Imaging.writeImage ignores the requested PNM format and writes PPM - #556

Open
lenamonj wants to merge 1 commit into
apache:masterfrom
lenamonj:writeimage-format
Open

lenamonj wants to merge 1 commit into
apache:masterfrom
lenamonj:writeimage-format

Conversation

@lenamonj

@lenamonj lenamonj commented Sep 9, 2026

Copy link
Copy Markdown

Imaging.writeImage with ImageFormats.PBM, PGM or PAM writes a P6 PPM. PnmImageParser accepts all five PNM formats, but Imaging passed null parameters, so it always used the default writer. The format reached the parser as PARAM_KEY_FORMAT until IMAGING-159 (406f140, 1.0-alpha3) removed the parameter overloads.

Imaging.writeImage now calls a protected writeImageForFormat hook on AbstractImageParser; the base delegates to writeImage(src, os, null) and PnmImageParser overrides it to set the subtype. PNM keeps the transparency based default. Behaviour change: a transparent image requested as PBM, PGM or PPM now gets that format without its alpha instead of falling through to PAM.

The test fails on master with PBM ==> expected: <P4> but was: <P6>; the default Maven goal passes with 1260 tests.

  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute? Claude (Anthropic) found the defect and wrote the patch and the test; I reviewed them, reproduced the failure on a fresh clone of master, and ran the default Maven goal.
  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

PnmImageParser accepts PBM, PGM, PPM, PNM and PAM, but Imaging.writeImage passed null parameters, so every request took the default writer (PPM, or PAM for a transparent image). The format now reaches the parser through a writeImageForFormat hook that the base class ignores and PnmImageParser overrides.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant