Let text_utils work with strings that contain ansi escape sequences.

[python_utils.git] / string_utils.py

diff --git a/string_utils.py b/string_utils.py
index a766adabe97ffc8432a9bda280c66107634bc52b..37851e04e7e5cba26ea0ac6032635e3ca5bfa2ed 100644 (file)
--- a/string_utils.py
+++ b/string_utils.py
@@ -1218,6 +1218,22 @@ def sprintf(*args, **kwargs) -> str:
     return ret
 
 
+def strip_ansi_sequences(in_str: str) -> str:
+    """Strips ANSI sequences out of strings.
+
+    >>> import ansi as a
+    >>> s = a.fg('blue') + 'blue!' + a.reset()
+    >>> len(s)   # '\x1b[38;5;21mblue!\x1b[m'
+    18
+    >>> len(strip_ansi_sequences(s))
+    5
+    >>> strip_ansi_sequences(s)
+    'blue!'
+
+    """
+    return re.sub(r'\x1b\[[\d+;]*[a-z]', '', in_str)
+
+
 class SprintfStdout(contextlib.AbstractContextManager):
     """
     A context manager that captures outputs to stdout.
@@ -1680,16 +1696,16 @@ def replace_all(in_str: str, replace_set: str, replacement: str) -> str:
     return in_str
 
 
-def replace_nth(string: str, source: str, target: str, nth: int):
+def replace_nth(in_str: str, source: str, target: str, nth: int):
     """Replaces the nth occurrance of a substring within a string.
 
     >>> replace_nth('this is a test', ' ', '-', 3)
     'this is a-test'
 
     """
-    where = [m.start() for m in re.finditer(source, string)][nth - 1]
-    before = string[:where]
-    after = string[where:]
+    where = [m.start() for m in re.finditer(source, in_str)][nth - 1]
+    before = in_str[:where]
+    after = in_str[where:]
     after = after.replace(source, target, 1)
     return before + after