Add strip_irc and strip_all to colors.py

Author: dmptrluke

cloudbot/util/colors.py

@@ -78,6 +78,7 @@
 
 
 COLOR_RE = re.compile(r"\$\(.*?\)", re.I)
+IRC_COLOR_RE = re.compile(r"(\x03(\d+,\d+|\d)|[\x0f\x02\x16\x1f])", re.I)
 
 
 def get_color(colour, return_formatted=True):
@@ -154,8 +155,13 @@ def parse(string):
     return formatted
 
 
+# Color stripping.
+
 def strip(string):
-    """strip: Similiar to parse, only this removes colour codes"""
+    """
+    Removes all $() syntax color codes from the input string and returns it.
+    :rtype str
+    """
 
     stripped = ""
 
@@ -166,6 +172,27 @@ def strip(string):
     return stripped.strip()
 
 
+def strip_irc(string):
+    """
+    Removes all raw MIRC color codes from the input string and returns it.
+    :rtype str
+    """
+
+    return IRC_COLOR_RE.sub('', string)
+
+
+def strip_all(string):
+    """
+    Removes all $() syntax and MIRC color codes from the input string and returns it.
+    :rtype str
+    """
+
+    # we run strip_irc twice to avoid people putting a $() color code inside a MIRC one
+    return strip_irc(strip(strip_irc(string)))
+
+
+# Internal use
+
 def _convert(string):
     if not string.startswith("$(") and not string.endswith(")"):
         return string
@@ -183,4 +210,4 @@ def _convert(string):
         elif formatting in IRC_FORMATTING_DICT:
             ret += get_format(formatting)
 
-    return ret.strip()
+    return ret.strip()

cloudbot/util/formatting.py

@@ -6,6 +6,8 @@
 
 from html.parser import HTMLParser
 
+from cloudbot.util.colors import strip_irc
+
 
 # Constants
 
@@ -163,17 +165,7 @@ def truncate(content, length=100, suffix='...'):
 
 # compatibility
 truncate_str = truncate
-
-
-def strip_colors(text):
-    """
-    Takes a string and removes all IRC color codes.
-    :param text: Text to strip
-    :type text: str
-    :return Text stripped of IRC colors
-    :rtype str
-    """
-    return IRC_COLOR_RE.sub('', text)
+strip_colors = strip_irc
 
 
 def pluralize(num=0, text=''):

cloudbot/util/test/test_colors.py

@@ -1,20 +1,26 @@
 import pytest
 
 from cloudbot.util.colors import parse, strip, get_available_colours, get_available_formats, get_color, get_format, \
-    _convert, IRC_COLOUR_DICT
+    _convert, strip_irc, strip_all, IRC_COLOUR_DICT
 
 test_input = "The quick $(brown, red)brown$(clear) fox$(fake) jumps over the $(bold)lazy dog$(clear)."
 
 test_parse_output = "The quick \x0305,04brown\x0f fox jumps over the \x02lazy dog\x0f."
 test_strip_output = "The quick brown fox jumps over the lazy dog."
 
+test_strip_irc_input = "\x02I am $(bold)bold\x02"
+test_strip_irc_result = "I am $(bold)bold"
+test_strip_all_result = "I am bold"
+
 
 def test_parse():
     assert parse(test_input) == test_parse_output
 
 
 def test_strip():
     assert strip(test_input) == test_strip_output
+    assert strip_irc(test_strip_irc_input) == test_strip_irc_result
+    assert strip_all(test_strip_irc_input) == test_strip_all_result
 
 
 def test_available_colors():

cloudbot/util/test/test_formatting.py

@@ -55,6 +55,7 @@ def test_pluralize():
 
 
 def test_strip_colors():
+    # compatibility
     assert strip_colors(test_strip_colors_input) == test_strip_colors_result