Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Simplify tmpdir handling in backend_pgf. #18654

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 1 commit into from
Oct 7, 2020
Merged

Simplify tmpdir handling in backend_pgf. #18654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
96 changes: 31 additions & 65 deletions lib/matplotlib/backends/backend_pgf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import codecs
import datetime
import functools
from io import BytesIO
import logging
import math
import os
Expand All @@ -11,6 +12,7 @@
import subprocess
import sys
import tempfile
from tempfile import TemporaryDirectory
import weakref

from PIL import Image
Expand Down Expand Up @@ -866,18 +868,12 @@ def _print_pdf_to_fh(self, fh, *args, metadata=None, **kwargs):
hyperref_options = ','.join(
_metadata_to_str(k, v) for k, v in info_dict.items())

try:
# create temporary directory for compiling the figure
tmpdir = tempfile.mkdtemp(prefix="mpl_pgf_")
fname_pgf = os.path.join(tmpdir, "figure.pgf")
fname_tex = os.path.join(tmpdir, "figure.tex")
fname_pdf = os.path.join(tmpdir, "figure.pdf")
with TemporaryDirectory() as tmpdir:
tmppath = pathlib.Path(tmpdir)

# print figure to pgf and compile it with latex
self.print_pgf(fname_pgf, *args, **kwargs)
self.print_pgf(tmppath / "figure.pgf", *args, **kwargs)

latex_preamble = get_preamble()
latex_fontspec = get_fontspec()
latexcode = """
\\PassOptionsToPackage{pdfinfo={%s}}{hyperref}
\\RequirePackage{hyperref}
Expand All @@ -890,22 +886,16 @@ def _print_pdf_to_fh(self, fh, *args, metadata=None, **kwargs):
\\begin{document}
\\centering
\\input{figure.pgf}
\\end{document}""" % (hyperref_options, w, h, latex_preamble, latex_fontspec)
pathlib.Path(fname_tex).write_text(latexcode, encoding="utf-8")
\\end{document}""" % (hyperref_options, w, h, get_preamble(), get_fontspec())
(tmppath / "figure.tex").write_text(latexcode, encoding="utf-8")

texcommand = mpl.rcParams["pgf.texsystem"]
cbook._check_and_log_subprocess(
[texcommand, "-interaction=nonstopmode", "-halt-on-error",
"figure.tex"], _log, cwd=tmpdir)

# copy file contents to target
with open(fname_pdf, "rb") as fh_src:
shutil.copyfileobj(fh_src, fh)
finally:
try:
shutil.rmtree(tmpdir)
except:
TmpDirCleaner.add(tmpdir)
with (tmppath / "figure.pdf").open("rb") as fh_src:
shutil.copyfileobj(fh_src, fh) # copy file contents to target

def print_pdf(self, fname_or_fh, *args, **kwargs):
"""Use LaTeX to compile a Pgf generated figure to PDF."""
Expand All @@ -914,23 +904,14 @@ def print_pdf(self, fname_or_fh, *args, **kwargs):

def _print_png_to_fh(self, fh, *args, **kwargs):
converter = make_pdf_to_png_converter()

try:
# create temporary directory for pdf creation and png conversion
tmpdir = tempfile.mkdtemp(prefix="mpl_pgf_")
fname_pdf = os.path.join(tmpdir, "figure.pdf")
fname_png = os.path.join(tmpdir, "figure.png")
# create pdf and try to convert it to png
self.print_pdf(fname_pdf, *args, **kwargs)
converter(fname_pdf, fname_png, dpi=self.figure.dpi)
# copy file contents to target
with open(fname_png, "rb") as fh_src:
shutil.copyfileobj(fh_src, fh)
finally:
try:
shutil.rmtree(tmpdir)
except:
TmpDirCleaner.add(tmpdir)
with TemporaryDirectory() as tmpdir:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We seriously don't have even a smoketest for this method?

tmppath = pathlib.Path(tmpdir)
pdf_path = tmppath / "figure.pdf"
png_path = tmppath / "figure.png"
self.print_pdf(pdf_path, *args, **kwargs)
converter(pdf_path, png_path, dpi=self.figure.dpi)
with png_path.open("rb") as fh_src:
shutil.copyfileobj(fh_src, fh) # copy file contents to target

def print_png(self, fname_or_fh, *args, **kwargs):
"""Use LaTeX to compile a pgf figure to pdf and convert it to png."""
Expand Down Expand Up @@ -973,12 +954,8 @@ class PdfPages:
... pdf.savefig()
"""
__slots__ = (
'_outputfile',
'_output_name',
'keep_empty',
'_tmpdir',
'_basename',
'_fname_tex',
'_fname_pdf',
'_n_figures',
'_file',
'_info_dict',
Expand Down Expand Up @@ -1009,7 +986,7 @@ def __init__(self, filename, *, keep_empty=True, metadata=None):
'Trapped'. Values have been predefined for 'Creator', 'Producer'
and 'CreationDate'. They can be removed by setting them to `None`.
"""
self._outputfile = filename
self._output_name = filename
self._n_figures = 0
self.keep_empty = keep_empty
self._metadata = (metadata or {}).copy()
Expand All @@ -1027,13 +1004,7 @@ def __init__(self, filename, *, keep_empty=True, metadata=None):
f'set {canonical} instead of {key}.')
self._metadata[canonical] = self._metadata.pop(key)
self._info_dict = _create_pdf_info_dict('pgf', self._metadata)

# create temporary directory for compiling the figure
self._tmpdir = tempfile.mkdtemp(prefix="mpl_pgf_pdfpages_")
self._basename = 'pdf_pages'
self._fname_tex = os.path.join(self._tmpdir, self._basename + ".tex")
self._fname_pdf = os.path.join(self._tmpdir, self._basename + ".pdf")
self._file = open(self._fname_tex, 'wb')
self._file = BytesIO()

@cbook.deprecated('3.3')
@property
Expand Down Expand Up @@ -1085,27 +1056,22 @@ def close(self):
and moving the final pdf file to *filename*.
"""
self._file.write(rb'\end{document}\n')
self._file.close()

if self._n_figures > 0:
try:
self._run_latex()
finally:
try:
shutil.rmtree(self._tmpdir)
except:
TmpDirCleaner.add(self._tmpdir)
self._run_latex()
elif self.keep_empty:
open(self._outputfile, 'wb').close()
open(self._output_name, 'wb').close()
self._file.close()

def _run_latex(self):
texcommand = mpl.rcParams["pgf.texsystem"]
cbook._check_and_log_subprocess(
[texcommand, "-interaction=nonstopmode", "-halt-on-error",
os.path.basename(self._fname_tex)],
_log, cwd=self._tmpdir)
# copy file contents to target
shutil.copyfile(self._fname_pdf, self._outputfile)
with TemporaryDirectory() as tmpdir:
tex_source = pathlib.Path(tmpdir, "pdf_pages.tex")
tex_source.write_bytes(self._file.getvalue())
cbook._check_and_log_subprocess(
[texcommand, "-interaction=nonstopmode", "-halt-on-error",
tex_source],
_log, cwd=tmpdir)
shutil.move(tex_source.with_suffix(".pdf"), self._output_name)

def savefig(self, figure=None, **kwargs):
"""
Expand Down
7 changes: 7 additions & 0 deletions lib/matplotlib/tests/test_backend_pgf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,3 +321,10 @@ def test_bbox_inches_tight(tmpdir):
ax.imshow([[0, 1], [2, 3]])
fig.savefig(os.path.join(tmpdir, "test.pdf"), backend="pgf",
bbox_inches="tight")


@needs_xelatex
def test_png():
# Just a smoketest.
fig, ax = plt.subplots()
fig.savefig(BytesIO(), format="png", backend="pgf")