Improve pgf special escapes.

anntzer · anntzer · commit ecc437b1d00d · 2020-11-01T00:56:37.000+01:00
- In common_texification.py, when splitting math and non-math segments,
  match *two* dollar signs surrounding a math segment rather than single
  dollar signs; this lets us correctly handle e.g. `$2` which we
  explicitly support in other backends as being plain text, not
  unbalanced math (the previous implementation would handle that as
  math).
- Instead of adding `\displaystyle` in front of each and every math block,
  use the TeX-provided `\everymath` mechanism to just register that
  once (this basically auto-prepends `\displaystyle` before every math
  block).
- Define `\mathdefault` as a noop (which is consistent with what
  texmanager does) instead of stripping it out, which would allow e.g.
  for the possibility that someone redefines `\mathdefault` in whatever
  way they want.
diff --git a/doc/api/next_api_changes/deprecations/18856-AL.rst b/doc/api/next_api_changes/deprecations/18856-AL.rst
@@ -0,0 +1,3 @@
+backend_pgf deprecations
+~~~~~~~~~~~~~~~~~~~~~~~~
+``backend_pgf.re_mathsep`` is deprecated.
diff --git a/lib/matplotlib/backends/backend_pgf.py b/lib/matplotlib/backends/backend_pgf.py
@@ -75,42 +75,25 @@ def get_preamble():
 # helper functions
 
 NO_ESCAPE = r"(?<!\\)(?:\\\\)*"
-re_mathsep = re.compile(NO_ESCAPE + r"\$")
-
-
+re_mathsep = re.compile(NO_ESCAPE + r"\$")  # Deprecated in 3.4.
+_split_math = re.compile(rf"({NO_ESCAPE}\$.*?{NO_ESCAPE}\$)").split
 _replace_escapetext = functools.partial(
     # When the next character is _, ^, $, or % (not preceded by an escape),
     # insert a backslash.
     re.compile(NO_ESCAPE + "(?=[_^$%])").sub, "\\\\")
-_replace_mathdefault = functools.partial(
-    # Replace \mathdefault (when not preceded by an escape) by empty string.
-    re.compile(NO_ESCAPE + r"(\\mathdefault)").sub, "")
 
 
 def common_texification(text):
     r"""
     Do some necessary and/or useful substitutions for texts to be included in
     LaTeX documents.
 
-    This distinguishes text-mode and math-mode by replacing the math separator
-    ``$`` with ``\(\displaystyle %s\)``. Escaped math separators (``\$``)
-    are ignored.
-
-    The following characters are escaped in text segments: ``_^$%``
+    The characters ``_^$%`` are escaped in text mode (i.e., outside of math
+    blocks).
     """
-    # Sometimes, matplotlib adds the unknown command \mathdefault.
-    # Not using \mathnormal instead since this looks odd for the latex cm font.
-    text = _replace_mathdefault(text)
-    # split text into normaltext and inline math parts
-    parts = re_mathsep.split(text)
-    for i, s in enumerate(parts):
-        if not i % 2:
-            # textmode replacements
-            s = _replace_escapetext(s)
-        else:
-            # mathmode replacements
-            s = r"\(\displaystyle %s\)" % s
-        parts[i] = s
+    parts = _split_math(text)  # split into normal text and inline math parts
+    for i in range(0, len(parts), 2):
+        parts[i] = _replace_escapetext(parts[i])  # textmode replacements
     return "".join(parts)
 
 
@@ -216,6 +199,8 @@ def _build_latex_header():
             r"\usepackage{graphicx}",
             latex_preamble,
             latex_fontspec,
+            r"\def\mathdefault#1{#1}",
+            r"\everymath=\expandafter{\the\everymath\displaystyle}",
             r"\begin{document}",
             r"text $math \mu$",  # force latex to load fonts now
             r"\typeout{pgf_backend_query_start}",
@@ -827,6 +812,8 @@ def _print_pgf_to_fh(self, fh, *, bbox_inches_restore=None):
         fh.write("\n")
         writeln(fh, r"\begingroup")
         writeln(fh, r"\makeatletter")
+        writeln(fh, r"\def\mathdefault#1{#1}")
+        writeln(fh, r"\everymath=\expandafter{\the\everymath\displaystyle}")
         writeln(fh, r"\begin{pgfpicture}")
         writeln(fh,
                 r"\pgfpathrectangle{\pgfpointorigin}{\pgfqpoint{%fin}{%fin}}"
diff --git a/lib/matplotlib/tests/test_backend_pgf.py b/lib/matplotlib/tests/test_backend_pgf.py
@@ -90,8 +90,10 @@ def create_figure():
 
 
 @pytest.mark.parametrize('plain_text, escaped_text', [
-    (r'quad_sum: $\sum x_i^2$', r'quad\_sum: \(\displaystyle \sum x_i^2\)'),
+    (r'quad_sum: $\sum x_i^2$', r'quad\_sum: $\sum x_i^2$'),
     (r'no \$splits \$ here', r'no \$splits \$ here'),
+    ('2$', '2$'),
+    ('$2', '$2'),
     ('with_underscores', r'with\_underscores'),
     ('% not a comment', r'\% not a comment'),
     ('^not', r'\^not'),

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+backend_pgf deprecations`
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	+``backend_pgf.re_mathsep`` is deprecated.