Add progress callback when save_all is used

Tests/test_file_apng.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import os
 from io import BytesIO
 from pathlib import Path
 
@@ -727,6 +728,58 @@ def test_apng_save_blend(tmp_path: Path) -> None:
         assert im.getpixel((0, 0)) == (0, 255, 0, 255)
 
 
+def test_save_all_progress() -> None:
+    out = BytesIO()
+    progress = []
+
+    def callback(state: Image.Progress) -> None:
+        if state.image_filename:
+            state = state._replace(
+                image_filename=os.path.basename(state.image_filename)
+            )
+        progress.append(state)
+
+    Image.new("RGB", (1, 1)).save(out, "PNG", save_all=True, progress=callback)
+    assert progress == [
+        Image.Progress(
+            image_index=0,
+            image_filename=None,
+            completed_frames=1,
+            total_frames=1,
+        )
+    ]
+
+    out = BytesIO()
+    progress = []
+
+    with Image.open("Tests/images/apng/single_frame.png") as im:
+        with Image.open("Tests/images/apng/delay.png") as im2:
+            im.save(
+                out, "PNG", save_all=True, append_images=[im, im2], progress=callback
+            )
+
+    expected = []
+    for i in range(2):
+        expected.append(
+            Image.Progress(
+                image_index=i,
+                image_filename="single_frame.png",
+                completed_frames=i + 1,
+                total_frames=7,
+            )
+        )
+    for i in range(5):
+        expected.append(
+            Image.Progress(
+                image_index=2,
+                image_filename="delay.png",
+                completed_frames=i + 3,
+                total_frames=7,
+            )
+        )
+    assert progress == expected
+
+
 def test_apng_save_size(tmp_path: Path) -> None:
     test_file = tmp_path / "temp.png"
 

Tests/test_file_avif.py

@@ -216,6 +216,54 @@ def test_file_pointer_could_be_reused(self) -> None:
             with Image.open(blob) as im:
                 im.load()
 
+    def test_save_all_progress(self) -> None:
+        out = BytesIO()
+        progress = []
+
+        def callback(state: Image.Progress) -> None:
+            if state.image_filename:
+                state = state._replace(
+                    image_filename=os.path.basename(state.image_filename)
+                )
+            progress.append(state)
+
+        Image.new("RGB", (1, 1)).save(out, "AVIF", save_all=True, progress=callback)
+        assert progress == [
+            Image.Progress(
+                image_index=0,
+                image_filename=None,
+                completed_frames=1,
+                total_frames=1,
+            )
+        ]
+
+        out = BytesIO()
+        progress = []
+
+        with Image.open("Tests/images/avif/star.avifs") as im:
+            im2 = Image.new(im.mode, im.size)
+            im.save(out, "AVIF", save_all=True, append_images=[im2], progress=callback)
+
+        expected = []
+        for i in range(5):
+            expected.append(
+                Image.Progress(
+                    image_index=0,
+                    image_filename="star.avifs",
+                    completed_frames=i + 1,
+                    total_frames=6,
+                )
+            )
+        expected.append(
+            Image.Progress(
+                image_index=1,
+                image_filename=None,
+                completed_frames=6,
+                total_frames=6,
+            )
+        )
+        assert progress == expected
+
     def test_background_from_gif(self, tmp_path: Path) -> None:
         with Image.open("Tests/images/chi.gif") as im:
             original_value = im.convert("RGB").getpixel((1, 1))

Tests/test_file_gif.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import os
 import warnings
 from collections.abc import Generator
 from io import BytesIO
@@ -318,6 +319,54 @@ def test_save_zero(size: tuple[int, int]) -> None:
         im.save(b, "GIF")
 
 
