ENH: add math mode with parentheses III

pandas-dev · mroeschke · Mar 31, 2023 · Mar 11, 2023 · Mar 11, 2023 · Mar 14, 2023
commit 29e357c8eb420006315255d4126731a12616b112
@@ -988,8 +988,9 @@ def format(
             ``{``, ``}``, ``~``, ``^``, and ``\`` in the cell display string with
             LaTeX-safe sequences.
             Use 'latex-math' to replace the characters the same way as in 'latex' mode,
-            except for math substrings, which start and end with ``$``.
-            Escaping is done before ``formatter``.
+            except for math substrings, which either are surrounded
+            by two characters ``$`` or start with the character ``\(`` and
+            end with ``\)``. Escaping is done before ``formatter``.
 
             .. versionadded:: 1.3.0
 
@@ -2359,8 +2360,7 @@ def _escape_latex(s):
         Escaped string
     """
     return (
-        s.replace("\\ ", "ab2§=§8yz")
-        .replace("\\", "ab2§=§8yz")  # rare string for final conversion: avoid \\ clash
+        s.replace("\\", "ab2§=§8yz")  # rare string for final conversion: avoid \\ clash
         .replace("ab2§=§8yz ", "ab2§=§8yz\\space ")  # since \backslash gobbles spaces
         .replace("&", "\\&")
         .replace("%", "\\%")
@@ -2377,6 +2377,75 @@ def _escape_latex(s):
     )
 
 
+def _math_mode_with_dollar(s):
+    r"""
+    All characters in LaTeX math mode are preserved.
+
+    The substrings in LaTeX math mode, which start with
+    the character ``$`` and end with ``$``, are preserved
+    without escaping. Otherwise regular LaTeX escaping applies.
+
+    Parameters
+    ----------
+    s : str
+        Input to be escaped
+
+    Return
+    ------
+    str :
+        Escaped string
+    """
+    s = s.replace(r"\$", r"rt8§=§7wz")
+    pattern = re.compile(r"\$.*?\$")
+    pos = 0
+    ps = pattern.search(s, pos)
+    res = []
+    while ps:
+        res.append(_escape_latex(s[pos : ps.span()[0]]))
+        res.append(ps.group())
+        pos = ps.span()[1]
+        ps = pattern.search(s, pos)
+
+    res.append(_escape_latex(s[pos : len(s)]))
+    return "".join(res).replace(r"rt8§=§7wz", r"\$")
+
+
+def _math_mode_with_parentheses(s):
+    r"""
+    All characters in LaTeX math mode are preserved.
+
+    The substrings in LaTeX math mode, which start with
+    the character ``\(`` and end with ``\)``, are preserved
+    without escaping. Otherwise regular LaTeX escaping applies.
+
+    Parameters
+    ----------
+    s : str
+        Input to be escaped
+
+    Return
+    ------
+    str :
+        Escaped string
+    """
+    s = s.replace(r"\(", r"LEFT§=§6yzLEFT").replace(r"\)", r"RIGHTab5§=§RIGHT")
+    res = []
+    for item in re.split(r"LEFT§=§6yz|ab5§=§RIGHT", s):
+        if item.startswith("LEFT") and item.endswith("RIGHT"):
+            res.append(item.replace("LEFT", r"\(").replace("RIGHT", r"\)"))
+        elif "LEFT" in item and "RIGHT" in item:
+            res.append(
+                _escape_latex(item).replace("LEFT", r"\(").replace("RIGHT", r"\)")
+            )
+        else:
+            res.append(
+                _escape_latex(item)
+                .replace("LEFT", r"\textbackslash (")
+                .replace("RIGHT", r"\textbackslash )")
+            )
+    return "".join(res)
+
+
 def _escape_latex_math(s):
     r"""
     All characters in LaTeX math mode are preserved.
@@ -2395,43 +2464,9 @@ def _escape_latex_math(s):
     str :
         Escaped string
     """
-
-    def _math_mode_with_dollar(s):
-        s = s.replace(r"\$", r"rt8§=§7wz")
-        pattern = re.compile(r"\$.*?\$")
-        pos = 0
-        ps = pattern.search(s, pos)
-        res = []
-        while ps:
-            res.append(_escape_latex(s[pos : ps.span()[0]]))
-            res.append(ps.group())
-            pos = ps.span()[1]
-            ps = pattern.search(s, pos)
-
-        res.append(_escape_latex(s[pos : len(s)]))
-        return "".join(res).replace(r"rt8§=§7wz", r"\$")
-
-    def _math_mode_with_parentheses(s):
-        s = s.replace(r"\(", r"LEFT§=§6yzLEFT").replace(r"\)", r"RIGHTab5§=§RIGHT")
-        res = []
-        for item in re.split(r"LEFT§=§6yz|ab5§=§RIGHT", s):
-            if item.startswith("LEFT") and item.endswith("RIGHT"):
-                res.append(item.replace("LEFT", r"\(").replace("RIGHT", r"\)"))
-            elif "LEFT" in item and "RIGHT" in item:
-                res.append(
-                    _escape_latex(item).replace("LEFT", r"\(").replace("RIGHT", r"\)")
-                )
-            else:
-                res.append(
-                    _escape_latex(item)
-                    .replace("LEFT", r"\textbackslash (")
-                    .replace("RIGHT", r"\textbackslash )")
-                )
-        return "".join(res)
-
     s = s.replace(r"\$", r"rt8§=§7wz")
     pattern_d = re.compile(r"\$.*?\$")
-    pattern_p = re.compile(r"\\(.*?\\)")
+    pattern_p = re.compile(r"\(.*?\)")
     pos_d = 0
     pos_p = 0
     ps_d = pattern_d.search(s, pos_d)
@@ -2443,7 +2478,9 @@ def _math_mode_with_parentheses(s):
         mode.append(ps_p.span()[0])
     if len(mode) == 0:
         return _escape_latex(s.replace(r"\$", r"rt8§=§7wz"))
-    if s[min(mode)] == r"$":
+    if s[mode[0]] == r"$":
         return _math_mode_with_dollar(s.replace(r"\$", r"rt8§=§7wz"))
-    else:
+    if s[mode[0] - 1 : mode[0] + 1] == r"\(":
         return _math_mode_with_parentheses(s.replace(r"\$", r"rt8§=§7wz"))
+    else:
+        return _escape_latex(s.replace(r"\$", r"rt8§=§7wz"))
diff --git a/pandas/tests/io/formats/style/test_format.py b/pandas/tests/io/formats/style/test_format.py
@@ -167,7 +167,7 @@ def test_format_clear(styler, func, attr, kwargs):
             "latex",
             '<>\\&"\\%\\$\\#\\_\\{\\}\\textasciitilde \\textasciicircum '
             "\\textbackslash \\textasciitilde \\space \\textasciicircum \\space "
-            "\\textbackslash ",
+            "\\textbackslash \\space ",
         ),
     ],
 )
@@ -200,7 +200,8 @@ def test_format_escape_html(escape, exp):
             "".join(
                 [
                     r"$ \$&%#_{}~^\ $ ",
-                    r"\&\%\#\_\{\}\textasciitilde \textasciicircum \textbackslash \$",
+                    r"\&\%\#\_\{\}\textasciitilde \textasciicircum ",
+                    r"\textbackslash \space \$",
                 ]
             ),
         ),
@@ -210,7 +211,7 @@ def test_format_escape_html(escape, exp):
                 [
                     r"\( &%#_{}~^\ \) ",
                     r"\&\%\#\_\{\}\textasciitilde \textasciicircum ",
-                    r"\textbackslash \textbackslash (",
+                    r"\textbackslash \space \textbackslash (",
                 ]
             ),
         ),