Merge pull request #7891 from radarhere/kmeans

Raise ValueError if kmeans is negative

Author: mergify[bot]

Tests/test_image_quantize.py

@@ -94,6 +94,19 @@ def test_quantize_dither_diff() -> None:
     assert dither.tobytes() != nodither.tobytes()
 
 
+@pytest.mark.parametrize(
+    "method", (Image.Quantize.MEDIANCUT, Image.Quantize.MAXCOVERAGE)
+)
+def test_quantize_kmeans(method) -> None:
+    im = hopper()
+    no_kmeans = im.quantize(kmeans=0, method=method)
+    kmeans = im.quantize(kmeans=1, method=method)
+    assert kmeans.tobytes() != no_kmeans.tobytes()
+
+    with pytest.raises(ValueError):
+        im.quantize(kmeans=-1, method=method)
+
+
 def test_colors() -> None:
     im = hopper()
     colors = 2

src/PIL/Image.py

@@ -1141,7 +1141,7 @@ def quantize(
                        The exception to this is RGBA images. :data:`Quantize.MEDIANCUT`
                        and :data:`Quantize.MAXCOVERAGE` do not support RGBA images, so
                        :data:`Quantize.FASTOCTREE` is used by default instead.
-        :param kmeans: Integer
+        :param kmeans: Integer greater than or equal to zero.
         :param palette: Quantize to the palette of given
                         :py:class:`PIL.Image.Image`.
         :param dither: Dithering method, used when converting from
@@ -1184,6 +1184,10 @@ def quantize(
             new_im.palette = palette.palette.copy()
             return new_im
 
+        if kmeans < 0:
+            msg = "kmeans must not be negative"
+            raise ValueError(msg)
+
         im = self._new(self.im.quantize(colors, method, kmeans))
 
         from . import ImagePalette

src/libImaging/Quant.c

@@ -1471,7 +1471,7 @@ quantize(
     fflush(stdout);
     timer = clock();
 #endif
-    if (kmeans) {
+    if (kmeans > 0) {
         k_means(pixelData, nPixels, p, nPaletteEntries, qp, kmeans - 1);
     }
 #ifndef NO_OUTPUT
@@ -1627,7 +1627,7 @@ quantize2(
             pixelData, nPixels, p, nQuantPixels, avgDist, avgDistSortKey, qp)) {
         goto error_4;
     }
-    if (kmeans) {
+    if (kmeans > 0) {
         k_means(pixelData, nPixels, p, nQuantPixels, qp, kmeans - 1);
     }