Skip to content

Backport PR #30426 on branch v3.10.x (Fix a race condition in TexManager.make_dvi.) #30430

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

Open
wants to merge 1 commit into
base: v3.10.x
Choose a base branch
from
+27 −26
Open

Backport PR #30426 on branch v3.10.x (Fix a race condition in TexManager.make_dvi.) #30430

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
53 changes: 27 additions & 26 deletions lib/matplotlib/texmanager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,11 +276,9 @@ def make_dvi(cls, tex, fontsize):

Return the file name.
"""
basefile = cls.get_basefile(tex, fontsize)
dvifile = '%s.dvi' % basefile
if not os.path.exists(dvifile):
texfile = Path(cls.make_tex(tex, fontsize))
# Generate the dvi in a temporary directory to avoid race
dvifile = Path(cls.get_basefile(tex, fontsize)).with_suffix(".dvi")
if not dvifile.exists():
# Generate the tex and dvi in a temporary directory to avoid race
# conditions e.g. if multiple processes try to process the same tex
# string at the same time. Having tmpdir be a subdirectory of the
# final output dir ensures that they are on the same filesystem,
Expand All @@ -289,15 +287,17 @@ def make_dvi(cls, tex, fontsize):
# the absolute path may contain characters (e.g. ~) that TeX does
# not support; n.b. relative paths cannot traverse parents, or it
# will be blocked when `openin_any = p` in texmf.cnf).
cwd = Path(dvifile).parent
with TemporaryDirectory(dir=cwd) as tmpdir:
tmppath = Path(tmpdir)
with TemporaryDirectory(dir=dvifile.parent) as tmpdir:
Path(tmpdir, "file.tex").write_text(
cls._get_tex_source(tex, fontsize), encoding='utf-8')
cls._run_checked_subprocess(
["latex", "-interaction=nonstopmode", "--halt-on-error",
f"--output-directory={tmppath.name}",
f"{texfile.name}"], tex, cwd=cwd)
(tmppath / Path(dvifile).name).replace(dvifile)
return dvifile
"file.tex"], tex, cwd=tmpdir)
Path(tmpdir, "file.dvi").replace(dvifile)
# Also move the tex source to the main cache directory, but
# only for backcompat.
Path(tmpdir, "file.tex").replace(dvifile.with_suffix(".tex"))
return str(dvifile)

@classmethod
def make_png(cls, tex, fontsize, dpi):
Expand All @@ -306,22 +306,23 @@ def make_png(cls, tex, fontsize, dpi):

Return the file name.
"""
basefile = cls.get_basefile(tex, fontsize, dpi)
pngfile = '%s.png' % basefile
pngfile = Path(cls.get_basefile(tex, fontsize)).with_suffix(".png")
# see get_rgba for a discussion of the background
if not os.path.exists(pngfile):
if not pngfile.exists():
dvifile = cls.make_dvi(tex, fontsize)
cmd = ["dvipng", "-bg", "Transparent", "-D", str(dpi),
"-T", "tight", "-o", pngfile, dvifile]
# When testing, disable FreeType rendering for reproducibility; but
# dvipng 1.16 has a bug (fixed in f3ff241) that breaks --freetype0
# mode, so for it we keep FreeType enabled; the image will be
# slightly off.
if (getattr(mpl, "_called_from_pytest", False) and
mpl._get_executable_info("dvipng").raw_version != "1.16"):
cmd.insert(1, "--freetype0")
cls._run_checked_subprocess(cmd, tex)
return pngfile
with TemporaryDirectory(dir=pngfile.parent) as tmpdir:
cmd = ["dvipng", "-bg", "Transparent", "-D", str(dpi),
"-T", "tight", "-o", "file.png", dvifile]
# When testing, disable FreeType rendering for reproducibility;
# but dvipng 1.16 has a bug (fixed in f3ff241) that breaks
# --freetype0 mode, so for it we keep FreeType enabled; the
# image will be slightly off.
if (getattr(mpl, "_called_from_pytest", False) and
mpl._get_executable_info("dvipng").raw_version != "1.16"):
cmd.insert(1, "--freetype0")
cls._run_checked_subprocess(cmd, tex, cwd=tmpdir)
Path(tmpdir, "file.png").replace(pngfile)
return str(pngfile)

@classmethod
def get_grey(cls, tex, fontsize=None, dpi=None):
Expand Down
Loading