+def test_save_all_progress() -> None:
+    out = BytesIO()
+    progress = []
+
+    def callback(state: Image.Progress) -> None:
+        if state.image_filename:
+            state = state._replace(
+                image_filename=os.path.basename(state.image_filename)
+            )
+        progress.append(state)
+
+    Image.new("RGB", (1, 1)).save(out, "GIF", save_all=True, progress=callback)
+    assert progress == [
+        Image.Progress(
+            image_index=0,
+            image_filename=None,
+            completed_frames=1,
+            total_frames=1,
+        )
+    ]
+
+    out = BytesIO()
+    progress = []
+
+    with Image.open("Tests/images/chi.gif") as im2:
+        im = Image.new("RGB", im2.size)
+        im.save(out, "GIF", save_all=True, append_images=[im2], progress=callback)
+
+    expected: list[Image.Progress] = [
+        Image.Progress(
+            image_index=0,
+            image_filename=None,
+            completed_frames=1,
+            total_frames=32,
+        )
+    ]
+    for i in range(31):
+        expected.append(
+            Image.Progress(
+                image_index=1,
+                image_filename="chi.gif",
+                completed_frames=i + 2,
+                total_frames=32,
+            )
+        )
+    assert progress == expected
+
+
 @pytest.mark.parametrize(
     "path, mode",
     (

Tests/test_file_mpo.py

@@ -319,6 +319,50 @@ def test_save_all() -> None:
     assert "mp" not in jpg.info
 
 
+def test_save_all_progress() -> None:
+    out = BytesIO()
+    progress = []
+
+    def callback(state: Image.Progress) -> None:
+        if state.image_filename:
+            state = state._replace(
+                image_filename=state.image_filename.replace("\\", "/").split(
+                    "Tests/images/"
+                )[-1]
+            )
+        progress.append(state)
+
+    Image.new("RGB", (1, 1)).save(out, "MPO", save_all=True, progress=callback)
+    assert progress == [
+        Image.Progress(
+            image_index=0,
+            image_filename=None,
+            completed_frames=1,
+            total_frames=1,
+        )
+    ]
+
+    out = BytesIO()
+    progress = []
+
+    with Image.open("Tests/images/sugarshack.mpo") as im:
+        with Image.open("Tests/images/frozenpond.mpo") as im2:
+            im.save(out, "MPO", save_all=True, append_images=[im2], progress=callback)
+
+    expected = []
+    for i, filename in enumerate(["sugarshack.mpo", "frozenpond.mpo"]):
+        for j in range(2):
+            expected.append(
+                Image.Progress(
+                    image_index=i,
+                    image_filename=filename,
+                    completed_frames=i * 2 + j + 1,
+                    total_frames=4,
+                )
+            )
+    assert progress == expected
+
+
 def test_save_xmp() -> None:
     im = Image.new("RGB", (1, 1))
     im2 = Image.new("RGB", (1, 1), "#f00")

Tests/test_file_pdf.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-import io
 import os
 import os.path
 import tempfile
 import time
 from collections.abc import Generator
+from io import BytesIO
 from pathlib import Path
 from typing import Any
 
@@ -179,6 +179,48 @@ def im_generator(ims: list[Image.Image]) -> Generator[Image.Image, None, None]:
     assert os.path.getsize(outfile) > 0
 
 
+def test_save_all_progress() -> None:
+    out = BytesIO()
+    progress = []
+
+    def callback(state: Image.Progress) -> None:
+        if state.image_filename:
+            state = state._replace(
+                image_filename=os.path.basename(state.image_filename)
+            )
+        progress.append(state)
+
+    Image.new("RGB", (1, 1)).save(out, "PDF", save_all=True, progress=callback)
+    assert progress == [
+        Image.Progress(
+            image_index=0,
+            image_filename=None,
+            completed_frames=1,
+            total_frames=1,
+        )
+    ]
+
+    out = BytesIO()
+    progress = []
+
+    with Image.open("Tests/images/sugarshack.mpo") as im:
+        with Image.open("Tests/images/frozenpond.mpo") as im2:
+            im.save(out, "PDF", save_all=True, append_images=[im2], progress=callback)
+
+    expected = []
+    for i, filename in enumerate(["sugarshack.mpo", "frozenpond.mpo"]):
+        for j in range(2):
+            expected.append(
+                Image.Progress(
+                    image_index=i,
+                    image_filename=filename,
+                    completed_frames=i * 2 + j + 1,
+                    total_frames=4,
+                )
+            )
+    assert progress == expected
+
+
 def test_multiframe_normal_save(tmp_path: Path) -> None:
     # Test saving a multiframe image without save_all
     with Image.open("Tests/images/dispose_bgnd.gif") as im:
@@ -334,12 +376,12 @@ def test_pdf_info(tmp_path: Path) -> None:
 
 def test_pdf_append_to_bytesio() -> None:
     im = hopper("RGB")
-    f = io.BytesIO()
+    f = BytesIO()
     im.save(f, format="PDF")
     initial_size = len(f.getvalue())
     assert initial_size > 0
     im = hopper("P")
-    f = io.BytesIO(f.getvalue())
+    f = BytesIO(f.getvalue())
     im.save(f, format="PDF", append=True)
     assert len(f.getvalue()) > initial_size
 

Tests/test_file_tiff.py

@@ -752,7 +752,7 @@ def test_palette(self, mode: str, tmp_path: Path) -> None:
         with Image.open(outfile) as reloaded:
             assert_image_equal(im.convert("RGB"), reloaded.convert("RGB"))
 
-    def test_tiff_save_all(self) -> None:
+    def test_save_all(self) -> None:
         mp = BytesIO()
         with Image.open("Tests/images/multipage.tiff") as im:
             im.save(mp, format="tiff", save_all=True)
@@ -785,6 +785,55 @@ def im_generator(ims: list[Image.Image]) -> Generator[Image.Image, None, None]:
             assert isinstance(reread, TiffImagePlugin.TiffImageFile)
             assert reread.n_frames == 3
 
+    def test_save_all_progress(self) -> None:
+        out = BytesIO()
+        progress = []
+
+        def callback(state: Image.Progress) -> None:
+            if state.image_filename:
+                state = state._replace(
+                    image_filename=os.path.basename(state.image_filename)
+                )
+            progress.append(state)
+
+        Image.new("RGB", (1, 1)).save(out, "TIFF", save_all=True, progress=callback)
+        assert progress == [
+            Image.Progress(
+                image_index=0,
+                image_filename=None,
+                completed_frames=1,
+                total_frames=1,
+            )
+        ]
+
+        out = BytesIO()
+        progress = []
+
+        with Image.open("Tests/images/hopper.tif") as im:
+            with Image.open("Tests/images/multipage.tiff") as im2:
+                im.save(
+                    out, "TIFF", save_all=True, append_images=[im2], progress=callback
+                )
+
+        expected = [
+            Image.Progress(
+                image_index=0,
+                image_filename="hopper.tif",
+                completed_frames=1,
+                total_frames=4,
+            )
+        ]
+        for i in range(3):
+            expected.append(
+                Image.Progress(
+                    image_index=1,
+                    image_filename="multipage.tiff",
+                    completed_frames=i + 2,
+                    total_frames=4,
+                )
+            )
+        assert progress == expected
+
     def test_fixoffsets(self) -> None:
         b = BytesIO(b"II\x2a\x00\x00\x00\x00\x00")
         with TiffImagePlugin.AppendingTiffWriter(b) as a: