Add text chunking function

Author: dmptrluke

cloudbot/util/formatting.py

@@ -168,6 +168,19 @@ def truncate(content, length=100, suffix='...'):
 strip_colors = strip_irc
 
 
+def chunk_str(content, length=420):
+    """
+    Chunks a string into smaller strings of given length. Returns chunks.
+    :rtype list
+    """
+    def chunk(c, l):
+        while c:
+            out = (c+' ')[:l].rsplit(' ', 1)[0]
+            c = c[len(out):].strip()
+            yield out
+    return list(chunk(content, length))
+
+
 def pluralize(num=0, text=''):
     """
     Takes a number and a string, and pluralizes that string using the number and combines the results.

plugins/books.py

@@ -18,6 +18,7 @@ def books(text):
     """books <query> -- Searches Google Books for <query>."""
     if not dev_key:
         return "This command requires a Google Developers Console API key."
+    formatting.HTMLTextExtractor
 
     json = requests.get(book_search_api, params={"q": text, "key": dev_key}).json()
 

plugins/help.py

@@ -3,6 +3,7 @@
 import re
 
 from cloudbot import hook
+from cloudbot.util import formatting
 
 
 @asyncio.coroutine
@@ -37,13 +38,7 @@ def help_command(text, conn, bot, notice, has_permission):
         else:
             notice("Unknown command '{}'".format(searching_for))
     else:
-
-        # list of lines to send to the user
-        lines = []
-        # current line, containing words to join with " "
-        current_line = []
-        # current line length, to count how long the current line will be when joined with " "
-        current_line_length = 0
+        commands = []
 
         for plugin in sorted(set(bot.plugin_manager.commands.values()), key=attrgetter("name")):
             # use set to remove duplicate commands (from multiple aliases), and sorted to sort by name
@@ -62,22 +57,12 @@ def help_command(text, conn, bot, notice, has_permission):
 
             # add the command to lines sent
             command = plugin.name
-            added_length = len(command) + 2  # + 2 to account for space and comma
 
-            if current_line_length + added_length > 450:
-                # if line limit is reached, add line to lines, and reset
-                lines.append(", ".join(current_line) + ",")
-                current_line = []
-                current_line_length = 0
+            commands.append(command)
 
-            current_line.append(command)
-            current_line_length += added_length
-
-        if current_line:
-            # make sure to include the last line
-            lines.append(", ".join(current_line))
+        # list of lines to send to the user
+        lines = formatting.chunk_str("Here's a list of commands you can use: " + ", ". join(commands))
 
-        notice("Here's a list of commands you can use:")
         for line in lines:
             notice(line)
         notice("For detailed help, use {}help <command>, without the brackets.".format(conn.config["command_prefix"]))