Merge pull request #10565 from dstansby/py3-subprocess

anntzer · web-flow · commit 74b6913624c0 · 2018-02-26T10:51:32.000-08:00
Strip python 2 code from subprocess.py
diff --git a/doc/api/next_api_changes/2018-02-15-AL-deprecations.rst b/doc/api/next_api_changes/2018-02-15-AL-deprecations.rst
@@ -1,8 +1,15 @@
 Deprecations
 ````````````
+The following modules are deprecated:
+
+- :mod:`matplotlib.compat.subprocess`. This was a python 2 workaround, but all the
+  functionality can now be found in the python 3 standard library
+  :mod:`subprocess`.
+
 The following functions and classes are deprecated:
 
 - ``cbook.GetRealpathAndStat`` (which is only a helper for
   ``get_realpath_and_stat``),
 - ``cbook.is_numlike`` (use ``isinstance(..., numbers.Number)`` instead),
 - ``mathtext.unichr_safe`` (use ``chr`` instead),
+- ``texmanager.dvipng_hack_alpha``,
diff --git a/examples/tests/backend_driver_sgskip.py b/examples/tests/backend_driver_sgskip.py
@@ -339,7 +339,7 @@ def report_all_missing(directories):
     )
 
 
-from matplotlib.compat import subprocess
+import subprocess
 
 
 def run(arglist):
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -133,6 +133,7 @@
 import re
 import shutil
 import stat
+import subprocess
 import tempfile
 import warnings
 
@@ -141,7 +142,6 @@
 from . import cbook
 from matplotlib.cbook import (
     _backports, mplDeprecation, dedent, get_label, sanitize_sequence)
-from matplotlib.compat import subprocess
 from matplotlib.rcsetup import defaultParams, validate_backend, cycler
 
 import numpy
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -30,6 +30,7 @@
 import logging
 import os
 import platform
+import subprocess
 import sys
 import tempfile
 import uuid
@@ -38,7 +39,6 @@
 
 from matplotlib._animation_data import (DISPLAY_TEMPLATE, INCLUDED_FRAMES,
                                         JS_INCLUDE)
-from matplotlib.compat import subprocess
 from matplotlib import cbook, rcParams, rcParamsDefault, rc_context
 
 if six.PY2:
diff --git a/lib/matplotlib/backends/backend_pgf.py b/lib/matplotlib/backends/backend_pgf.py
@@ -10,6 +10,7 @@
 import os
 import re
 import shutil
+import subprocess
 import sys
 import tempfile
 import warnings
@@ -22,8 +23,6 @@
     RendererBase)
 from matplotlib.backends.backend_mixed import MixedModeRenderer
 from matplotlib.cbook import is_writable_file_like
-from matplotlib.compat import subprocess
-from matplotlib.compat.subprocess import check_output
 from matplotlib.path import Path
 
 
@@ -42,13 +41,15 @@
     # assuming fontconfig is installed and the command 'fc-list' exists
     try:
         # list scalable (non-bitmap) fonts
-        fc_list = check_output([str('fc-list'), ':outline,scalable', 'family'])
+        fc_list = subprocess.check_output(
+            ['fc-list', ':outline,scalable', 'family'])
         fc_list = fc_list.decode('utf8')
         system_fonts = [f.split(',')[0] for f in fc_list.splitlines()]
         system_fonts = list(set(system_fonts))
     except:
         warnings.warn('error getting fonts from fc-list', UserWarning)
 
+
 def get_texcommand():
     """Get chosen TeX system from rc."""
     texsystem_options = ["xelatex", "lualatex", "pdflatex"]
@@ -173,7 +174,8 @@ def make_pdf_to_png_converter():
     tools_available = []
     # check for pdftocairo
     try:
-        check_output([str("pdftocairo"), "-v"], stderr=subprocess.STDOUT)
+        subprocess.check_output(
+            ["pdftocairo", "-v"], stderr=subprocess.STDOUT)
         tools_available.append("pdftocairo")
     except:
         pass
@@ -185,9 +187,9 @@ def make_pdf_to_png_converter():
     # pick converter
     if "pdftocairo" in tools_available:
         def cairo_convert(pdffile, pngfile, dpi):
-            cmd = [str("pdftocairo"), "-singlefile", "-png", "-r", "%d" % dpi,
+            cmd = ["pdftocairo", "-singlefile", "-png", "-r", "%d" % dpi,
                    pdffile, os.path.splitext(pngfile)[0]]
-            check_output(cmd, stderr=subprocess.STDOUT)
+            subprocess.check_output(cmd, stderr=subprocess.STDOUT)
         return cairo_convert
     elif "gs" in tools_available:
         def gs_convert(pdffile, pngfile, dpi):
@@ -197,7 +199,7 @@ def gs_convert(pdffile, pngfile, dpi):
                    '-dGraphicsAlphaBits=4', '-dDOINTERPOLATE',
                    '-sDEVICE=png16m', '-sOutputFile=%s' % pngfile,
                    '-r%d' % dpi, pdffile]
