FIX: make EngFormatter respect axes.unicode_minus rcParam (#13477)

pharshalp · timhoffm · commit aed13c1ffe20 · 2019-03-03T22:31:19.000+01:00
* Add fix_minus method to EngFormatter

* Avoid duplicating fix_minus method

* Updated tests to reflect the new (correct) behavior

* Updated EngFormatter test to include axes.unicode_minus = False

* Removed plt.rcdefaults()
diff --git a/lib/matplotlib/tests/test_ticker.py b/lib/matplotlib/tests/test_ticker.py
@@ -692,33 +692,48 @@ def test_basic(self, format, input, expected):
 
 
 class TestEngFormatter(object):
-    # (input, expected) where ''expected'' corresponds to the outputs
-    # respectively returned when (places=None, places=0, places=2)
+    # (unicode_minus, input, expected) where ''expected'' corresponds to the
+    # outputs respectively returned when (places=None, places=0, places=2)
+    # unicode_minus is a boolean value for the rcParam['axes.unicode_minus']
     raw_format_data = [
-        (-1234.56789, ('-1.23457 k', '-1 k', '-1.23 k')),
-        (-1.23456789, ('-1.23457', '-1', '-1.23')),
-        (-0.123456789, ('-123.457 m', '-123 m', '-123.46 m')),
-        (-0.00123456789, ('-1.23457 m', '-1 m', '-1.23 m')),
-        (-0.0, ('0', '0', '0.00')),
-        (-0, ('0', '0', '0.00')),
-        (0, ('0', '0', '0.00')),
-        (1.23456789e-6, ('1.23457 µ', '1 µ', '1.23 µ')),
-        (0.123456789, ('123.457 m', '123 m', '123.46 m')),
-        (0.1, ('100 m', '100 m', '100.00 m')),
-        (1, ('1', '1', '1.00')),
-        (1.23456789, ('1.23457', '1', '1.23')),
-        (999.9, ('999.9', '1 k', '999.90')),  # places=0: corner-case rounding
-        (999.9999, ('1 k', '1 k', '1.00 k')),  # corner-case rounding for all
-        (-999.9999, ('-1 k', '-1 k', '-1.00 k')),  # negative corner-case
-        (1000, ('1 k', '1 k', '1.00 k')),
-        (1001, ('1.001 k', '1 k', '1.00 k')),
-        (100001, ('100.001 k', '100 k', '100.00 k')),
-        (987654.321, ('987.654 k', '988 k', '987.65 k')),
-        (1.23e27, ('1230 Y', '1230 Y', '1230.00 Y'))  # OoR value (> 1000 Y)
+        (False, -1234.56789, ('-1.23457 k', '-1 k', '-1.23 k')),
+        (True, -1234.56789, ('\N{MINUS SIGN}1.23457 k', '\N{MINUS SIGN}1 k',
+                             '\N{MINUS SIGN}1.23 k')),
+        (False, -1.23456789, ('-1.23457', '-1', '-1.23')),
+        (True, -1.23456789, ('\N{MINUS SIGN}1.23457', '\N{MINUS SIGN}1',
+                             '\N{MINUS SIGN}1.23')),
+        (False, -0.123456789, ('-123.457 m', '-123 m', '-123.46 m')),
+        (True, -0.123456789, ('\N{MINUS SIGN}123.457 m', '\N{MINUS SIGN}123 m',
+                              '\N{MINUS SIGN}123.46 m')),
+        (False, -0.00123456789, ('-1.23457 m', '-1 m', '-1.23 m')),
+        (True, -0.00123456789, ('\N{MINUS SIGN}1.23457 m', '\N{MINUS SIGN}1 m',
+                                '\N{MINUS SIGN}1.23 m')),
+        (True, -0.0, ('0', '0', '0.00')),
+        (True, -0, ('0', '0', '0.00')),
+        (True, 0, ('0', '0', '0.00')),
+        (True, 1.23456789e-6, ('1.23457 µ', '1 µ', '1.23 µ')),
+        (True, 0.123456789, ('123.457 m', '123 m', '123.46 m')),
+        (True, 0.1, ('100 m', '100 m', '100.00 m')),
+        (True, 1, ('1', '1', '1.00')),
+        (True, 1.23456789, ('1.23457', '1', '1.23')),
+        # places=0: corner-case rounding
+        (True, 999.9, ('999.9', '1 k', '999.90')),
+        # corner-case rounding for all
+        (True, 999.9999, ('1 k', '1 k', '1.00 k')),
+        # negative corner-case
+        (False, -999.9999, ('-1 k', '-1 k', '-1.00 k')),
+        (True, -999.9999, ('\N{MINUS SIGN}1 k', '\N{MINUS SIGN}1 k',
+                           '\N{MINUS SIGN}1.00 k')),
+        (True, 1000, ('1 k', '1 k', '1.00 k')),
+        (True, 1001, ('1.001 k', '1 k', '1.00 k')),
+        (True, 100001, ('100.001 k', '100 k', '100.00 k')),
+        (True, 987654.321, ('987.654 k', '988 k', '987.65 k')),
+        # OoR value (> 1000 Y)
+        (True, 1.23e27, ('1230 Y', '1230 Y', '1230.00 Y'))
     ]
 
-    @pytest.mark.parametrize('input, expected', raw_format_data)
-    def test_params(self, input, expected):
+    @pytest.mark.parametrize('unicode_minus, input, expected', raw_format_data)
+    def test_params(self, unicode_minus, input, expected):
         """
         Test the formatting of EngFormatter for various values of the 'places'
         argument, in several cases:
@@ -729,6 +744,7 @@ def test_params(self, input, expected):
         Note that cases 2. and 3. are looped over several separator strings.
         """
 
+        plt.rcParams['axes.unicode_minus'] = unicode_minus
         UNIT = 's'  # seconds
         DIGITS = '0123456789'  # %timeit showed 10-20% faster search than set
 
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -1272,6 +1272,12 @@ def set_useMathText(self, val):
 
     useMathText = property(fget=get_useMathText, fset=set_useMathText)
 
+    def fix_minus(self, s):
+        """
+        Replace hyphens with a unicode minus.
+        """
+        return ScalarFormatter.fix_minus(self, s)
+
     def __call__(self, x, pos=None):
         s = "%s%s" % (self.format_eng(x), self.unit)
         # Remove the trailing separator when there is neither prefix nor unit
