python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-02-23 07:10:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Moved progress code into common private method

Browse Source
This commit is contained in:
Andrew Murray 2023-10-06 19:45:21 +11:00
parent b5f322831a
commit fe7c9d37c8
11 changed files with 103 additions and 226 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
Tests/test_file_apng.py
View File

@ -691,50 +691,26 @@ def test_save_all_progress():
out, "PNG", save_all=True, append_images=[im, im2], progress=callback out, "PNG", save_all=True, append_images=[im, im2], progress=callback
) )
assert progress == [ expected = []
{ for i in range(2):
"image_index": 0, expected.append(
"image_filename": "Tests/images/apng/single_frame.png", {
"completed_frames": 1, "image_index": i,
"total_frames": 7, "image_filename": "Tests/images/apng/single_frame.png",
}, "completed_frames": i + 1,
{ "total_frames": 7,
"image_index": 1, }
"image_filename": "Tests/images/apng/single_frame.png", )
"completed_frames": 2, for i in range(5):
"total_frames": 7, expected.append(
}, {
{ "image_index": 2,
"image_index": 2, "image_filename": "Tests/images/apng/delay.png",
"image_filename": "Tests/images/apng/delay.png", "completed_frames": i + 3,
"completed_frames": 3, "total_frames": 7,
"total_frames": 7, }
}, )
{ assert progress == expected
"image_index": 2,
"image_filename": "Tests/images/apng/delay.png",
"completed_frames": 4,
"total_frames": 7,
},
{
"image_index": 2,
"image_filename": "Tests/images/apng/delay.png",
"completed_frames": 5,
"total_frames": 7,
},
{
"image_index": 2,
"image_filename": "Tests/images/apng/delay.png",
"completed_frames": 6,
"total_frames": 7,
},
{
"image_index": 2,
"image_filename": "Tests/images/apng/delay.png",
"completed_frames": 7,
"total_frames": 7,
},
]
def test_seek_after_close(): def test_seek_after_close():

40
Tests/test_file_mpo.py
View File

@ -304,29 +304,17 @@ def test_save_all_progress():
with Image.open("Tests/images/frozenpond.mpo") as im2: with Image.open("Tests/images/frozenpond.mpo") as im2:
im.save(out, "MPO", save_all=True, append_images=[im2], progress=callback) im.save(out, "MPO", save_all=True, append_images=[im2], progress=callback)
assert progress == [ expected = []
{ for i, filename in enumerate(
"image_index": 0, ["Tests/images/sugarshack.mpo", "Tests/images/frozenpond.mpo"]
"image_filename": "Tests/images/sugarshack.mpo", ):
"completed_frames": 1, for j in range(2):
"total_frames": 4, expected.append(
}, {
{ "image_index": i,
"image_index": 0, "image_filename": filename,
"image_filename": "Tests/images/sugarshack.mpo", "completed_frames": i * 2 + j + 1,
"completed_frames": 2, "total_frames": 4,
"total_frames": 4, }
}, )
{ assert progress == expected
"image_index": 1,
"image_filename": "Tests/images/frozenpond.mpo",
"completed_frames": 3,
"total_frames": 4,
},
{
"image_index": 1,
"image_filename": "Tests/images/frozenpond.mpo",
"completed_frames": 4,
"total_frames": 4,
},
]

40
Tests/test_file_pdf.py
View File

@ -193,32 +193,20 @@ def test_save_all_progress():
with Image.open("Tests/images/frozenpond.mpo") as im2: with Image.open("Tests/images/frozenpond.mpo") as im2:
im.save(out, "PDF", save_all=True, append_images=[im2], progress=callback) im.save(out, "PDF", save_all=True, append_images=[im2], progress=callback)
assert progress == [ expected = []
{ for i, filename in enumerate(
"image_index": 0, ["Tests/images/sugarshack.mpo", "Tests/images/frozenpond.mpo"]
"image_filename": "Tests/images/sugarshack.mpo", ):
"completed_frames": 1, for j in range(2):
"total_frames": 4, expected.append(
}, {
{ "image_index": i,
"image_index": 0, "image_filename": filename,
"image_filename": "Tests/images/sugarshack.mpo", "completed_frames": i * 2 + j + 1,
"completed_frames": 2, "total_frames": 4,
"total_frames": 4, }
}, )
{ assert progress == expected
"image_index": 1,
"image_filename": "Tests/images/frozenpond.mpo",
"completed_frames": 3,
"total_frames": 4,
},
{
"image_index": 1,
"image_filename": "Tests/images/frozenpond.mpo",
"completed_frames": 4,
"total_frames": 4,
},
]
def test_multiframe_normal_save(tmp_path): def test_multiframe_normal_save(tmp_path):

32
Tests/test_file_tiff.py
View File