-            check_output(cmd, stderr=subprocess.STDOUT)
+            subprocess.check_output(cmd, stderr=subprocess.STDOUT)
         return gs_convert
     else:
         raise RuntimeError("No suitable pdf to png renderer found.")
@@ -900,7 +902,8 @@ def _print_pdf_to_fh(self, fh, *args, **kwargs):
             cmdargs = [str(texcommand), "-interaction=nonstopmode",
                        "-halt-on-error", "figure.tex"]
             try:
-                check_output(cmdargs, stderr=subprocess.STDOUT, cwd=tmpdir)
+                subprocess.check_output(
+                    cmdargs, stderr=subprocess.STDOUT, cwd=tmpdir)
             except subprocess.CalledProcessError as e:
                 raise RuntimeError(
                     "%s was not able to process your file.\n\nFull log:\n%s"
diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -11,6 +11,7 @@
 import glob, os, shutil, sys, time, datetime
 import io
 import logging
+import subprocess
 
 from tempfile import mkstemp
 from matplotlib import cbook, __version__, rcParams, checkdep_ghostscript
@@ -21,7 +22,6 @@
 
 from matplotlib.cbook import (get_realpath_and_stat, is_writable_file_like,
                               maxdict, file_requires_unicode)
-from matplotlib.compat.subprocess import subprocess
 
 from matplotlib.font_manager import findfont, is_opentype_cff_font, get_font
 from matplotlib.ft2font import KERNING_DEFAULT, LOAD_NO_HINTING
@@ -78,8 +78,8 @@ def gs_version(self):
         except KeyError:
             pass
 
-        from matplotlib.compat.subprocess import Popen, PIPE
-        s = Popen([self.gs_exe, "--version"], stdout=PIPE)
+        s = subprocess.Popen(
+            [self.gs_exe, "--version"], stdout=subprocess.PIPE)
         pipe, stderr = s.communicate()
         if six.PY3:
             ver = pipe.decode('ascii')
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -1292,7 +1292,7 @@ def restrict_dict(d, keys):
 
 def report_memory(i=0):  # argument may go away
     """return the memory consumed by process"""
-    from matplotlib.compat.subprocess import Popen, PIPE
+    from subprocess import Popen, PIPE
     pid = os.getpid()
     if sys.platform == 'sunos5':
         try:
diff --git a/lib/matplotlib/compat/subprocess.py b/lib/matplotlib/compat/subprocess.py
@@ -1,30 +1,21 @@
 """
-A replacement wrapper around the subprocess module, with a number of
-work-arounds:
-- Provides a stub implementation of subprocess members on Google App Engine
-  (which are missing in subprocess).
-- Use subprocess32, backport from python 3.2 on Linux/Mac work-around for
-  https://github.com/matplotlib/matplotlib/issues/5314
+A replacement wrapper around the subprocess module, which provides a stub
+implementation of subprocess members on Google App Engine
+(which are missing in subprocess).
 
 Instead of importing subprocess, other modules should use this as follows:
 
 from matplotlib.compat import subprocess
 
 This module is safe to import from anywhere within matplotlib.
 """
-
-from __future__ import absolute_import    # Required to import subprocess
-from __future__ import print_function
-import os
-import sys
-if os.name == 'posix' and sys.version_info[0] < 3:
-    # work around for https://github.com/matplotlib/matplotlib/issues/5314
-    try:
-        import subprocess32 as subprocess
-    except ImportError:
-        import subprocess
-else:
-    import subprocess
+import subprocess
+from matplotlib.cbook import warn_deprecated
+warn_deprecated(since='3.0',
+                name='matplotlib.compat.subprocess',
+                alternative='the python 3 standard library '
+                            '"subprocess" module',
+                obj_type='module')
 
 __all__ = ['Popen', 'PIPE', 'STDOUT', 'check_output', 'CalledProcessError']
 
diff --git a/lib/matplotlib/dviread.py b/lib/matplotlib/dviread.py
@@ -24,13 +24,13 @@
 import os
 import re
 import struct
+import subprocess
 import sys
 import textwrap
 
 import numpy as np
 
 from matplotlib import cbook, rcParams
-from matplotlib.compat import subprocess
 
 _log = logging.getLogger(__name__)
 
diff --git a/lib/matplotlib/font_manager.py b/lib/matplotlib/font_manager.py
@@ -48,13 +48,13 @@
 from functools import lru_cache
 import json
 import os
+import subprocess
 import sys
 from threading import Timer
 import warnings
 import logging
 
 from matplotlib import afm, cbook, ft2font, rcParams, get_cachedir
-from matplotlib.compat import subprocess
 from matplotlib.fontconfig_pattern import (
     parse_fontconfig_pattern, generate_fontconfig_pattern)
 
diff --git a/lib/matplotlib/testing/compare.py b/lib/matplotlib/testing/compare.py
@@ -14,13 +14,13 @@
 from pathlib import Path
 import re
 import shutil
+import subprocess
 import sys
 from tempfile import TemporaryFile
 
 import numpy as np
 
 import matplotlib
-from matplotlib.compat import subprocess
 from matplotlib.testing.exceptions import ImageComparisonFailure
 from matplotlib import _png
 from matplotlib import _get_cachedir
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -566,7 +566,7 @@ def skip_if_command_unavailable(cmd):
         return a non zero exit code, something like
         ["latex", "-version"]
     """
-    from matplotlib.compat.subprocess import check_output
+    from subprocess import check_output
     try:
         check_output(cmd)
     except:
diff --git a/lib/matplotlib/tests/test_backend_pgf.py b/lib/matplotlib/tests/test_backend_pgf.py
@@ -3,13 +3,13 @@
 
 import os
 import shutil
+import subprocess
 
 import numpy as np
 import pytest
 
 import matplotlib as mpl
 import matplotlib.pyplot as plt
-from matplotlib.compat import subprocess
 from matplotlib.testing.compare import compare_images, ImageComparisonFailure
 from matplotlib.testing.decorators import image_comparison, _image_directories
 
diff --git a/lib/matplotlib/tests/test_backends_interactive.py b/lib/matplotlib/tests/test_backends_interactive.py
@@ -1,20 +1,14 @@
 import importlib
 import os
+import subprocess
 import sys
 
-from matplotlib.compat.subprocess import Popen
 import pytest
 
 
 # Minimal smoke-testing of the backends for which the dependencies are
 # PyPI-installable on Travis.  They are not available for all tested Python
 # versions so we don't fail on missing backends.
-#
-# We also don't test on Py2 because its subprocess module doesn't support
-# timeouts, and it would require a separate code path to check for module
-# existence without actually trying to import the module (which may install
-# an undesirable input hook).
-
 
 def _get_testable_interactive_backends():
     backends = []
@@ -53,6 +47,6 @@ def _get_testable_interactive_backends():
 def test_backend(backend):
     environ = os.environ.copy()
     environ["MPLBACKEND"] = backend
-    proc = Popen([sys.executable, "-c", _test_script], env=environ)
+    proc = subprocess.Popen([sys.executable, "-c", _test_script], env=environ)
     # Empirically, 1s is not enough on Travis.
     assert proc.wait(timeout=10) == 0
diff --git a/lib/matplotlib/texmanager.py b/lib/matplotlib/texmanager.py
@@ -44,6 +44,7 @@
 import os
 from pathlib import Path
 import shutil
+import subprocess
 import sys
 import warnings
 
@@ -53,33 +54,12 @@
 from matplotlib import rcParams
 from matplotlib._png import read_png
 from matplotlib.cbook import Locked
-from matplotlib.compat.subprocess import subprocess, Popen, PIPE, STDOUT
 import matplotlib.dviread as dviread
 import re
 
 _log = logging.getLogger(__name__)
 
 
-@mpl.cbook.deprecated("2.1")
-def dvipng_hack_alpha():
-    try:
-        p = Popen([str('dvipng'), '-version'], stdin=PIPE, stdout=PIPE,
-                  stderr=STDOUT, close_fds=(sys.platform != 'win32'))
-        stdout, stderr = p.communicate()
-    except OSError:
-        _log.info('No dvipng was found')
-        return False
-    lines = stdout.decode(sys.getdefaultencoding()).split('\n')
-    for line in lines:
-        if line.startswith('dvipng '):
-            version = line.split()[-1]
-            _log.info('Found dvipng version %s', version)
-            version = distutils.version.LooseVersion(version)
-            return version < distutils.version.LooseVersion('1.6')
-    _log.info('Unexpected response from dvipng -version')
-    return False
-
-
 class TexManager(object):
     """
     Convert strings to dvi files using TeX, caching the results to a directory.

Original file line number	Diff line number	Diff line change
`@@ -339,7 +339,7 @@ def report_all_missing(directories):`
`339`	`339`	`)`
`340`	`340`
`341`	`341`
`342`		`-from matplotlib.compat import subprocess`
	`342`	`+import subprocess`
`343`	`343`
`344`	`344`
`345`	`345`	`def run(arglist):`