Fix typo.

[python_utils.git] / string_utils.py

diff --git a/string_utils.py b/string_utils.py
index a766adabe97ffc8432a9bda280c66107634bc52b..a2f46332156e0c5fc41f3db8a8228a149272651c 100644 (file)
--- a/string_utils.py
+++ b/string_utils.py
@@ -857,6 +857,10 @@ def words_count(in_str: str) -> int:
     return len(WORDS_COUNT_RE.findall(in_str))
 
 
+def word_count(in_str: str) -> int:
+    return words_count(in_str)
+
+
 def generate_uuid(omit_dashes: bool = False) -> str:
     """
     Generated an UUID string (using `uuid.uuid4()`).
@@ -876,7 +880,9 @@ def generate_random_alphanumeric_string(size: int) -> str:
     Returns a string of the specified size containing random
     characters (uppercase/lowercase ascii letters and digits).
 
-    random_string(9) # possible output: "cx3QQbzYg"
+    >>> random.seed(22)
+    >>> generate_random_alphanumeric_string(9)
+    '96ipbNClS'
 
     """
     if size < 1:
@@ -971,6 +977,10 @@ def shuffle(in_str: str) -> str:
     return from_char_list(chars)
 
 
+def scramble(in_str: str) -> str:
+    return shuffle(in_str)
+
+
 def strip_html(in_str: str, keep_tag_content: bool = False) -> str:
     """
     Remove html code contained into the given string.
@@ -1218,6 +1228,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 +1706,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