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

Ouverte
#10,567 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

  • #10570 par @lazerg — fermée sans fusion

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
1/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
python

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
14k
Forks
2.6k
Merge moyen
1 j 1 h
PR mergées (30 j)
205

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de python-pillow/Pillow

Toutes les issues de python-pillow/Pillow

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.