Prefer mpl.get_data_path(), and support Paths in FontProperties.

anntzer · anntzer · commit 4e61ef1afcc7 · 2019-06-03T07:59:35.000+02:00
1) Prefer using mpl.get_data_path() rather than rcParams["datapath"].
   I would like to ultimately kill that rcParams entry, because it
   does not make sense as a rcParam (for example one can't really
   meaningfully assign it to anything else than its default value, or
   set it in their matplotlibrc) and requires e.g. to be blacklisted
   in style/core.py; let's start by not using it in the docs.

2) As a side effect of that change, one of the examples (font_file.py)
   reads a bit more nicely if one can pass Paths to FontProperties, so
   let's support that.
diff --git a/doc/users/next_whats_new/2019-05-31-AL.rst b/doc/users/next_whats_new/2019-05-31-AL.rst
@@ -0,0 +1,4 @@
+The *fname* argument to `FontProperties` can now be an `os.PathLike`\s
+``````````````````````````````````````````````````````````````````````
+
+e.g. ``FontProperties(fname=pathlib.Path("/path/to/font.ttf"))``.
diff --git a/examples/text_labels_and_annotations/font_file.py b/examples/text_labels_and_annotations/font_file.py
@@ -15,16 +15,17 @@
 :doc:`/gallery/text_labels_and_annotations/fonts_demo`.
 """
 
-import os
-from matplotlib import font_manager as fm, rcParams
+from pathlib import Path
+
+import matplotlib as mpl
+from matplotlib import font_manager as fm
 import matplotlib.pyplot as plt
 
 fig, ax = plt.subplots()
 
-fpath = os.path.join(rcParams["datapath"], "fonts/ttf/cmr10.ttf")
+fpath = Path(mpl.get_data_path(), "fonts/ttf/cmr10.ttf")
 prop = fm.FontProperties(fname=fpath)
-fname = os.path.split(fpath)[1]
-ax.set_title('This is a special font: {}'.format(fname), fontproperties=prop)
+ax.set_title(f'This is a special font: {fpath.name}', fontproperties=prop)
 ax.set_xlabel('This is the default font')
 
 plt.show()
diff --git a/lib/matplotlib/afm.py b/lib/matplotlib/afm.py
@@ -13,9 +13,9 @@
 
 It is pretty easy to use, and requires only built-in python libs:
 
-    >>> from matplotlib import rcParams
+    >>> import matplotlib as mpl
     >>> import os.path
-    >>> afm_fname = os.path.join(rcParams['datapath'],
+    >>> afm_fname = os.path.join(mpl.get_data_path(),
     ...                         'fonts', 'afm', 'ptmr8a.afm')
     >>>
     >>> from matplotlib.afm import AFM
diff --git a/lib/matplotlib/font_manager.py b/lib/matplotlib/font_manager.py
@@ -1275,7 +1275,7 @@ def is_opentype_cff_font(filename):
 def get_font(filename, hinting_factor=None):
     if hinting_factor is None:
         hinting_factor = rcParams['text.hinting_factor']
-    return _get_font(filename, hinting_factor)
+    return _get_font(os.fspath(filename), hinting_factor)
 
 
 def _rebuild():
