BUG: fix checkout_output with non-ascii paths in PATH

tacaswell · tacaswell · commit 3b2a36d91627 · 2017-01-11T22:46:17.000-05:00
Closes #7715 This ensures that on python2 the values passed into `check_output` are bytes. If they are passed in as unicode (due to unicode_literals at the top of most of our files) they will cause an exception when there is a path in PATH that has non-ascii values. The reason is that when locating possible executable our input (as unicode) is concatenated with the non-ascii path (as bytes) which then fails to encode as ascii and raises. The other two places we currently use `check_output` (setupext.py and tools/github_stats.py) we do not need this handling as we do not import unicode_iterals in those files.
diff --git a/.travis.yml b/.travis.yml
@@ -69,6 +69,9 @@ before_install:
   - pip install --upgrade virtualenv
   - virtualenv --python=python venv
   - source venv/bin/activate
+  # test with non-ascii in path
+  - mkdir /tmp/λ
+  - export PATH=$PATH:/tmp/λ
   - export PATH=/usr/lib/ccache:$PATH
 
 install:
diff --git a/lib/matplotlib/backends/backend_pgf.py b/lib/matplotlib/backends/backend_pgf.py
@@ -45,7 +45,8 @@
     # assuming fontconfig is installed and the command 'fc-list' exists
     try:
         # list scalable (non-bitmap) fonts
-        fc_list = check_output(['fc-list', ':outline,scalable', 'family'])
+        fc_list = check_output(str(' '.join(['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))
@@ -179,7 +180,7 @@ def make_pdf_to_png_converter():
     tools_available = []
     # check for pdftocairo
     try:
-        check_output(["pdftocairo", "-v"], stderr=subprocess.STDOUT)
+        check_output([str("pdftocairo"), str("-v")], stderr=subprocess.STDOUT)
         tools_available.append("pdftocairo")
     except:
         pass
@@ -194,15 +195,16 @@ def cairo_convert(pdffile, pngfile, dpi):
             cmd = ["pdftocairo", "-singlefile", "-png",
                    "-r %d" % dpi, pdffile, os.path.splitext(pngfile)[0]]
             # for some reason this doesn't work without shell
-            check_output(" ".join(cmd), shell=True, stderr=subprocess.STDOUT)
+            check_output(str(" ".join(cmd)), shell=True,
+                         stderr=subprocess.STDOUT)
         return cairo_convert
     elif "gs" in tools_available:
         def gs_convert(pdffile, pngfile, dpi):
-            cmd = [gs, '-dQUIET', '-dSAFER', '-dBATCH', '-dNOPAUSE', '-dNOPROMPT',
+            cmd = [str(gs), '-dQUIET', '-dSAFER', '-dBATCH', '-dNOPAUSE', '-dNOPROMPT',
                    '-sDEVICE=png16m', '-dUseCIEColor', '-dTextAlphaBits=4',
                    '-dGraphicsAlphaBits=4', '-dDOINTERPOLATE', '-sOutputFile=%s' % pngfile,
                    '-r%d' % dpi, pdffile]
-            check_output(cmd, stderr=subprocess.STDOUT)
+            check_output(str(" ".join(cmd)), stderr=subprocess.STDOUT)
         return gs_convert
     else:
         raise RuntimeError("No suitable pdf to png renderer found.")
@@ -898,7 +900,7 @@ def _print_pdf_to_fh(self, fh, *args, **kwargs):
             cmdargs = [texcommand, "-interaction=nonstopmode",
                        "-halt-on-error", "figure.tex"]
             try:
-                check_output(cmdargs, stderr=subprocess.STDOUT, cwd=tmpdir)
+                check_output(str(' '.join(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" % (texcommand, e.output))
 
diff --git a/lib/matplotlib/font_manager.py b/lib/matplotlib/font_manager.py
@@ -281,7 +281,7 @@ def _call_fc_list():
         'This may take a moment.'))
     timer.start()
     try:
-        out = subprocess.check_output(['fc-list', '--format=%{file}'])
+        out = subprocess.check_output([str('fc-list'), '--format=%{file}'])
     except (OSError, subprocess.CalledProcessError):
         return []
     finally:
