"ImageEnhance (Color/Contrast/Brightness/Sharpness) .enhance(factor=NaN) silently returns an all-black image"

Offen
#10,567 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

  • #10570 von @lazerg — ohne Merge geschlossen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
1/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
python

Rechercherichtung

Read PIL/ImageEnhance.py at _Enhance.enhance, where all four enhancement classes share the call to Image.blend. Check the existing enhancement tests for the right place to cover a NaN factor across the classes. Done means the shared implementation rejects NaN while preserving the documented behavior for finite factors; pull request #10570 is already open for this issue.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Awaiting OP Action

enhance() blends the image with its degenerate version using factor;
a NaN factor poisons the blend, and every resulting byte casts back to
uint8 as 0. The result has the exact size and mode of the input - every
downstream check passes - but contains a single value, 0. No exception,
no warning. All four enhancement classes share the behavior (they share the same
base implementation):

import numpy as np
from PIL import Image, ImageEnhance

rs = np.random.RandomState(42)
img = Image.fromarray((np.stack([rs.rand(32, 32), rs.rand(32, 32), rs.rand(32, 32)],
                               axis=-1) * 255).astype(np.uint8))  # RGB, independent channels

for cls in (ImageEnhance.Color, ImageEnhance.Contrast,
            ImageEnhance.Brightness, ImageEnhance.Sharpness):
    out = np.asarray(cls(img).enhance(float("nan")))
    assert out.shape == (32, 32, 3) and np.all(out == 0)
    # uniform 0, unique values = 1, mode/size unchanged;
    # cls(img).enhance(1.0) still returns the original image

(An RGB input keeps the test uniform across all four classes. Side note:
on an L-mode input Color is inherently a no-op - its degenerate IS the
image object, and blending an image with itself returns a copy - so the
L-mode Color path is identity for every factor; the other three have
distinct degenerate images in every mode.)

Root cause (verified, Pillow 13.0.0 source)

PIL/ImageEnhance.py:25-39 - the shared base class:

class _Enhance:
    def enhance(self, factor: float) -> Image.Image:
        ...
        return Image.blend(self.degenerate, self.image, factor)

factor is passed to Image.blend unchecked; blend computes
im1 * (1 - factor) + im2 * factor per pixel, and with factor = NaN
every byte becomes NaN, casting to uint8 as 0. There is no NaN check at
any layer.

Scope note (why NaN only)

Per #7043, the documented contract is that the enhancement factor has
no range limits - large or negative finite factors are legitimate
and their outputs are the expected clamped/saturated blends (e.g.
factor=float("inf") gives a saturated two-value or all-255 result,
Brightness(-inf) clamps to black - consistent with blending toward an
extreme). NaN is not a factor value at all: it silently collapses the
image to a constant that no choice of finite factor produces on typical
inputs.

Impact

Factors are usually computed (new/old with old=0 producing NaN, or
parsed config values); one NaN silently blanks that image, and the
surrounding batch pipeline "succeeds" - shape, mode, and dtype all look
correct.

Suggested fix

Reject NaN in the shared implementation (covers all four classes at
once), leaving finite factors - of any magnitude or sign - untouched:

# PIL/ImageEnhance.py, _Enhance.enhance
if factor != factor:  # NaN check
    raise ValueError("factor must not be NaN")

Environment

  • Pillow 13.0.0, numpy 2.5.5, Python 3.12.16, macOS arm64 (aarch64)

Prior-art check (2026-11-20)

Related: #7043 (enhancement factor range discussion; maintainers state
factors are intentionally unbounded). No report found for the
NaN-factor all-black output. Re-search "ImageEnhance nan" on submission
day.

Vorherrschende Sprache
Python
Sterne
14k
Forks
2.6k
Ø Merge
1 T. 1 Std.
Gemergte PRs (30 T.)
205

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python-pillow/Pillow

Alle Issues in python-pillow/Pillow

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.