Skip to content

In imsave, let pnginfo have precedence over metadata. #15434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 19, 2019
Merged

In imsave, let pnginfo have precedence over metadata. #15434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9891e2
In imsave, let pnginfo have precedence over metadata.
anntzer Oct 17, 2019
9e9c5d1
Warn when pil_kwargs["pnginfo"] overrides metadata.
anntzer Oct 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions lib/matplotlib/backends/backend_agg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,10 +509,9 @@ def print_png(self, filename_or_obj, *args,

if metadata is None:
metadata = {}
metadata = {
default_metadata = {
"Software":
f"matplotlib version{__version__}, http://matplotlib.org/",
**metadata,
}

FigureCanvasAgg.draw(self)
Expand All @@ -521,9 +520,13 @@ def print_png(self, filename_or_obj, *args,
from PIL.PngImagePlugin import PngInfo
# Only use the metadata kwarg if pnginfo is not set, because the
# semantics of duplicate keys in pnginfo is unclear.
if "pnginfo" not in pil_kwargs:
if "pnginfo" in pil_kwargs:
if metadata:
cbook._warn_external("'metadata' is overridden by the "
"'pnginfo' entry in 'pil_kwargs'.")
else:
pnginfo = PngInfo()
for k, v in metadata.items():
for k, v in {**default_metadata, **metadata}.items():
pnginfo.add_text(k, v)
pil_kwargs["pnginfo"] = pnginfo
pil_kwargs.setdefault("dpi", (self.figure.dpi, self.figure.dpi))
Expand All @@ -533,8 +536,8 @@ def print_png(self, filename_or_obj, *args,
else:
renderer = self.get_renderer()
with cbook.open_file_cm(filename_or_obj, "wb") as fh:
_png.write_png(renderer._renderer, fh,
self.figure.dpi, metadata=metadata)
_png.write_png(renderer._renderer, fh, self.figure.dpi,
metadata={**default_metadata, **metadata})

def print_to_buffer(self):
FigureCanvasAgg.draw(self)
Expand Down
14 changes: 9 additions & 5 deletions lib/matplotlib/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1539,12 +1539,16 @@ def imsave(fname, arr, vmin=None, vmax=None, cmap=None, format=None,
pil_shape = (rgba.shape[1], rgba.shape[0])
image = Image.frombuffer(
"RGBA", pil_shape, rgba, "raw", "RGBA", 0, 1)
if format == "png" and metadata is not None:
if format == "png" and metadata:
# cf. backend_agg's print_png.
pnginfo = PngInfo()
for k, v in metadata.items():
pnginfo.add_text(k, v)
pil_kwargs["pnginfo"] = pnginfo
if "pnginfo" in pil_kwargs:
cbook._warn_external("'metadata' is overridden by the "
"'pnginfo' entry in 'pil_kwargs'.")
else:
pnginfo = PngInfo()
for k, v in metadata.items():
pnginfo.add_text(k, v)
pil_kwargs["pnginfo"] = pnginfo
if format in ["jpg", "jpeg"]:
format = "jpeg" # Pillow doesn't recognize "jpg".
color = tuple(
Expand Down