Move function "escape_text" to _text.py

Author: Gorshanov Vadim

src/tikzplotlib/_line2d.py

@@ -1,13 +1,13 @@
 import datetime
 
 import numpy as np
-import re
 from matplotlib.dates import num2date
 
 from . import _color as mycol
 from . import _files
 from . import _path as mypath
 from ._markers import _mpl_marker2pgfp_marker
+from ._text import escape_text
 from ._util import get_legend_text, has_legend, transform_to_data_coordinates
 
 
@@ -101,12 +101,7 @@ def draw_line2d(data, obj):
     content += c
 
     if legend_text is not None:
-        legend_text_escaped = re.sub(r"(\d+(\.\d+)?)\s?%",
-                                     r"\\SI{\1}{\\percent}",
-                                     legend_text).replace("+-\\SI{",
-                                     "\\SI{+-").replace(", s",
-                                     ", \\SI{\s}")
-        content.append(f"\\addlegendentry{{{legend_text_escaped}}}\n")
+        content.append(f"\\addlegendentry{{{escape_text(legend_text)}}}\n")
 
     return data, content
 

src/tikzplotlib/_text.py

@@ -1,8 +1,44 @@
 import matplotlib as mpl
+import re
 from matplotlib.patches import ArrowStyle
 
 from . import _color
 
+def escape_text(text):
+    """
+    Escapes certain patterns in a given text to make them compatible with
+    LaTeX formatting, especially for SI units.
+
+    Parameters:
+    - text (str): The input string that needs to be processed for LaTeX-
+    compatible escapes.
+
+    Returns:
+    - str: The text with escaped patterns suitable for LaTeX rendering.
+
+    The function primarily performs the following conversions:
+    1. Converts percentages, e.g., "45%", "45.5 %", to the LaTeX SI
+    unit format: "\\SI{45}{\\percent}".
+    2. Fixes potential issues with the "\\SI" unit for the plus-minus
+    notation.
+    3. Corrects ", s" patterns to ", \\SI{\\s}".
+
+    Note:
+    This function assumes that the input text is likely to contain numeric
+    values that need to be presented using SI notation in LaTeX. For
+    correct rendering, the siunitx LaTeX package should be included in
+    the document.
+
+    Example:
+    Given the input: "The efficiency is 45% and the tolerance is
+    +-\\SI{2}{\\degree}, s"
+    The output will be: "The efficiency is \\SI{45}{\\percent} and
+    the tolerance is \\SI{+-2}{\\degree}, \\SI{\s}"
+    """
+    return re.sub(r"(\d+(\.\d+)?)\s?%", r"\\SI{\1}{\\percent}",
+                  text).replace("+-\\SI{", "\\SI{+-").replace(", s",
+                                ", \\SI{\\s}")
+
 
 def draw_text(data, obj):
     """Paints text on the graph."""