python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-03-24 20:14:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added progress callback when save_all is used

Browse Source
This commit is contained in:
Andrew Murray 2023-10-02 15:44:43 +11:00
parent aaa758751d
commit 6850465d54
12 changed files with 232 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Tests/test_file_apng.py
View File

@ -1,3 +1,5 @@
from io import BytesIO
import pytest
from PIL import Image, ImageSequence, PngImagePlugin
@ -663,6 +665,36 @@ def test_apng_save_blend(tmp_path):
assert im.getpixel((0, 0)) == (0, 255, 0, 255)
def test_save_all_progress():
out = BytesIO()
progress = []
def callback(filename, frame_number, n_frames):
progress.append((filename, frame_number, n_frames))
Image.new("RGB", (1, 1)).save(out, "PNG", save_all=True, progress=callback)
assert progress == [(None, 1, 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
)
assert progress == [
("Tests/images/apng/single_frame.png", 1, 7),
("Tests/images/apng/single_frame.png", 2, 7),
("Tests/images/apng/delay.png", 3, 7),
("Tests/images/apng/delay.png", 4, 7),
("Tests/images/apng/delay.png", 5, 7),
("Tests/images/apng/delay.png", 6, 7),
("Tests/images/apng/delay.png", 7, 7),
]
def test_seek_after_close():
im = Image.open("Tests/images/apng/delay.png")
im.seek(1)

23
Tests/test_file_gif.py
View File

@ -265,6 +265,29 @@ def test_roundtrip_save_all_1(tmp_path):
assert reloaded.getpixel((0, 0)) == 255
def test_save_all_progress():
out = BytesIO()
progress = []
def callback(filename, frame_number, n_frames):
progress.append((filename, frame_number, n_frames))
Image.new("RGB", (1, 1)).save(out, "GIF", save_all=True, progress=callback)
assert progress == [(None, 1, 1)]
out = BytesIO()
progress = []
with Image.open("Tests/images/hopper.gif") as im:
with Image.open("Tests/images/chi.gif") as im2:
im.save(out, "GIF", save_all=True, append_images=[im2], progress=callback)
expected = [("Tests/images/hopper.gif", 1, 32)]
for i in range(31):
expected.append(("Tests/images/chi.gif", i + 2, 32))
assert progress == expected
@pytest.mark.parametrize(
"path, mode",
(

25
Tests/test_file_mpo.py
View File

@ -278,3 +278,28 @@ def test_save_all():
# Test that a single frame image will not be saved as an MPO
jpg = roundtrip(im, save_all=True)
assert "mp" not in jpg.info
def test_save_all_progress():
out = BytesIO()
progress = []
def callback(filename, frame_number, n_frames):
progress.append((filename, frame_number, n_frames))
Image.new("RGB", (1, 1)).save(out, "MPO", save_all=True, progress=callback)
assert progress == [(None, 1, 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)
assert progress == [
("Tests/images/sugarshack.mpo", 1, 4),
("Tests/images/sugarshack.mpo", 2, 4),
("Tests/images/frozenpond.mpo", 3, 4),
("Tests/images/frozenpond.mpo", 4, 4),
]

31
Tests/test_file_pdf.py
View File

@ -1,8 +1,8 @@
import io
import os
import os.path
import tempfile
import time
from io import BytesIO
import pytest
@ -169,6 +169,31 @@ def test_save_all(tmp_path):
assert os.path.getsize(outfile) > 0
def test_save_all_progress():
out = BytesIO()
progress = []
def callback(filename, frame_number, n_frames):
progress.append((filename, frame_number, n_frames))
Image.new("RGB", (1, 1)).save(out, "PDF", save_all=True, progress=callback)
assert progress == [(None, 1, 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)
assert progress == [
("Tests/images/sugarshack.mpo", 1, 4),
("Tests/images/sugarshack.mpo", 2, 4),
("Tests/images/frozenpond.mpo", 3, 4),
("Tests/images/frozenpond.mpo", 4, 4),
]
def test_multiframe_normal_save(tmp_path):
# Test saving a multiframe image without save_all
with Image.open("Tests/images/dispose_bgnd.gif") as im:
@ -323,12 +348,12 @@ def test_pdf_info(tmp_path):
def test_pdf_append_to_bytesio():
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

28
Tests/test_file_tiff.py
View File

@ -658,7 +658,7 @@ class TestFileTiff:
with Image.open(outfile) as reloaded:
assert_image_equal(im.convert("RGB"), reloaded.convert("RGB"))
def test_tiff_save_all(self):
def test_save_all(self):
mp = BytesIO()
with Image.open("Tests/images/multipage.tiff") as im:
im.save(mp, format="tiff", save_all=True)
@ -688,6 +688,32 @@ class TestFileTiff:
with Image.open(mp) as reread:
assert reread.n_frames == 3
def test_save_all_progress(self):
out = BytesIO()
progress = []
def callback(filename, frame_number, n_frames):
progress.append((filename, frame_number, n_frames))
Image.new("RGB", (1, 1)).save(out, "TIFF", save_all=True, progress=callback)
assert progress == [(None, 1, 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
)
assert progress == [
("Tests/images/hopper.tif", 1, 4),
("Tests/images/multipage.tiff", 2, 4),
("Tests/images/multipage.tiff", 3, 4),
("Tests/images/multipage.tiff", 4, 4),
]
def test_saving_icc_profile(self, tmp_path):
# Tests saving TIFF with icc_profile set.
# At the time of writing this will only work for non-compressed tiffs

30
Tests/test_file_webp.py
View File

@ -1,7 +1,7 @@
import io
import re
import sys
import warnings
from io import BytesIO
import pytest
@ -102,10 +102,10 @@ class TestFileWebp:
def test_write_method(self, tmp_path):
self._roundtrip(tmp_path, self.rgb_mode, 12.0, {"method": 6})
buffer_no_args = io.BytesIO()
buffer_no_args = BytesIO()
hopper().save(buffer_no_args, format="WEBP")
buffer_method = io.BytesIO()
buffer_method = BytesIO()
hopper().save(buffer_method, format="WEBP", method=6)
assert buffer_no_args.getbuffer() != buffer_method.getbuffer()
@ -122,6 +122,30 @@ class TestFileWebp:
reloaded.seek(1)
assert_image_similar(im2, reloaded, 1)
@skip_unless_feature("webp_anim")
def test_save_all_progress(self):
out = BytesIO()
progress = []
def callback(filename, frame_number, n_frames):
progress.append((filename, frame_number, n_frames))
Image.new("RGB", (1, 1)).save(out, "WEBP", save_all=True, progress=callback)
assert progress == [(None, 1, 1)]
out = BytesIO()
progress = []
with Image.open("Tests/images/iss634.webp") as im:
im2 = Image.new("RGB", im.size)
im.save(out, "WEBP", save_all=True, append_images=[im2], progress=callback)
expected = []
for i in range(42):
expected.append(("Tests/images/iss634.webp", i + 1, 43))
expected.append((None, 43, 43))
assert progress == expected
def test_icc_profile(self, tmp_path):
self._roundtrip(tmp_path, self.rgb_mode, 12.5, {"icc_profile": None})
if _webp.HAVE_WEBPANIM:

16
src/PIL/GifImagePlugin.py
View File

@ -24,7 +24,6 @@
# See the README file for information on usage and redistribution.
#
import itertools
import math
import os
import subprocess
@ -578,10 +577,17 @@ def _write_multiple_frames(im, fp, palette):
duration = im.encoderinfo.get("duration")
disposal = im.encoderinfo.get("disposal", im.info.get("disposal"))
progress = im.encoderinfo.get("progress")
imSequences = [im] + list(im.encoderinfo.get("append_images", []))
if progress:
n_frames = 0
for imSequence in imSequences:
n_frames += getattr(imSequence, "n_frames", 1)
im_frames = []
frame_count = 0
background_im = None
for imSequence in itertools.chain([im], im.encoderinfo.get("append_images", [])):
for imSequence in imSequences:
for im_frame in ImageSequence.Iterator(imSequence):
# a copy is required here since seek can still mutate the image
im_frame = _normalize_mode(im_frame.copy())
@ -611,6 +617,10 @@ def _write_multiple_frames(im, fp, palette):
# This frame is identical to the previous frame
if encoderinfo.get("duration"):
previous["encoderinfo"]["duration"] += encoderinfo["duration"]
if progress:
progress(
getattr(imSequence, "filename", None), frame_count, n_frames
)
continue
if encoderinfo.get("disposal") == 2:
if background_im is None:
@ -624,6 +634,8 @@ def _write_multiple_frames(im, fp, palette):
else:
bbox = None
im_frames.append({"im": im_frame, "bbox": bbox, "encoderinfo": encoderinfo})
if progress:
progress(getattr(imSequence, "filename", None), frame_count, n_frames)
if len(im_frames) > 1:
for frame_data in im_frames:

15
src/PIL/MpoImagePlugin.py
View File

@ -18,7 +18,6 @@
# See the README file for information on usage and redistribution.
#
import itertools
import os
import struct
@ -42,6 +41,7 @@ def _save(im, fp, filename):
def _save_all(im, fp, filename):
progress = im.encoderinfo.get("progress")
append_images = im.encoderinfo.get("append_images", [])
if not append_images:
try:
@ -50,11 +50,19 @@ def _save_all(im, fp, filename):
animated = False
if not animated:
_save(im, fp, filename)
if progress:
progress(getattr(im, "filename", None), 1, 1)
return
mpf_offset = 28
offsets = []
for imSequence in itertools.chain([im], append_images):
imSequences = [im] + list(append_images)
if progress:
frame_number = 0
n_frames = 0
for imSequence in imSequences:
n_frames += getattr(imSequence, "n_frames", 1)
for imSequence in imSequences:
for im_frame in ImageSequence.Iterator(imSequence):
if not offsets:
# APP2 marker
@ -73,6 +81,9 @@ def _save_all(im, fp, filename):
else:
im_frame.save(fp, "JPEG")
offsets.append(fp.tell() - offsets[-1])
if progress:
frame_number += 1
progress(getattr(imSequence, "filename", None), frame_number, n_frames)
ifd = TiffImagePlugin.ImageFileDirectory_v2()
ifd[0xB000] = b"0100"

5
src/PIL/PdfImagePlugin.py
View File

@ -246,6 +246,7 @@ def _save(im, fp, filename, save_all=False):
# catalog and list of pages
existing_pdf.write_catalog()
progress = im.encoderinfo.get("progress")
page_number = 0
for im_sequence in ims:
im_pages = ImageSequence.Iterator(im_sequence) if save_all else [im_sequence]
@ -281,6 +282,10 @@ def _save(im, fp, filename, save_all=False):
existing_pdf.write_obj(contents_refs[page_number], stream=page_contents)
page_number += 1
if progress:
progress(
getattr(im_sequence, "filename", None), page_number, number_of_pages
)
#
# trailer

23
src/PIL/PngImagePlugin.py
View File

@ -1091,16 +1091,21 @@ def _write_multiple_frames(im, fp, chunk, rawmode, default_image, append_images)
loop = im.encoderinfo.get("loop", im.info.get("loop", 0))
disposal = im.encoderinfo.get("disposal", im.info.get("disposal", Disposal.OP_NONE))
blend = im.encoderinfo.get("blend", im.info.get("blend", Blend.OP_SOURCE))
progress = im.encoderinfo.get("progress")
if default_image:
chain = itertools.chain(append_images)
else:
chain = itertools.chain([im], append_images)
imSequences = []
if not default_image:
imSequences.append(im)
imSequences += append_images
if progress:
n_frames = 0
for imSequence in imSequences:
n_frames += getattr(imSequence, "n_frames", 1)
im_frames = []
frame_count = 0
for im_seq in chain:
for im_frame in ImageSequence.Iterator(im_seq):
for imSequence in imSequences:
for im_frame in ImageSequence.Iterator(imSequence):
if im_frame.mode == rawmode:
im_frame = im_frame.copy()
else:
@ -1149,12 +1154,18 @@ def _write_multiple_frames(im, fp, chunk, rawmode, default_image, append_images)
previous["encoderinfo"]["duration"] += encoderinfo.get(
"duration", duration
)
if progress:
progress(
getattr(imSequence, "filename", None), frame_count, n_frames
)
continue
else:
bbox = None
if "duration" not in encoderinfo:
encoderinfo["duration"] = duration
im_frames.append({"im": im_frame, "bbox": bbox, "encoderinfo": encoderinfo})
if progress:
progress(getattr(imSequence, "filename", None), frame_count, n_frames)
# animation control
chunk(

18
src/PIL/TiffImagePlugin.py
View File

@ -2117,14 +2117,24 @@ class AppendingTiffWriter:
def _save_all(im, fp, filename):
encoderinfo = im.encoderinfo.copy()
encoderconfig = im.encoderconfig
progress = encoderinfo.get("progress")
append_images = list(encoderinfo.get("append_images", []))
if not hasattr(im, "n_frames") and not append_images:
return _save(im, fp, filename)
_save(im, fp, filename)
if progress:
progress(getattr(im, "filename", None), 1, 1)
return
cur_idx = im.tell()
imSequences = [im] + append_images
if progress:
frame_number = 0
n_frames = 0
for ims in imSequences:
n_frames += getattr(ims, "n_frames", 1)
try:
with AppendingTiffWriter(fp) as tf:
for ims in [im] + append_images:
for ims in imSequences:
ims.encoderinfo = encoderinfo
ims.encoderconfig = encoderconfig
if not hasattr(ims, "n_frames"):
@ -2136,6 +2146,10 @@ def _save_all(im, fp, filename):
ims.seek(idx)
ims.load()
_save(ims, tf, filename)
if progress:
frame_number += 1
progress(getattr(ims, "filename", None), frame_number, n_frames)
tf.newFrame()
finally:
im.seek(cur_idx)

5
src/PIL/WebPImagePlugin.py
View File

@ -177,6 +177,7 @@ class WebPImageFile(ImageFile.ImageFile):
def _save_all(im, fp, filename):
encoderinfo = im.encoderinfo.copy()
progress = encoderinfo.get("progress")
append_images = list(encoderinfo.get("append_images", []))
# If total frame count is 1, then save using the legacy API, which
@ -186,6 +187,8 @@ def _save_all(im, fp, filename):
total += getattr(ims, "n_frames", 1)
if total == 1:
_save(im, fp, filename)
if progress:
progress(getattr(im, "filename", None), 1, 1)
return
background = (0, 0, 0, 0)
@ -300,6 +303,8 @@ def _save_all(im, fp, filename):
else:
timestamp += duration
frame_idx += 1
if progress:
progress(getattr(ims, "filename", None), frame_idx, total)
finally:
im.seek(cur_idx)