@ -714,32 +714,24 @@ class TestFileTiff:
out, "TIFF", save_all=True, append_images=[im2], progress=callback out, "TIFF", save_all=True, append_images=[im2], progress=callback
) )
assert progress == [ expected = [
{ {
"image_index": 0, "image_index": 0,
"image_filename": "Tests/images/hopper.tif", "image_filename": "Tests/images/hopper.tif",
"completed_frames": 1, "completed_frames": 1,
"total_frames": 4, "total_frames": 4,
}, }
{
"image_index": 1,
"image_filename": "Tests/images/multipage.tiff",
"completed_frames": 2,
"total_frames": 4,
},
{
"image_index": 1,
"image_filename": "Tests/images/multipage.tiff",
"completed_frames": 3,
"total_frames": 4,
},
{
"image_index": 1,
"image_filename": "Tests/images/multipage.tiff",
"completed_frames": 4,
"total_frames": 4,
},
] ]
for i in range(3):
expected.append(
{
"image_index": 1,
"image_filename": "Tests/images/multipage.tiff",
"completed_frames": i + 2,
"total_frames": 4,
}
)
assert progress == expected
def test_saving_icc_profile(self, tmp_path): def test_saving_icc_profile(self, tmp_path):
# Tests saving TIFF with icc_profile set. # Tests saving TIFF with icc_profile set.

24
src/PIL/GifImagePlugin.py
View File

@ -577,12 +577,12 @@ def _write_multiple_frames(im, fp, palette):
duration = im.encoderinfo.get("duration") duration = im.encoderinfo.get("duration")
disposal = im.encoderinfo.get("disposal", im.info.get("disposal")) disposal = im.encoderinfo.get("disposal", im.info.get("disposal"))
progress = im.encoderinfo.get("progress")
imSequences = [im] + list(im.encoderinfo.get("append_images", [])) imSequences = [im] + list(im.encoderinfo.get("append_images", []))
progress = im.encoderinfo.get("progress")
if progress: if progress:
n_frames = 0 total = 0
for imSequence in imSequences: for imSequence in imSequences:
n_frames += getattr(imSequence, "n_frames", 1) total += getattr(imSequence, "n_frames", 1)
im_frames = [] im_frames = []
frame_count = 0 frame_count = 0
@ -618,14 +618,7 @@ def _write_multiple_frames(im, fp, palette):
if encoderinfo.get("duration"): if encoderinfo.get("duration"):
previous["encoderinfo"]["duration"] += encoderinfo["duration"] previous["encoderinfo"]["duration"] += encoderinfo["duration"]
if progress: if progress:
progress( im._save_all_progress(imSequence, i, frame_count, total)
{
"image_index": i,
"image_filename": getattr(imSequence, "filename", None),
"completed_frames": frame_count,
"total_frames": n_frames,
}
)
continue continue
if encoderinfo.get("disposal") == 2: if encoderinfo.get("disposal") == 2:
if background_im is None: if background_im is None:
@ -640,14 +633,7 @@ def _write_multiple_frames(im, fp, palette):
bbox = None bbox = None
im_frames.append({"im": im_frame, "bbox": bbox, "encoderinfo": encoderinfo}) im_frames.append({"im": im_frame, "bbox": bbox, "encoderinfo": encoderinfo})
if progress: if progress:
progress( im._save_all_progress(imSequence, i, frame_count, total)
{
"image_index": i,
"image_filename": getattr(imSequence, "filename", None),
"completed_frames": frame_count,
"total_frames": n_frames,
}
)
if len(im_frames) > 1: if len(im_frames) > 1:
for frame_data in im_frames: for frame_data in im_frames:

17
src/PIL/Image.py
View File

@ -2446,6 +2446,23 @@ class Image:
if open_fp: if open_fp:
fp.close() fp.close()
def _save_all_progress(
self, im=None, im_index=0, completed=1, total=1, progress=None
):
if not progress:
progress = self.encoderinfo.get("progress")
if not progress:
return
progress(
{
"image_index": im_index,
"image_filename": getattr(im or self, "filename", None),
"completed_frames": completed,
"total_frames": total,
}
)
def seek(self, frame): def seek(self, frame):
""" """
Seeks to the given frame in this sequence file. If you seek Seeks to the given frame in this sequence file. If you seek

29
src/PIL/MpoImagePlugin.py
View File

