Add mathtext support for \middle

oscargus · oscargus · commit b49c314d792b · 2022-08-20T20:34:32.000+02:00
diff --git a/doc/users/next_whats_new/mathtext_middle.rst b/doc/users/next_whats_new/mathtext_middle.rst
@@ -0,0 +1,17 @@
+``mathtext`` supports ``\middle``
+---------------------------------
+
+The ``\middle`` latex command is now supported by `.mathtext`. It is a
+complement to ``\left`` and ``\right`` and used to add a middle sized
+separator. Currently, only a single ``\middle`` between ``\left`` and
+``\right`` is supported.
+
+.. plot::
+    :include-source: true
+
+    import matplotlib.pyplot as plt
+    plt.figure(figsize=(2, 1))
+    plt.figtext(
+        0.05, 0.55,
+        r"$\left\{\sum_{i=0}^x a_i \middle | x \in \mathbb{N}\right\}$",
+        size=20, math_fontfamily='cm')
diff --git a/lib/matplotlib/_mathtext.py b/lib/matplotlib/_mathtext.py
@@ -1950,7 +1950,10 @@ def csnames(group, names):
 
         p.auto_delim    <<= (
             r"\left" - (p.delim("left") | Error("Expected a delimiter"))
-            + ZeroOrMore(p.simple | p.auto_delim)("mid")
+            + ZeroOrMore(p.simple | p.auto_delim)("mid1")
+            + Optional(r"\middle" - (p.delim("mid") |
+                                     Error("Expected a delimiter")))("middle")
+            + ZeroOrMore(p.simple | p.auto_delim)("mid2")
             + r"\right" - (p.delim("right") | Error("Expected a delimiter"))
         )
 
@@ -2560,11 +2563,14 @@ def overline(self, s, loc, toks):
         hlist = Hlist([rightside])
         return [hlist]
 
-    def _auto_sized_delimiter(self, front, middle, back):
+    def _auto_sized_delimiter(self, front, mid1, back, middle=".", mid2=None):
+        if mid2 is None:
+            mid2 = []
         state = self.get_state()
-        if len(middle):
-            height = max(x.height for x in middle)
-            depth = max(x.depth for x in middle)
+        content = mid1 + mid2
+        if len(content):
+            height = max(x.height for x in content)
+            depth = max(x.depth for x in content)
             factor = None
         else:
             height = 0
@@ -2575,7 +2581,11 @@ def _auto_sized_delimiter(self, front, middle, back):
         if front != '.':
             parts.append(
                 AutoHeightChar(front, height, depth, state, factor=factor))
-        parts.extend(middle)
+        parts.extend(mid1)
+        if middle != ".":
+            parts.append(
+                AutoHeightChar(middle, height, depth, state, factor=factor))
+        parts.extend(mid2)
         if back != '.':
             parts.append(
                 AutoHeightChar(back, height, depth, state, factor=factor))
@@ -2585,6 +2595,9 @@ def _auto_sized_delimiter(self, front, middle, back):
     def auto_delim(self, s, loc, toks):
         return self._auto_sized_delimiter(
             toks["left"],
-            # if "mid" in toks ... can be removed when requiring pyparsing 3.
-            toks["mid"].asList() if "mid" in toks else [],
-            toks["right"])
+            # if "mid*" in toks ... can be removed when requiring pyparsing 3.
+            toks["mid1"].asList() if "mid1" in toks else [],
+            toks["right"],
+            toks["mid"] if "mid" in toks else ".",
+            toks["mid2"].asList() if "mid2" in toks else []
+            )
diff --git a/lib/matplotlib/_mathtext_data.py b/lib/matplotlib/_mathtext_data.py
@@ -526,7 +526,7 @@
     'succnsim'                 : 8937,
     'gimel'                    : 8503,
     'vert'                     : 124,
-    '|'                        : 124,
+    '|'                        : 8214,
     'varrho'                   : 1009,
     'P'                        : 182,
     'approxident'              : 8779,
diff --git a/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext1_dejavusans_04.png b/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext1_dejavusans_04.png
diff --git a/lib/matplotlib/tests/test_mathtext.py b/lib/matplotlib/tests/test_mathtext.py
@@ -129,6 +129,7 @@
     r'$x \overset{f}{\rightarrow} \overset{f}{x} \underset{xx}{ff} \overset{xx}{ff} \underset{f}{x} \underset{f}{\leftarrow} x$',  # github issue #18241
     r'$\sum x\quad\sum^nx\quad\sum_nx\quad\sum_n^nx\quad\prod x\quad\prod^nx\quad\prod_nx\quad\prod_n^nx$',  # GitHub issue 18085
     r'$1.$ $2.$ $19680801.$ $a.$ $b.$ $mpl.$',
+    r'$\left(\frac{x_i}{\sum x_i}\middle| x_i \in \mathcal{S}\right)$'
 ]
 
 digits = "0123456789"
diff --git a/tutorials/text/mathtext.py b/tutorials/text/mathtext.py
@@ -124,6 +124,14 @@
 
     \left(\frac{5 - \frac{1}{x}}{4}\right)
 
+There is also a ``\middle`` version for using with a middle delimiter.::
+
+    r'$\left\{x \rightarrow \frac{1}{x} \middle| x \in \mathbb{N}^+ \right\}$'
+
+.. math::
+
+    \left\{x \rightarrow \frac{1}{x} \middle| x \in \mathbb{N}^+ \right\}
+
 Radicals
 --------
 Radicals can be produced with the ``\sqrt[]{}`` command.  For example::

Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@`
`129`	`129`	`r'$x \overset{f}{\rightarrow} \overset{f}{x} \underset{xx}{ff} \overset{xx}{ff} \underset{f}{x} \underset{f}{\leftarrow} x$', # github issue #18241`
`130`	`130`	`r'$\sum x\quad\sum^nx\quad\sum_nx\quad\sum_n^nx\quad\prod x\quad\prod^nx\quad\prod_nx\quad\prod_n^nx$', # GitHub issue 18085`
`131`	`131`	`r'$1.$ $2.$ $19680801.$ $a.$ $b.$ $mpl.$',`
	`132`	`+ r'$\left(\frac{x_i}{\sum x_i}\middle\| x_i \in \mathcal{S}\right)$'`
`132`	`133`	`]`
`133`	`134`
`134`	`135`	`digits = "0123456789"`