Merge pull request CloudBotIRC#128 from linuxdaemon/gonzobot+reddit-info-fix

Clean up and fixes for reddit_info.py

Author: edwardslabs

plugins/reddit_info.py

@@ -4,14 +4,16 @@
 from datetime import datetime
 from bs4 import BeautifulSoup
 from cloudbot import hook
+from cloudbot.util import colors
+from cloudbot.util.formatting import pluralize
 
 search_pages = defaultdict(list)
 search_page_indexes = {}
 
 user_url = "http://reddit.com/user/{}/"
 subreddit_url = "http://reddit.com/r/{}/"
 # This agent should be unique for your cloudbot instance
-agent = {"User-Agent":"gonzobot a cloudbot (IRCbot) implementation for snoonet.org by /u/bloodygonzo"}
+agent = {"User-Agent": "gonzobot a cloudbot (IRCbot) implementation for snoonet.org by /u/bloodygonzo"}
 
 
 def two_lines(bigstring, chan):
@@ -30,9 +32,9 @@ def smart_truncate(content, length=355, suffix='...\n'):
     else:
         return content[:length].rsplit(' \u2022 ', 1)[0]+ suffix + content[:length].rsplit(' \u2022 ', 1)[1] + smart_truncate(content[length:])
 
+
 def statuscheck(status, item):
     """since we are doing this a lot might as well return something more meaningful"""
-    out = ""
     if status == 404:
         out = "It appears {} does not exist.".format(item)
     elif status == 403:
@@ -45,18 +47,18 @@ def statuscheck(status, item):
         out = "Reddit returned an error, response: {}".format(status)
     return out
 
+
 @hook.command("moremod", autohelp=False)
 def moremod(text, chan):
     """if a sub or mod list has lots of results the results are pagintated. If the most recent search is paginated the pages are stored for retreival. If no argument is given the next page will be returned else a page number can be specified."""
     if not search_pages[chan]:
         return "There are modlist pages to show."
     if text:
-        index = ""
         try:
             index = int(text)
-        except:
+        except ValueError:
             return "Please specify an integer value."
-        if abs(int(index)) > len(search_pages[chan]) or index == 0:
+        if abs(index) > len(search_pages[chan]) or index == 0:
             return "please specify a valid page number between 1 and {}.".format(len(search_pages[chan]))
         else:
             return "{}(page {}/{})".format(search_pages[chan][index-1], index, len(search_pages[chan]))
@@ -68,7 +70,7 @@ def moremod(text, chan):
             return "All pages have been shown."
 
 
-@hook.command("subs", "moderates", singlethreaded=True)
+@hook.command("subs", "moderates", singlethread=True)
 def moderates(text, chan):
     """This plugin prints the list of subreddits a user moderates listed in a reddit users profile. Private subreddits will not be listed."""
     #This command was written using concepts from FurCode http://github.com/FurCode.
@@ -80,14 +82,14 @@ def moderates(text, chan):
     if r.status_code != 200:
         return statuscheck(r.status_code, user)
     soup = BeautifulSoup(r.text)
-    try:
-        modlist = soup.find('ul', id="side-mod-list").text
-    except:
+    mod_list = soup.find('ul', id="side-mod-list")
+    if mod_list is None:
         return "{} does not moderate any public subreddits.".format(user)
-    modlist = modlist.split('r/')
-    del modlist[0]
-    out = "\x02{}\x02 moderates these public subreddits: ".format(user)
-    for sub in modlist:
+
+    mod_list = mod_list.text.split('r/')
+    del mod_list[0]
+    out = colors.parse("$(b){}$(b) moderates these public subreddits: ".format(user))
+    for sub in mod_list:
         out += "{} \u2022 ".format(sub)
     out = out[:-2]
     out = smart_truncate(out)
@@ -97,7 +99,7 @@ def moderates(text, chan):
     return out
 
 
-@hook.command("karma", "ruser", singlethreaded=True)
+@hook.command("karma", "ruser", singlethread=True)
 def karma(text):
     """karma <reddituser> will return the information about the specified reddit username"""
     user = text
@@ -106,28 +108,27 @@ def karma(text):
     if r.status_code != 200:
         return statuscheck(r.status_code, user)
     data = r.json()
-    out = "\x02{}\x02 ".format(user)
-    out += "\x02{:,}\x02 link karma and ".format(data['data']['link_karma'])
-    out += "\x02{:,}\x02 comment karma | ".format(data['data']['comment_karma'])
+    out = "$(b){}$(b) ".format(user)
+    out += "$(b){:,}$(b) link karma and ".format(data['data']['link_karma'])
+    out += "$(b){:,}$(b) comment karma | ".format(data['data']['comment_karma'])
     if data['data']['is_gold']:
         out += "has reddit gold | "
     if data['data']['is_mod']:
         out += "is a moderator | "
     if data['data']['has_verified_email']:
         out += "email has been verified | "
