Merge pull request #8753 from anntzer/tex-version-search

QuLogic · web-flow · commit 12a0085dc074 · 2017-06-30T01:28:48.000-04:00
Remove tex version check; require dvipng &gt;=1.6
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -122,7 +122,7 @@
 # definitions, so it is safe to import from it here.
 from . import cbook
 from matplotlib.cbook import (
-    mplDeprecation, dedent, get_label, sanitize_sequence)
+    _backports, mplDeprecation, dedent, get_label, sanitize_sequence)
 from matplotlib.compat import subprocess
 from matplotlib.rcsetup import defaultParams, validate_backend, cycler
 
@@ -371,6 +371,9 @@ def checkdep_ghostscript():
 checkdep_ghostscript.version = None
 
 
+# Deprecated, as it is unneeded and some distributions (e.g. MiKTeX 2.9.6350)
+# do not actually report the TeX version.
+@cbook.deprecated("2.1")
 def checkdep_tex():
     try:
         s = subprocess.Popen([str('tex'), '-version'], stdout=subprocess.PIPE,
@@ -440,16 +443,9 @@ def checkdep_ps_distiller(s):
         return False
 
     flag = True
-    gs_req = '7.07'
-    gs_sugg = '7.07'
+    gs_req = '8.60'
     gs_exec, gs_v = checkdep_ghostscript()
-    if compare_versions(gs_v, gs_sugg):
-        pass
-    elif compare_versions(gs_v, gs_req):
-        verbose.report(('ghostscript-%s found. ghostscript-%s or later '
-                        'is recommended to use the ps.usedistiller option.')
-                       % (gs_v, gs_sugg))
-    else:
+    if not compare_versions(gs_v, gs_req):
         flag = False
         warnings.warn(('matplotlibrc ps.usedistiller option can not be used '
                        'unless ghostscript-%s or later is installed on your '
@@ -480,42 +476,28 @@ def checkdep_usetex(s):
     if not s:
         return False
 
-    tex_req = '3.1415'
-    gs_req = '7.07'
-    gs_sugg = '7.07'
-    dvipng_req = '1.5'
+    gs_req = '8.60'
+    dvipng_req = '1.6'
     flag = True
 
-    tex_v = checkdep_tex()
-    if compare_versions(tex_v, tex_req):
-        pass
-    else:
+    if _backports.which("tex") is None:
         flag = False
-        warnings.warn(('matplotlibrc text.usetex option can not be used '
-                       'unless TeX-%s or later is '
-                       'installed on your system') % tex_req)
+        warnings.warn('matplotlibrc text.usetex option can not be used unless '
+                      'TeX is installed on your system')
 
     dvipng_v = checkdep_dvipng()
-    if compare_versions(dvipng_v, dvipng_req):
-        pass
-    else:
+    if not compare_versions(dvipng_v, dvipng_req):
         flag = False
         warnings.warn('matplotlibrc text.usetex can not be used with *Agg '
-                      'backend unless dvipng-1.5 or later is '
-                      'installed on your system')
+                      'backend unless dvipng-%s or later is installed on '
+                      'your system' % dvipng_req)
 
     gs_exec, gs_v = checkdep_ghostscript()
-    if compare_versions(gs_v, gs_sugg):
-        pass
-    elif compare_versions(gs_v, gs_req):
-        verbose.report(('ghostscript-%s found. ghostscript-%s or later is '
-                        'recommended for use with the text.usetex '
-                        'option.') % (gs_v, gs_sugg))
-    else:
+    if not compare_versions(gs_v, gs_req):
         flag = False
-        warnings.warn(('matplotlibrc text.usetex can not be used '
-                       'unless ghostscript-%s or later is '
-                       'installed on your system') % gs_req)
+        warnings.warn('matplotlibrc text.usetex can not be used unless '
+                      'ghostscript-%s or later is installed on your system'
+                      % gs_req)
 
     return flag
 
@@ -811,7 +793,7 @@ def gen_candidates():
 
 _deprecated_ignore_map = {}
 
-_obsolete_set = {'legend.isaxes'}
+_obsolete_set = {'text.dvipnghack', 'legend.isaxes'}
 
 # The following may use a value of None to suppress the warning.
 _deprecated_set = {'axes.hold'}  # do NOT include in _all_deprecated
diff --git a/lib/matplotlib/cbook/_backports.py b/lib/matplotlib/cbook/_backports.py
@@ -1,8 +1,75 @@
 from __future__ import absolute_import
 
+import os
+import sys
+
 import numpy as np
 
 
+# Copy-pasted from Python 3.4's shutil.
+def which(cmd, mode=os.F_OK | os.X_OK, path=None):
+    """Given a command, mode, and a PATH string, return the path which
+    conforms to the given mode on the PATH, or None if there is no such
+    file.
+
+    `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result
+    of os.environ.get("PATH"), or can be overridden with a custom search
+    path.
+
+    """
+    # Check that a given file can be accessed with the correct mode.
+    # Additionally check that `file` is not a directory, as on Windows
+    # directories pass the os.access check.
+    def _access_check(fn, mode):
+        return (os.path.exists(fn) and os.access(fn, mode)
+                and not os.path.isdir(fn))
+
+    # If we're given a path with a directory part, look it up directly rather
+    # than referring to PATH directories. This includes checking relative to the
+    # current directory, e.g. ./script
+    if os.path.dirname(cmd):
+        if _access_check(cmd, mode):
+            return cmd
+        return None
+
+    if path is None:
+        path = os.environ.get("PATH", os.defpath)
+    if not path:
+        return None
+    path = path.split(os.pathsep)
+
+    if sys.platform == "win32":
+        # The current directory takes precedence on Windows.
+        if not os.curdir in path:
+            path.insert(0, os.curdir)
+
+        # PATHEXT is necessary to check on Windows.
+        pathext = os.environ.get("PATHEXT", "").split(os.pathsep)
+        # See if the given file matches any of the expected path extensions.
+        # This will allow us to short circuit when given "python.exe".
+        # If it does match, only test that one, otherwise we have to try
+        # others.
+        if any(cmd.lower().endswith(ext.lower()) for ext in pathext):
+            files = [cmd]
+        else:
+            files = [cmd + ext for ext in pathext]
+    else:
+        # On other platforms you don't have things like PATHEXT to tell you
+        # what file suffixes are executable, so just pass on cmd as-is.
+        files = [cmd]
+
+    seen = set()
+    for dir in path:
+        normdir = os.path.normcase(dir)
+        if not normdir in seen:
+            seen.add(normdir)
+            for thefile in files:
+                name = os.path.join(dir, thefile)
+                if _access_check(name, mode):
+                    return name
+    return None
+
+
 # Copy-pasted from numpy.lib.stride_tricks 1.11.2.
 def _maybe_view_as_subclass(original_array, new_array):
     if type(original_array) is not type(new_array):
diff --git a/lib/matplotlib/mpl-data/stylelib/_classic_test.mplstyle b/lib/matplotlib/mpl-data/stylelib/_classic_test.mplstyle
@@ -124,13 +124,6 @@ text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURE
                            # may also be loaded, depending on your font settings
 text.latex.preview : False
 
-text.dvipnghack : None      # some versions of dvipng don't handle alpha
-                            # channel properly.  Use True to correct
-                            # and flush ~/.matplotlib/tex.cache
-                            # before testing and False to force
-                            # correction off.  None will try and
-                            # guess based on your dvipng version
-
 text.hinting : auto   # May be one of the following:
                       #   'none': Perform no hinting
                       #   'auto': Use freetype's autohinter
diff --git a/lib/matplotlib/mpl-data/stylelib/classic.mplstyle b/lib/matplotlib/mpl-data/stylelib/classic.mplstyle
@@ -124,13 +124,6 @@ text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURE
                            # may also be loaded, depending on your font settings
 text.latex.preview : False
 
-text.dvipnghack : None      # some versions of dvipng don't handle alpha
-                            # channel properly.  Use True to correct
-                            # and flush ~/.matplotlib/tex.cache
-                            # before testing and False to force
-                            # correction off.  None will try and
-                            # guess based on your dvipng version
-
 text.hinting : auto   # May be one of the following:
                       #   'none': Perform no hinting
                       #   'auto': Use freetype's autohinter
diff --git a/lib/matplotlib/tests/test_backend_pdf.py b/lib/matplotlib/tests/test_backend_pdf.py
@@ -12,7 +12,7 @@
 import pytest
 
 import numpy as np
-from matplotlib import checkdep_tex, cm, rcParams
+from matplotlib import checkdep_usetex, cm, rcParams
 from matplotlib.backends.backend_pdf import PdfPages
 from matplotlib import pyplot as plt
 from matplotlib.testing.determinism import (_determinism_source_date_epoch,
@@ -21,8 +21,8 @@
 from matplotlib import dviread
 
 
-needs_tex = pytest.mark.xfail(
-    not checkdep_tex(),
+needs_usetex = pytest.mark.xfail(
+    not checkdep_usetex(True),
     reason="This test needs a TeX installation")
 
 
@@ -180,7 +180,7 @@ def test_grayscale_alpha():
 
 # This tests tends to hit a TeX cache lock on AppVeyor.
 @pytest.mark.flaky(reruns=3)
-@needs_tex
+@needs_usetex
 def test_missing_psfont(monkeypatch):
     """An error is raised if a TeX font lacks a Type-1 equivalent"""
     def psfont(*args, **kwargs):
diff --git a/lib/matplotlib/tests/test_backend_ps.py b/lib/matplotlib/tests/test_backend_ps.py
@@ -22,8 +22,8 @@
     reason="This test needs a ghostscript installation")
 
 
-needs_tex = pytest.mark.xfail(
-    not matplotlib.checkdep_tex(),
+needs_usetex = pytest.mark.xfail(
+    not matplotlib.checkdep_usetex(True),
     reason="This test needs a TeX installation")
 
 
@@ -32,12 +32,12 @@
 @pytest.mark.parametrize('format, use_log, rcParams', [
     ('ps', False, {}),
     needs_ghostscript(('ps', False, {'ps.usedistiller': 'ghostscript'})),
-    needs_tex(needs_ghostscript(('ps', False, {'text.latex.unicode': True,
-                                               'text.usetex': True}))),
+    needs_usetex(needs_ghostscript(('ps', False, {'text.latex.unicode': True,
+                                                  'text.usetex': True}))),
     ('eps', False, {}),
     ('eps', True, {'ps.useafm': True}),
-    needs_tex(needs_ghostscript(('eps', False, {'text.latex.unicode': True,
-                                                'text.usetex': True}))),
+    needs_usetex(needs_ghostscript(('eps', False, {'text.latex.unicode': True,
+                                                   'text.usetex': True}))),
 ], ids=[
     'ps',
     'ps with distiller',
@@ -115,7 +115,7 @@ def test_patheffects():
             fig.savefig(ps, format='ps')
 
 
-@needs_tex
+@needs_usetex
 @needs_ghostscript
 def test_tilde_in_tempfilename():
     # Tilde ~ in the tempdir path (e.g. TMPDIR, TMP oder TEMP on windows
@@ -169,7 +169,7 @@ def test_determinism_all():
     _determinism_check(format="ps")
 
 
-@needs_tex
+@needs_usetex
 @needs_ghostscript
 def test_determinism_all_tex():
     """Test for reproducible PS/tex output"""
diff --git a/lib/matplotlib/tests/test_backend_svg.py b/lib/matplotlib/tests/test_backend_svg.py
@@ -17,8 +17,8 @@
 from matplotlib import dviread
 
 
-needs_tex = pytest.mark.xfail(
-    not matplotlib.checkdep_tex(),
+needs_usetex = pytest.mark.xfail(
+    not matplotlib.checkdep_usetex(True),
     reason="This test needs a TeX installation")
 
 
@@ -187,13 +187,13 @@ def test_determinism_notex():
     _test_determinism('determinism_notex.svg', usetex=False)
 
 
-@needs_tex
+@needs_usetex
 def test_determinism_tex():
     # unique filename to allow for parallel testing
     _test_determinism('determinism_tex.svg', usetex=True)
 
 
-@needs_tex
+@needs_usetex
 def test_missing_psfont(monkeypatch):
     """An error is raised if a TeX font lacks a Type-1 equivalent"""
     from matplotlib import rc
diff --git a/lib/matplotlib/texmanager.py b/lib/matplotlib/texmanager.py
@@ -7,9 +7,8 @@
 Requirements:
 
 * latex
-* \\*Agg backends: dvipng
-* PS backend: latex w/ psfrag, dvips, and Ghostscript 8.51
-  (older versions do not work properly)
+* \\*Agg backends: dvipng>=1.6
+* PS backend: psfrag, dvips, and Ghostscript>=8.60
 
 Backends:
 
@@ -23,7 +22,7 @@
   texmanager = TexManager()
   s = ('\\TeX\\ is Number '
        '$\\displaystyle\\sum_{n=1}^\\infty\\frac{-e^{i\\pi}}{2^n}$!')
-  Z = self.texmanager.get_rgba(s, size=12, dpi=80, rgb=(1,0,0))
+  Z = texmanager.get_rgba(s, fontsize=12, dpi=80, rgb=(1,0,0))
 
 To enable tex rendering of all text in your matplotlib figure, set
 text.usetex in your matplotlibrc file or include these two lines in
@@ -66,6 +65,7 @@
     cmd_split = ';'
 
 
+@mpl.cbook.deprecated("2.1")
 def dvipng_hack_alpha():
     try:
         p = Popen([str('dvipng'), '-version'], stdin=PIPE, stdout=PIPE,
@@ -123,8 +123,6 @@ class TexManager(object):
     if texcache is not None:
         mkdirs(texcache)
 
-    _dvipng_hack_alpha = None
-    #_dvipng_hack_alpha = dvipng_hack_alpha()
     # mappable cache of
     rgba_arrayd = {}
     grey_arrayd = {}
@@ -543,46 +541,10 @@ def get_grey(self, tex, fontsize=None, dpi=None):
         """returns the alpha channel"""
         key = tex, self.get_font_config(), fontsize, dpi
         alpha = self.grey_arrayd.get(key)
-
         if alpha is None:
             pngfile = self.make_png(tex, fontsize, dpi)
             X = read_png(os.path.join(self.texcache, pngfile))
-
-            if rcParams['text.dvipnghack'] is not None:
-                hack = rcParams['text.dvipnghack']
-            else:
-                if TexManager._dvipng_hack_alpha is None:
-                    TexManager._dvipng_hack_alpha = dvipng_hack_alpha()
-                hack = TexManager._dvipng_hack_alpha
-
-            if hack:
-                # hack the alpha channel
-                # dvipng assumed a constant background, whereas we want to
-                # overlay these rasters with antialiasing over arbitrary
-                # backgrounds that may have other figure elements under them.
-                # When you set dvipng -bg Transparent, it actually makes the
-                # alpha channel 1 and does the background compositing and
-                # antialiasing itself and puts the blended data in the rgb
-                # channels.  So what we do is extract the alpha information
-                # from the red channel, which is a blend of the default dvipng
-                # background (white) and foreground (black).  So the amount of
-                # red (or green or blue for that matter since white and black
-                # blend to a grayscale) is the alpha intensity.  Once we
-                # extract the correct alpha information, we assign it to the
-                # alpha channel properly and let the users pick their rgb.  In
-                # this way, we can overlay tex strings on arbitrary
-                # backgrounds with antialiasing
-                #
-                # red = alpha*red_foreground + (1-alpha)*red_background
-                #
-                # Since the foreground is black (0) and the background is
-                # white (1) this reduces to red = 1-alpha or alpha = 1-red
-                #alpha = npy.sqrt(1-X[:,:,0]) # should this be sqrt here?
-                alpha = 1 - X[:, :, 0]
-            else:
-                alpha = X[:, :, -1]
-
-            self.grey_arrayd[key] = alpha
+            self.grey_arrayd[key] = alpha = X[:, :, -1]
         return alpha
 
     def get_rgba(self, tex, fontsize=None, dpi=None, rgb=(0, 0, 0)):
diff --git a/matplotlibrc.template b/matplotlibrc.template
diff --git a/pytest.ini b/pytest.ini
diff --git a/tutorials/text/usetex.py b/tutorials/text/usetex.py
