Pathlibify font_manager (only internally, doesn't change the API).

anntzer · anntzer · commit a5b164c73d6d · 2018-03-23T00:46:51.000-07:00
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -676,6 +676,7 @@ def dedent(s):
     return result
 
 
+@deprecated("3.0")
 def listFiles(root, patterns='*', recurse=1, return_folders=0):
     """
     Recursively list files
diff --git a/lib/matplotlib/font_manager.py b/lib/matplotlib/font_manager.py
@@ -34,12 +34,13 @@
 from collections import Iterable
 from functools import lru_cache
 import json
+import logging
 import os
+from pathlib import Path
 import subprocess
 import sys
 from threading import Timer
 import warnings
-import logging
 
 from matplotlib import afm, cbook, ft2font, rcParams, get_cachedir
 from matplotlib.fontconfig_pattern import (
@@ -129,13 +130,8 @@
 ]
 
 if not USE_FONTCONFIG and sys.platform != 'win32':
-    home = os.environ.get('HOME')
-    if home is not None:
-        # user fonts on OSX
-        path = os.path.join(home, 'Library', 'Fonts')
-        OSXFontDirectories.append(path)
-        path = os.path.join(home, '.fonts')
-        X11FontDirectories.append(path)
+    OSXFontDirectories.append(str(Path.home() / "Library/Fonts"))
+    X11FontDirectories.append(str(Path.home() / ".fonts"))
 
 
 def get_fontext_synonyms(fontext):
@@ -151,34 +147,28 @@ def get_fontext_synonyms(fontext):
 def list_fonts(directory, extensions):
     """
     Return a list of all fonts matching any of the extensions,
-    possibly upper-cased, found recursively under the directory.
+    found recursively under the directory.
     """
-    pattern = ';'.join(['*.%s;*.%s' % (ext, ext.upper())
-                        for ext in extensions])
-    return cbook.listFiles(directory, pattern)
+    return [str(path)
+            for path in Path().rglob("*")
+            if path.is_file() and path.suffix[1:] in extensions]
 
 
 def win32FontDirectory():
-    """
+    r"""
     Return the user-specified font directory for Win32.  This is
     looked up from the registry key::
 
-      \\\\HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Shell Folders\\Fonts
+      \\HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders\Fonts
 
     If the key is not found, $WINDIR/Fonts will be returned.
     """
     import winreg
     try:
-        user = winreg.OpenKey(winreg.HKEY_CURRENT_USER, MSFolders)
-        try:
+        with winreg.OpenKey(winreg.HKEY_CURRENT_USER, MSFolders) as user:
             return winreg.QueryValueEx(user, 'Fonts')[0]
-        except OSError:
-            pass  # Fall through to default
-        finally:
-            winreg.CloseKey(user)
     except OSError:
-        pass  # Fall through to default
-    return os.path.join(os.environ['WINDIR'], 'Fonts')
+        return os.path.join(os.environ['WINDIR'], 'Fonts')
 
 
 def win32InstalledFonts(directory=None, fontext='ttf'):
@@ -196,37 +186,23 @@ def win32InstalledFonts(directory=None, fontext='ttf'):
 
     fontext = get_fontext_synonyms(fontext)
 
-    key, items = None, set()
+    items = set()
     for fontdir in MSFontDirectories:
         try:
-            local = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, fontdir)
-        except OSError:
-            continue
-        if not local:
-            return list_fonts(directory, fontext)
-        try:
-            for j in range(winreg.QueryInfoKey(local)[1]):
-                try:
+            with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, fontdir) as local:
+                for j in range(winreg.QueryInfoKey(local)[1]):
                     key, direc, tp = winreg.EnumValue(local, j)
                     if not isinstance(direc, str):
                         continue
                     # Work around for https://bugs.python.org/issue25778, which
                     # is fixed in Py>=3.6.1.
                     direc = direc.split("\0", 1)[0]
-                    if not os.path.dirname(direc):
-                        direc = os.path.join(directory, direc)
-                    direc = os.path.abspath(direc).lower()
-                    if os.path.splitext(direc)[1][1:] in fontext:
-                        items.add(direc)
-                except EnvironmentError:
-                    continue
-                except WindowsError:
-                    continue
-                except MemoryError:
-                    continue
-            return list(items)
-        finally:
-            winreg.CloseKey(local)
+                    path = Path(directory, direc).resolve()
+                    if path.suffix.lower() in fontext:
+                        items.add(str(path))
+                return list(items)
+        except (OSError, MemoryError):
+            continue
     return None
 
 
@@ -242,6 +218,9 @@ def OSXInstalledFonts(directories=None, fontext='ttf'):
     files = []
     for path in directories:
         if fontext is None:
+            cbook.warn_deprecated(
+                "3.0", "Support for listing all files regardless of extension "
+                "is deprecated.")
             files.extend(cbook.listFiles(path, '*'))
         else:
             files.extend(list_fonts(path, fontext))
@@ -271,7 +250,7 @@ def get_fontconfig_fonts(fontext='ttf'):
     """
     fontext = get_fontext_synonyms(fontext)
     return [fname for fname in _call_fc_list()
-            if os.path.splitext(fname)[1][1:] in fontext]
+            if Path(fname).suffix[1:] in fontext]
 
 
 def findSystemFonts(fontpaths=None, fontext='ttf'):
@@ -292,8 +271,7 @@ def findSystemFonts(fontpaths=None, fontext='ttf'):
             fontpaths = [fontdir]
             # now get all installed fonts directly...
             for f in win32InstalledFonts(fontdir):
-                base, ext = os.path.splitext(f)
-                if len(ext)>1 and ext[1:].lower() in fontexts:
+                if Path(f).suffix in fontexts:
                     fontfiles.add(f)
         else:
             fontpaths = X11FontDirectories
@@ -1238,16 +1216,12 @@ def _findfont_cached(self, prop, fontext, directory, fallback_to_default,
         else:
             fontlist = self.ttflist
 
-        if directory is not None:
-            directory = os.path.normcase(directory)
-
         best_score = 1e64
         best_font = None
 
         for font in fontlist:
             if (directory is not None and
-                    os.path.commonprefix([os.path.normcase(font.fname),
-                                          directory]) != directory):
+                    Path(directory) not in Path(font.fname).parents):
                 continue
             # Matching family should have highest priority, so it is multiplied
             # by 10.0
diff --git a/lib/matplotlib/tests/test_font_manager.py b/lib/matplotlib/tests/test_font_manager.py
@@ -1,8 +1,5 @@
-from __future__ import absolute_import, division, print_function
-
-import six
-
 import os
+import shutil
 import tempfile
 import warnings
 
@@ -14,13 +11,7 @@
     get_fontconfig_fonts, is_opentype_cff_font, fontManager as fm)
 from matplotlib import rc_context
 
-if six.PY2:
-    from distutils.spawn import find_executable
-    has_fclist = find_executable('fc-list') is not None
-else:
-    # py >= 3.3
-    from shutil import which
-    has_fclist = which('fc-list') is not None
+has_fclist = shutil.which('fc-list') is not None
 
 
 def test_font_priority():