@ -41,7 +41,6 @@ def _save(im, fp, filename):
def _save_all(im, fp, filename): def _save_all(im, fp, filename):
progress = im.encoderinfo.get("progress")
append_images = im.encoderinfo.get("append_images", []) append_images = im.encoderinfo.get("append_images", [])
if not append_images: if not append_images:
try: try:
@ -50,25 +49,18 @@ def _save_all(im, fp, filename):
animated = False animated = False
if not animated: if not animated:
_save(im, fp, filename) _save(im, fp, filename)
if progress: im._save_all_progress()
progress(
{
"image_index": 0,
"image_filename": getattr(im, "filename", None),
"completed_frames": 1,
"total_frames": 1,
}
)
return return
mpf_offset = 28 mpf_offset = 28
offsets = [] offsets = []
imSequences = [im] + list(append_images) imSequences = [im] + list(append_images)
progress = im.encoderinfo.get("progress")
if progress: if progress:
frame_number = 0 completed = 0
n_frames = 0 total = 0
for imSequence in imSequences: for imSequence in imSequences:
n_frames += getattr(imSequence, "n_frames", 1) total += getattr(imSequence, "n_frames", 1)
for i, imSequence in enumerate(imSequences): for i, imSequence in enumerate(imSequences):
for im_frame in ImageSequence.Iterator(imSequence): for im_frame in ImageSequence.Iterator(imSequence):
if not offsets: if not offsets:
@ -89,15 +81,8 @@ def _save_all(im, fp, filename):
im_frame.save(fp, "JPEG") im_frame.save(fp, "JPEG")
offsets.append(fp.tell() - offsets[-1]) offsets.append(fp.tell() - offsets[-1])
if progress: if progress:
frame_number += 1 completed += 1
progress( im._save_all_progress(imSequence, i, completed, total, progress)
{
"image_index": i,
"image_filename": getattr(imSequence, "filename", None),
"completed_frames": frame_number,
"total_frames": n_frames,
}
)
ifd = TiffImagePlugin.ImageFileDirectory_v2() ifd = TiffImagePlugin.ImageFileDirectory_v2()
ifd[0xB000] = b"0100" ifd[0xB000] = b"0100"

11
src/PIL/PdfImagePlugin.py
View File

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

22
src/PIL/PngImagePlugin.py
View File

@ -1098,9 +1098,9 @@ def _write_multiple_frames(im, fp, chunk, rawmode, default_image, append_images)
imSequences.append(im) imSequences.append(im)
imSequences += append_images imSequences += append_images
if progress: if progress:
n_frames = 0 total = 0
for imSequence in imSequences: for imSequence in imSequences:
n_frames += getattr(imSequence, "n_frames", 1) total += getattr(imSequence, "n_frames", 1)
im_frames = [] im_frames = []
frame_count = 0 frame_count = 0
@ -1155,14 +1155,7 @@ def _write_multiple_frames(im, fp, chunk, rawmode, default_image, append_images)
"duration", duration "duration", duration
) )
if progress: if progress:
progress( im._save_all_progress(imSequence, i, frame_count, total)
{
"image_index": i,
"image_filename": getattr(imSequence, "filename", None),
"completed_frames": frame_count,
"total_frames": n_frames,
}
)
continue continue
else: else:
bbox = None bbox = None
@ -1170,14 +1163,7 @@ def _write_multiple_frames(im, fp, chunk, rawmode, default_image, append_images)
encoderinfo["duration"] = duration encoderinfo["duration"] = duration
im_frames.append({"im": im_frame, "bbox": bbox, "encoderinfo": encoderinfo}) im_frames.append({"im": im_frame, "bbox": bbox, "encoderinfo": encoderinfo})
if progress: if progress:
progress( im._save_all_progress(imSequence, i, frame_count, total)
{
"image_index": i,
"image_filename": getattr(imSequence, "filename", None),
"completed_frames": frame_count,
"total_frames": n_frames,
}
)
# animation control # animation control
chunk( chunk(

29
src/PIL/TiffImagePlugin.py
View File

@ -2117,28 +2117,20 @@ class AppendingTiffWriter:
def _save_all(im, fp, filename): def _save_all(im, fp, filename):
encoderinfo = im.encoderinfo.copy() encoderinfo = im.encoderinfo.copy()
encoderconfig = im.encoderconfig encoderconfig = im.encoderconfig
progress = encoderinfo.get("progress")
append_images = list(encoderinfo.get("append_images", [])) append_images = list(encoderinfo.get("append_images", []))
if not hasattr(im, "n_frames") and not append_images: if not hasattr(im, "n_frames") and not append_images:
_save(im, fp, filename) _save(im, fp, filename)
if progress: im._save_all_progress()
progress(
{
"image_index": 0,
"image_filename": getattr(im, "filename", None),
"completed_frames": 1,
"total_frames": 1,
}
)
return return
cur_idx = im.tell() cur_idx = im.tell()
imSequences = [im] + append_images imSequences = [im] + append_images
progress = encoderinfo.get("progress")
if progress: if progress:
frame_number = 0 completed = 0
n_frames = 0 total = 0
for ims in imSequences: for ims in imSequences:
n_frames += getattr(ims, "n_frames", 1) total += getattr(ims, "n_frames", 1)
try: try:
with AppendingTiffWriter(fp) as tf: with AppendingTiffWriter(fp) as tf:
for i, ims in enumerate(imSequences): for i, ims in enumerate(imSequences):
@ -2154,15 +2146,8 @@ def _save_all(im, fp, filename):
ims.load() ims.load()
_save(ims, tf, filename) _save(ims, tf, filename)
if progress: if progress:
frame_number += 1 completed += 1
progress( im._save_all_progress(ims, i, completed, total)
{
"image_index": i,
"image_filename": getattr(ims, "filename", None),
"completed_frames": frame_number,
"total_frames": n_frames,
}
)
tf.newFrame() tf.newFrame()
finally: finally:

21
src/PIL/WebPImagePlugin.py
View File

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