Adding usetex, useMathText to EngFormatter + test

pharshalp · pharshalp · commit 732910c639cd · 2019-02-24T11:30:30.000-05:00
diff --git a/lib/matplotlib/tests/test_ticker.py b/lib/matplotlib/tests/test_ticker.py
@@ -788,17 +788,18 @@ def test_params(self, input, expected):
                 assert _formatter(input) == _exp_output
 
 
-def test_engformatter_mathtext():
+def test_engformatter_usetex_useMathText():
     fig, ax = plt.subplots()
     ax.plot([0, 500, 1000], [0, 500, 1000])
     ax.set_xticks([0, 500, 1000])
-    formatter = mticker.EngFormatter(useMathText=True)
-    ax.xaxis.set_major_formatter(formatter)
-    fig.canvas.draw()
-    x_tick_label_text = [label.get_text() for label in ax.get_xticklabels()]
-    # Checking if the dollar `$` signs have been inserted around numbers
-    # in tick label text.
-    assert x_tick_label_text == ['$0$', '$500$', '$1$ k']
+    for formatter in (mticker.EngFormatter(usetex=True),
+                      mticker.EngFormatter(useMathText=True)):
+        ax.xaxis.set_major_formatter(formatter)
+        fig.canvas.draw()
+        x_tick_label_text = [labl.get_text() for labl in ax.get_xticklabels()]
+        # Checking if the dollar `$` signs have been inserted around numbers
+        # in tick labels.
+        assert x_tick_label_text == ['$0$', '$500$', '$1$ k']
 
 
 class TestPercentFormatter(object):
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -1200,7 +1200,8 @@ class EngFormatter(Formatter):
          24: "Y"
     }
 
-    def __init__(self, unit="", places=None, sep=" ", useMathText=None):
+    def __init__(self, unit="", places=None, sep=" ", usetex=None,
+                 useMathText=None):
         """
         Parameters
         ----------
@@ -1226,14 +1227,32 @@ def __init__(self, unit="", places=None, sep=" ", useMathText=None):
             * ``sep="\\N{THIN SPACE}"`` (``U+2009``);
             * ``sep="\\N{NARROW NO-BREAK SPACE}"`` (``U+202F``);
             * ``sep="\\N{NO-BREAK SPACE}"`` (``U+00A0``).
+                `
+        usetex : bool (default: None)
+            To enable/disable the use of TeX's math mode for rendering the
+            numbers in the formatter.
+
+        useMathText : bool (default: None)
+            To enable/disable the use mathtext for rendering the numbers in
+            the formatter.
         """
         self.unit = unit
         self.places = places
         self.sep = sep
-        if useMathText is None:
-            useMathText = rcParams['axes.formatter.use_mathtext']
+        self.set_usetex(usetex)
         self.set_useMathText(useMathText)
 
+    def get_usetex(self):
+        return self._usetex
+
+    def set_usetex(self, val):
+        if val is None:
+            self._usetex = rcParams['text.usetex']
+        else:
+            self._usetex = val
+
+    usetex = property(fget=get_usetex, fset=set_usetex)
+
     def get_useMathText(self):
         return self._useMathText
 
@@ -1295,7 +1314,7 @@ def format_eng(self, num):
             pow10 += 3
 
         prefix = self.ENG_PREFIXES[int(pow10)]
-        if self._useMathText:
+        if self._usetex or self._useMathText:
             formatted = "${mant:{fmt}}${sep}{prefix}".format(
                 mant=mant, sep=self.sep, prefix=prefix, fmt=fmt)
         else:
