added public interface to usemathtext for EngFormatter

pharshalp · pharshalp · commit fc9a1effdca6 · 2019-02-24T10:34:48.000-05:00
diff --git a/lib/matplotlib/tests/test_ticker.py b/lib/matplotlib/tests/test_ticker.py
@@ -788,6 +788,19 @@ def test_params(self, input, expected):
                 assert _formatter(input) == _exp_output
 
 
+def test_engformatter_mathtext():
+    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']
+
+
 class TestPercentFormatter(object):
     percent_data = [
         # Check explicitly set decimals over different intervals and values
diff --git a/lib/matplotlib/tests/test_usetex.py b/lib/matplotlib/tests/test_usetex.py
@@ -32,18 +32,3 @@ def test_usetex():
             fontsize=24)
     ax.set_xticks([])
     ax.set_yticks([])
-
-
-@needs_usetex
-def test_usetex_engformatter():
-    matplotlib.rcParams['text.usetex'] = True
-    fig, ax = plt.subplots()
-    ax.plot([0, 500, 1000], [0, 500, 1000])
-    ax.set_xticks([0, 500, 1000])
-    formatter = EngFormatter()
-    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']
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -1200,7 +1200,7 @@ class EngFormatter(Formatter):
          24: "Y"
     }
 
-    def __init__(self, unit="", places=None, sep=" "):
+    def __init__(self, unit="", places=None, sep=" ", useMathText=None):
         """
         Parameters
         ----------
@@ -1230,7 +1230,20 @@ def __init__(self, unit="", places=None, sep=" "):
         self.unit = unit
         self.places = places
         self.sep = sep
-        self._usetex = rcParams['text.usetex']
+        if useMathText is None:
+            useMathText = rcParams['axes.formatter.use_mathtext']
+        self.set_useMathText(useMathText)
+
+    def get_useMathText(self):
+        return self._useMathText
+
+    def set_useMathText(self, val):
+        if val is None:
+            self._useMathText = rcParams['axes.formatter.use_mathtext']
+        else:
+            self._useMathText = val
+
+    useMathText = property(fget=get_useMathText, fset=set_useMathText)
 
     def __call__(self, x, pos=None):
         s = "%s%s" % (self.format_eng(x), self.unit)
@@ -1282,7 +1295,7 @@ def format_eng(self, num):
             pow10 += 3
 
         prefix = self.ENG_PREFIXES[int(pow10)]
-        if self._usetex:
+        if self._useMathText:
             formatted = "${mant:{fmt}}${sep}{prefix}".format(
                 mant=mant, sep=self.sep, prefix=prefix, fmt=fmt)
         else:
