Merge pull request CloudBotIRC#176 from edillingham/karma_cleanup

fixed karma plugin docstrings & most pep8 violations

Author: edwardslabs

plugins/karma.py

@@ -8,6 +8,7 @@
 karmaminus_re = re.compile('^.*\-\-$')
 db_ready = []
 
+
 def db_init(db, conn_name):
     """Check to see if the DB has the herald table. Connection name is for caching the result per connection.
     :type db: sqlalchemy.orm.Session
@@ -21,10 +22,10 @@ def db_init(db, conn_name):
 
 @hook.command("pp", "addpoint")
 def addpoint(text, nick, chan, db, conn):
-    """.addpoint or (.pp) <thing> adds a point to the <thing>"""
+    """<thing> - adds a point to the <thing>"""
     text = text.strip()
     db_init(db, conn.name)
-    karma = db.execute("select score from karma where name = :name and chan = :chan and thing = :thing", {'name':nick, 'chan': chan, 'thing': text.lower()}).fetchone()
+    karma = db.execute("select score from karma where name = :name and chan = :chan and thing = :thing", {'name': nick, 'chan': chan, 'thing': text.lower()}).fetchone()
     if karma:
         score = int(karma[0])
         score = score + 1
@@ -34,70 +35,74 @@ def addpoint(text, nick, chan, db, conn):
     else:
         db.execute("insert or replace into karma(name, chan, thing, score) values (:name, :chan, :thing, :score)", {'name': nick, 'chan': chan, 'thing': text.lower(), 'score': 1})
         db.commit()
-        #return "{} is now worth 1 in {}'s eyes.".format(text, nick)
+        # return "{} is now worth 1 in {}'s eyes.".format(text, nick)
+
 
 @hook.regex(karmaplus_re)
 def re_addpt(match, nick, chan, db, conn, notice):
     """no useful help txt"""
     thing = match.group().split('++')[0]
     if thing:
         addpoint(thing, nick, chan, db, conn)
-        #return out
+        # return out
     else:
         notice(pluspts(nick, chan, db, conn))
 
+
 @hook.command("mm", "rmpoint")
 def rmpoint(text, nick, chan, db, conn):
-    """.rmpoint or (.mm) <thing> subtracts a point from the <thing>"""
+    """<thing> - subtracts a point from the <thing>"""
     text = text.strip()
     db_init(db, conn.name)
-    karma = db.execute("select score from karma where name = :name and chan = :chan and thing = :thing", {'name':nick, 'chan': chan, 'thing': text.lower()}).fetchone()
+    karma = db.execute("select score from karma where name = :name and chan = :chan and thing = :thing", {'name': nick, 'chan': chan, 'thing': text.lower()}).fetchone()
     if karma:
         score = int(karma[0])
         score = score - 1
         db.execute("insert or replace into karma(name, chan, thing, score) values (:name, :chan, :thing, :score)", {'name': nick, 'chan': chan, 'thing': text.lower(), 'score': score})
         db.commit()
-        #return "{} is now worth {} in {}'s eyes.".format(text, score, nick)
+        # return "{} is now worth {} in {}'s eyes.".format(text, score, nick)
     else:
         db.execute("insert or replace into karma(name, chan, thing, score) values (:name, :chan, :thing, :score)", {'name': nick, 'chan': chan, 'thing': text.lower(), 'score': -1})
         db.commit()
-        #return "{} is now worth -1 in {}'s eyes.".format(text, nick)
+        # return "{} is now worth -1 in {}'s eyes.".format(text, nick)
 
 
 @hook.command("pluspts", autohelp=False)
 def pluspts(nick, chan, db, conn):
-    """prints the things you have liked"""
+    """- prints the things you have liked and their scores"""
     db_init(db, conn.name)
     output = ""
-    likes = db.execute("select thing, score from karma where name = :name and chan = :chan and score >= 0 order by score desc", { 'name': nick, 'chan': chan }).fetchall()
+    likes = db.execute("select thing, score from karma where name = :name and chan = :chan and score >= 0 order by score desc", {'name': nick, 'chan': chan}).fetchall()
     for like in likes:
-       output = output + str(like[0]) + " has " + str(like[1]) + " points "
+        output = output + str(like[0]) + " has " + str(like[1]) + " points "
     return output
 
+
 @hook.command("minuspts", autohelp=False)
 def minuspts(nick, chan, db, conn):
-    """prints the things you have liked"""
+    """- prints the things you have disliked and their scores"""
     db_init(db, conn.name)
     output = ""
-    likes = db.execute("select thing, score from karma where name = :name and chan = :chan and score <= 0 order by score", { 'name': nick, 'chan': chan }).fetchall()
+    likes = db.execute("select thing, score from karma where name = :name and chan = :chan and score <= 0 order by score", {'name': nick, 'chan': chan}).fetchall()
     for like in likes:
-       output = output + str(like[0]) + " has " + str(like[1]) + " points "
+        output = output + str(like[0]) + " has " + str(like[1]) + " points "
     return output
 
+
 @hook.regex(karmaminus_re)
 def re_rmpt(match, nick, chan, db, conn, notice):
     """no useful help txt"""
     thing = match.group().split('--')[0]
     if thing:
         rmpoint(thing, nick, chan, db, conn)
-        #return out
+        # return out
     else:
         notice(minuspts(nick, chan, db, conn))
 
 
 @hook.command("points", autohelp=False)
 def points(text, chan, db, conn):
-    """.points <thing> will print the total points for <thing> in the channel."""
+    """<thing> - will print the total points for <thing> in the channel."""
     db_init(db, conn.name)
     score = 0
     karma = ""
@@ -107,7 +112,7 @@ def points(text, chan, db, conn):
         karma = db.execute("select score from karma where thing = :thing", {'thing': thing.lower()}).fetchall()
     else:
         text = text.strip()
-        karma = db.execute("select score from karma where thing = :thing and chan = :chan", {'thing': text.lower(), 'chan': chan }).fetchall()
+        karma = db.execute("select score from karma where thing = :thing and chan = :chan", {'thing': text.lower(), 'chan': chan}).fetchall()
     if karma:
         pos = 0
         neg = 0
@@ -118,14 +123,15 @@ def points(text, chan, db, conn):
                 pos += int(k[0])
             score += int(k[0])
         if thing:
-             return "{} has a total score of {} (+{}/{}) across all channels I know about.".format(thing, score, pos, neg)
+            return "{} has a total score of {} (+{}/{}) across all channels I know about.".format(thing, score, pos, neg)
         return "{} has a total score of {} (+{}/{}) in {}.".format(text, score, pos, neg, chan)
     else:
         return "I couldn't find {} in the database.".format(text)
 
+
 @hook.command("topten", "pointstop", "loved", autohelp=False)
 def pointstop(text, chan, db, message, conn, notice):
-    """.topten or .pointstop prints the top 10 things with the highest points in the channel. To see the top 10 items in all of the channels the bot sits in use .topten global."""
+    """- prints the top 10 things with the highest points in the channel. To see the top 10 items in all of the channels the bot sits in use .topten global."""
     db_init(db, conn.name)
     scores = []
     points = defaultdict(int)
@@ -135,27 +141,28 @@ def pointstop(text, chan, db, message, conn, notice):
         items = db.execute("select thing, score from karma").fetchall()
         out = "The top {} favorite things in all channels are: "
     else:
-        items = db.execute("select thing, score from karma where chan = :chan", {'chan':chan}).fetchall()
+        items = db.execute("select thing, score from karma where chan = :chan", {'chan': chan}).fetchall()
         out = "The top {} favorite things in {} are: "
     if items:
         for item in items:
             thing = item[0]
             score = int(item[1])
             points[thing] += score
         scores = points.items()
-        sorts = sorted(scores, key=operator.itemgetter(1), reverse = True)
+        sorts = sorted(scores, key=operator.itemgetter(1), reverse=True)
         ten = str(len(sorts))
         if int(ten) > 10:
             ten = "10"
         out = out.format(ten, chan)
-        for i in range(0,int(ten)):
+        for i in range(0, int(ten)):
             out += "{} with {} points \u2022 ".format(sorts[i][0], sorts[i][1])
         out = out[:-2]
         return out
 
+
 @hook.command("bottomten", "pointsbottom", "hated", autohelp=False)
 def pointsbottom(text, chan, db, message, conn, notice):
-    """.bottomten or .pointsbottom prints the top 10 things with the highest points in the channel. To see the top 10 items in all of the channels the bot sits in use .topten global."""
+    """- prints the top 10 things with the lowest points in the channel. To see the bottom 10 items in all of the channels the bot sits in use .bottomten global."""
     db_init(db, conn.name)
     scores = []
     points = defaultdict(int)
@@ -165,7 +172,7 @@ def pointsbottom(text, chan, db, message, conn, notice):
         items = db.execute("select thing, score from karma").fetchall()
         out = "The {} most hated things in all channels are: "
     else:
-        items = db.execute("select thing, score from karma where chan = :chan", {'chan':chan}).fetchall()
+        items = db.execute("select thing, score from karma where chan = :chan", {'chan': chan}).fetchall()
         out = "The {} most hated things in {} are: "
     if items:
         for item in items:
@@ -178,7 +185,7 @@ def pointsbottom(text, chan, db, message, conn, notice):
         if int(ten) > 10:
             ten = "10"
         out = out.format(ten, chan)
-        for i in range(0,int(ten)):
+        for i in range(0, int(ten)):
             out += "{} with {} points \u2022 ".format(sorts[i][0], sorts[i][1])
         out = out[:-2]
         return out