-    out += "cake day is {} | ".format(datetime.fromtimestamp(data['data']['created_utc']).strftime('%B %d') )
+    out += "cake day is {} | ".format(datetime.fromtimestamp(data['data']['created_utc']).strftime('%B %d'))
     account_age = datetime.now() - datetime.fromtimestamp(data['data']['created'])
-    if account_age.days > 365:
-        age = int(account_age.days / 365)
-        if age == 1:
-            out += "redditor for {} year.".format(age)
-        else:
-            out += "redditor for {} years.".format(age)
-    else:
-        out += "redditor for {} days.".format(account_age.days)
-    return out
+    age = account_age.days
+    age_unit = "day"
+    if age > 365:
+        age //= 365
+        age_unit = "year"
+    out += "redditor for {}.".format(pluralize(age, age_unit))
+    return colors.parse(out)
+
 
-@hook.command("cakeday", singlethreaded=True)
+@hook.command("cakeday", singlethread=True)
 def cake_day(text):
     """cakeday <reddituser> will return the cakeday for the given reddit username."""
     user = text
@@ -136,21 +137,19 @@ def cake_day(text):
     if r.status_code != 200:
         return statuscheck(r.status_code, user)
     data = r.json()
-    out = "\x02{}'s\x02 ".format(user)
-    out += "cake day is {}, ".format(datetime.fromtimestamp(data['data']['created_utc']).strftime('%B %d') )
+    out = colors.parse("$(b){}'s$(b) ".format(user))
+    out += "cake day is {}, ".format(datetime.fromtimestamp(data['data']['created_utc']).strftime('%B %d'))
     account_age = datetime.now() - datetime.fromtimestamp(data['data']['created'])
-    if account_age.days > 365:
-        age = int(account_age.days / 365)
-        if age == 1:
-            out += "they have been a redditor for {} year.".format(age)
-        else:
-            out += "they have been a redditor for {} years.".format(age)
-    else:
-        out += "they have been a redditor for {} days.".format(account_age.days)
+    age = account_age.days
+    age_unit = "day"
+    if age > 365:
+        age //= 365
+        age_unit = "year"
+    out += "they have been a redditor for {}.".format(pluralize(age, age_unit))
     return out
 
+
 def time_format(numdays):
-    age = ()
     if numdays >= 365:
         age = (int(numdays / 365), "y")
         if age[0] > 1:
@@ -159,7 +158,8 @@ def time_format(numdays):
         age = (numdays, "d")
     return age
 
-@hook.command("submods", "mods", "rmods", singlethreaded=True)
+
+@hook.command("submods", "mods", "rmods", singlethread=True)
 def submods(text, chan):
     """submods <subreddit> prints the moderators of the specified subreddit."""
     global search_pages
@@ -175,7 +175,7 @@ def submods(text, chan):
     if r.status_code != 200:
         return statuscheck(r.status_code, 'r/'+sub)
     data = r.json()
-    out = "/r/\x02{}\x02 mods: ".format(sub)
+    out = colors.parse("/r/$(b){}$(b) mods: ".format(sub))
     for mod in data['data']['children']:
         username = mod['name']
         # Showing the modtime makes the message too long for larger subs
@@ -190,7 +190,8 @@ def submods(text, chan):
         return "{}(page {}/{}) .moremod".format(out, search_page_indexes[chan] + 1, len(search_pages[chan]))
     return out
 
-@hook.command("subinfo","subreddit", "sub", "rinfo", singlethreaded=True)
+
+@hook.command("subinfo","subreddit", "sub", "rinfo", singlethread=True)
 def subinfo(text):
     """subinfo <subreddit> fetches information about the specified subreddit."""
     sub = text
@@ -211,12 +212,10 @@ def subinfo(text):
     subscribers = data['data']['subscribers']
     active = data['data']['accounts_active']
     sub_age = datetime.now() - datetime.fromtimestamp(data['data']['created'])
-    age = ()
-    if sub_age.days >= 365:
-        age = (int(sub_age.days / 365), "y")
-    else:
-        age = (sub_age.days, "d")
-    out = "/r/\x03{}\x02 - {} - a community for {}{}, there are {:,} subscribers and {:,} people online now.".format(name, title, age[0], age[1], subscribers, active)
+    age, age_unit = time_format(sub_age.days)
+    out = "/r/$(b){}$(clear) - {} - a community for {}{}, there are {:,} subscribers and {:,} people online now.".format(
+        name, title, age, age_unit, subscribers, active
+    )
     if nsfw:
-        out += " \x0304NSFW\x0304"
-    return out
+        out += " $(red)NSFW$(clear)"
+    return colors.parse(out)