Add text.parse_math rcParams

oscargus · oscargus · commit b7dbd2803a97 · 2022-03-02T13:31:48.000+01:00
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -296,6 +296,8 @@
                          # Values  other than 0 or 6 have no defined meaning.
 #text.antialiased: True  # If True (default), the text will be antialiased.
                          # This only affects raster outputs.
+#text.parse_math: True  # Use mathtext if there is an even number of unescaped
+                        # dollar signs.
 
 
 ## ***************************************************************************
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -918,6 +918,7 @@ def _convert_validator_spec(key, conv):
     "text.hinting_factor": validate_int,
     "text.kerning_factor": validate_int,
     "text.antialiased":    validate_bool,
+    "text.parse_math":     validate_bool,
 
     "mathtext.cal":            validate_font_properties,
     "mathtext.rm":             validate_font_properties,
diff --git a/lib/matplotlib/tests/test_text.py b/lib/matplotlib/tests/test_text.py
@@ -755,6 +755,20 @@ def test_parse_math():
         fig.canvas.draw()
 
 
+def test_parse_math_rcparams():
+    # Default is True
+    fig, ax = plt.subplots()
+    ax.text(0, 0, r"$ \wrong{math} $")
+    with pytest.raises(ValueError, match='Unknown symbol'):
+        fig.canvas.draw()
+
+    # Setting rcParams to False
+    plt.rcParams['text.parse_math'] = False
+    fig, ax = plt.subplots()
+    ax.text(0, 0, r"$ \wrong{math} $")
+    fig.canvas.draw()
+
+
 @image_comparison(['text_pdf_font42_kerning.pdf'], style='mpl20')
 def test_pdf_font42_kerning():
     plt.rcParams['pdf.fonttype'] = 42
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -130,19 +130,19 @@ def __repr__(self):
 
     def __init__(self,
                  x=0, y=0, text='',
-                 color=None,           # defaults to rc params
+                 color=None,
                  verticalalignment='baseline',
                  horizontalalignment='left',
                  multialignment=None,
                  fontproperties=None,  # defaults to FontProperties()
                  rotation=None,
                  linespacing=None,
                  rotation_mode=None,
-                 usetex=None,          # defaults to rcParams['text.usetex']
+                 usetex=None,
                  wrap=False,
                  transform_rotates_text=False,
                  *,
-                 parse_math=True,
+                 parse_math=None,
                  **kwargs
                  ):
         """
@@ -156,8 +156,7 @@ def __init__(self,
         self._x, self._y = x, y
         self._text = ''
         self.set_text(text)
-        self.set_color(
-            color if color is not None else mpl.rcParams["text.color"])
+        self.set_color(color)
         self.set_fontproperties(fontproperties)
         self.set_usetex(usetex)
         self.set_parse_math(parse_math)
@@ -934,8 +933,11 @@ def set_color(self, color):
 
         Parameters
         ----------
-        color : color
+        color : color, default: :rc:`text.color`
         """
+        if color is None:
+            color = mpl.rcParams["text.color"]
+
         # "auto" is only supported by axisartist, but we can just let it error
         # out at draw time for simplicity.
         if not cbook._str_equal(color, "auto"):
@@ -1269,9 +1271,8 @@ def set_usetex(self, usetex):
         """
         Parameters
         ----------
-        usetex : bool or None
-            Whether to render using TeX, ``None`` means to use
-            :rc:`text.usetex`.
+        usetex : bool, default: :rc:`text.usetex`
+            Whether to render using TeX.
         """
         if usetex is None:
             self._usetex = mpl.rcParams['text.usetex']
@@ -1289,11 +1290,14 @@ def set_parse_math(self, parse_math):
 
         Parameters
         ----------
-        parse_math : bool
+        parse_math : bool, default: :rc:`text.parse_math`
             If False, this `Text` will never use mathtext.  If True, mathtext
             will be used if there is an even number of unescaped dollar signs.
         """
-        self._parse_math = bool(parse_math)
+        if parse_math is None:
+            self._parse_math = mpl.rcParams['text.parse_math']
+        else:
+            self._parse_math = bool(parse_math)
 
     def get_parse_math(self):
         """Return whether mathtext parsing is considered for this `Text`."""
