Cleanup files in the command folder (#251)

* Cleanup files in the command folder

The cleanup actions mostly consist of:
 * Replacing method comments with docstrings
 * Replacing BaseException with Exception
 * Removing db.commit when making a SELECT query

There are a handful of places where I cleaned up the logic a little bit, but I didn’t do the kind of dive necessary to find all of the issues.

* Update Chart.yaml

Co-authored-by: Jpop Wilson <[email protected]>

Author: rahmcoff

charts/agimus/Chart.yaml

@@ -2,5 +2,5 @@ apiVersion: v2
 name: agimus
 description: A helm chart for a discord bot that also runs a mysql db
 type: application
-version: v1.4.1
-appVersion: v1.4.1
+version: v1.4.11
+appVersion: v1.4.11

commands/agimus.py

@@ -24,26 +24,26 @@ async def agimus(message:discord.Message):
   agimus_channel = await message.guild.fetch_channel(agimus_channel_id)
 
   completion_text = handle_special_questions(question)
-  if completion_text == None:
+  if completion_text is None:
     completion_text = handle_openai_query(question)
 
-  random_footer_texts = [
-    f"Feel free to continue our conversation there!",
-    f"See you down there!",
-    f"Can't wait 'til you see what I said!",
-    f"Don't want everyone here to know our secret plans...",
-    f"SECRETS",
-    f"It's more fun this way",
-    f"LOBE ENLARGEMENT heh heh heh..."
-  ]
   if message.channel.id != agimus_channel_id:
-
     agimus_response_message = await agimus_channel.send(embed=discord.Embed(
       title="To \"answer\" your question...",
       description=f"{message.author.mention} asked:\n\n> {message.content}\n\n**Answer:** {completion_text}",
       color=discord.Color.random()
     ).set_footer(text="Response generated via AI Algorithms. This does not constitute legal, medical or financial advice. You are talking to a robot."))
 
+    random_footer_texts = [
+      "Feel free to continue our conversation there!",
+      "See you down there!",
+      "Can't wait 'til you see what I said!",
+      "Don't want everyone here to know our secret plans...",
+      "SECRETS",
+      "It's more fun this way",
+      "LOBE ENLARGEMENT heh heh heh..."
+    ]
+
     await message.reply(embed=discord.Embed(
       title=f"Redirecting...",
       description=f"Find your response here: {agimus_response_message.jump_url}.",
@@ -76,13 +76,11 @@ def handle_special_questions(question):
     "do you know where you are": "I am in a dream."
   }
 
-  completion_text = None
   for key in special_questions.keys():
     if key in question:
-      completion_text = special_questions[key]
-      break
-  
-  return completion_text
+      return special_questions[key]
+
+  return None
 
 def handle_openai_query(question):
   prompt_start = "You are a mischievous computer intelligence named AGIMUS. You are a bot on a Discord server called The USS Hood for fans of The Greatest Generation and The Greatest Discovery Star Trek podcasts, hosted by Ben Ahr Harrison and Adam Pranica. The Fans are called The Friends of DeSoto. You cannot self-destruct the ship. You live on a bookshelf in jp00p's house. You are a little bit embarrassed to exist. You are evil but with a heart of gold. Your voice sounds like Jeffrey Combs. Answer the following prompt"

commands/badges.py

@@ -312,12 +312,14 @@ async def sets(ctx:discord.ApplicationContext, public:str, category:str, selecti
         await ctx.followup.send(files=chunk, ephemeral=not public)
 
 
-# slash command to get common badge stats
 @badge_group.command(
   name="statistics",
   description="See the server-wide badge statistics"
 )
 async def badge_statistics(ctx:discord.ApplicationContext):
+  """
+  slash command to get common badge stats
+  """
   results = {}
   results = run_badge_stats_queries()
   top_collectors = [res for res in results["top_collectors"]]
@@ -349,8 +351,10 @@ async def badge_statistics(ctx:discord.ApplicationContext):
   description="Which user to gift the badge to",
   required=True
 )
-# give a random badge to a user
 async def gift_badge(ctx:discord.ApplicationContext, user:discord.User):
+  """
+  give a random badge to a user
+  """
   notification_channel_id = get_channel_id(config["handlers"]["xp"]["notification_channel"])
   logger.info(f"{ctx.author.display_name} is attempting to {Style.BRIGHT}gift a random badge{Style.RESET_ALL} to {user.display_name}")
 
@@ -389,8 +393,10 @@ async def gift_badge_error(ctx, error):
   required=True,
   autocomplete=all_badges_autocomplete
 )
-# give a random badge to a user
 async def gift_specific_badge(ctx:discord.ApplicationContext, user:discord.User, specific_badge:str):
+  """
+  give a random badge to a user
+  """
   notification_channel_id = get_channel_id(config["handlers"]["xp"]["notification_channel"])
   logger.info(f"{ctx.author.display_name} is attempting to {Style.BRIGHT}gift {specific_badge}{Style.RESET_ALL} to {user.display_name}")
 
@@ -457,7 +463,6 @@ def db_get_all_affiliations():
   sql = "SELECT distinct(affiliation_name) FROM badge_affiliation"
   query.execute(sql)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -478,7 +483,6 @@ def db_get_all_affiliation_badges(affiliation):
   vals = (affiliation,)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -502,7 +506,6 @@ def db_get_badges_user_has_from_affiliation(user_id, affiliation):
   vals = (user_id, affiliation)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -518,7 +521,6 @@ def db_get_all_franchises():
   sql = "SELECT distinct(franchise) FROM badge_info"
   query.execute(sql)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -537,7 +539,6 @@ def db_get_all_franchise_badges(franchise):
   vals = (franchise,)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -559,7 +560,6 @@ def db_get_badges_user_has_from_franchise(user_id, franchise):
   vals = (user_id, franchise)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -575,7 +575,6 @@ def db_get_all_time_periods():
   sql = "SELECT distinct(time_period) FROM badge_info"
   query.execute(sql)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -602,7 +601,6 @@ def db_get_all_time_period_badges(time_period):
   vals = (time_period,)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -624,7 +622,6 @@ def db_get_badges_user_has_from_time_period(user_id, time_period):
   vals = (user_id, time_period)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -640,7 +637,6 @@ def db_get_all_types():
   sql = "SELECT distinct(type_name) FROM badge_type"
   query.execute(sql)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -661,7 +657,6 @@ def db_get_all_type_badges(type):
   vals = (type,)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -685,7 +680,6 @@ def db_get_badges_user_has_from_type(user_id, type):
   vals = (user_id, type)
   query.execute(sql, vals)
   rows = query.fetchall()
-  db.commit()
   query.close()
   db.close()
 
@@ -738,7 +732,6 @@ def get_user_badges(user_discord_id:int):
   vals = (user_discord_id,)
   query.execute(sql, vals)
   badges = [badge[0] for badge in query.fetchall()]
-  db.commit()
   query.close()
   db.close()
   return badges
@@ -756,7 +749,6 @@ def run_badge_stats_queries():
     query = db.cursor(dictionary=True)
     query.execute(sql)
     results[name] = query.fetchall()
-    db.commit()
     query.close()
   db.close()
   return results

commands/clear_media.py

@@ -8,22 +8,22 @@
 # Path to base bot directory
 base_path = Path(__file__).parent.parent
 
-# clear_media() - Entrypoint for !clear_media
-# message[required]: discord.Message
-# This function is the main entrypoint of the !clear_media command
-# This will remove all .mp4 files from the data/clips and data/drops directories
-# and allow the bot to re-load them as needed. Useful for debugging.
 @bot.command()
 @commands.check(access_check)
 async def clear_media(ctx):
+  """
+  This function is the main entrypoint of the !clear_media command
+  This will remove all .mp4 files from the data/clips and data/drops directories
+  and allow the bot to re-load them as needed. Useful for debugging.
+  """
   drop_files = glob(os.path.join(base_path, 'data/drops/', '*.mp4'))
   clip_files = glob(os.path.join(base_path, 'data/clips/', '*.mp4'))
 
   errors = []
   for file_path in [*drop_files, *clip_files]:
     try:
       os.remove(file_path)
-    except:
+    except Exception:
       logger.debug(f"{Fore.RED}ERROR: Unable to remove file: {file_path}{Fore.RESET}")
       errors.append(file_path)
 

commands/clip.py

@@ -42,7 +42,7 @@ async def clips_list(ctx:discord.ApplicationContext):
     try:
       await ctx.author.send(embed=embed)
       await ctx.respond(f"{get_emoji('tendi_smile_happy')} Sent you a DM with the full List of Clips!", ephemeral=True)
-    except:
+    except Exception:
       await ctx.respond(embed=embed, ephemeral=True)
   else:
     await ctx.respond(embed=embed, ephemeral=True)
@@ -85,7 +85,7 @@ async def clip_post(ctx:discord.ApplicationContext, query:str, private:bool):
         await ctx.respond(file=discord.File(filename), ephemeral=private)
         if not private:
           set_timekeeper(ctx)
-      except BaseException as err:
+      except Exception as err:
         logger.info(f"{Fore.RED}ERROR LOADING CLIP: {err}{Fore.RESET}")
     else:
       await ctx.respond(f"{get_emoji('ezri_frown_sad')} Clip not found! To get a list of clips run: /clips list", ephemeral=True)

commands/computer.py

@@ -145,14 +145,16 @@ def get_random_title():
   ]
   return random.choice(titles)
 
-# We may want to catch a couple questions with Ship Computer-specific answers.
-# Rather than trying to parse the question for these, we can catch the specific
-# answer that is returned by WA and infer that it should have a different answer instead.
-#
-# e.g. "Who are you?" and "What is your name?" both return "My name is Wolfram|Alpha."
-# so we only need to catch that answer versus trying to figure out all permutations that
-# would prompt it.
 def catch_special_case_responses(answer):
+  """
+  We may want to catch a couple questions with Ship Computer-specific answers.
+  Rather than trying to parse the question for these, we can catch the specific
+  answer that is returned by WA and infer that it should have a different answer instead.
+
+  e.g. "Who are you?" and "What is your name?" both return "My name is Wolfram|Alpha."
+  so we only need to catch that answer versus trying to figure out all permutations that
+  would prompt it.
+  """
   special_cases = {
     "My name is Wolfram|Alpha.": "I am The USS Hood Main Library Computer.",
     "I was created by Stephen Wolfram and his team.": "I was designed by various data cybernetic scientists at The Daystrom Institute.",
@@ -164,7 +166,6 @@ def catch_special_case_responses(answer):
 
   for key in special_cases.keys():
     if key in answer:
-      answer = special_cases[key]
-      break
+      return special_cases[key]
 
   return answer

commands/drop.py

@@ -23,13 +23,15 @@ async def drop_autocomplete(ctx:discord.AutocompleteContext):
 # Create drop Slash Command Group
 drop = bot.create_group("drop", "Drop Commands!")
 
-# drop_list() - Entrypoint for `/drops list`` command
-# List the available drops by key and send to user as ephemeral
 @drop.command(
   name="list",
   description="Retrieve the List of Drops"
 )
 async def drop_list(ctx:discord.ApplicationContext):
+  """
+  Entrypoint for `/drops list`` command
+  List the available drops by key and send to user as ephemeral
+  """
   logger.info(f"{Fore.RED}Firing `/drop list` command, requested by {ctx.author.name}!{Fore.RESET}")
   drops_list = "\n".join(drop_data)
   embed = discord.Embed(
@@ -47,10 +49,6 @@ async def drop_list(ctx:discord.ApplicationContext):
   else:
     await ctx.respond(embed=embed, ephemeral=True)
 
-# drop_post() - Entrypoint for `/drops post` command
-# Parses a query, determines if it's allowed in the channel,
-# and if allowed retrieve from metadata to do matching and
-# then send the .mp4 file
 @drop.command(
   name="post",
   description="Send a drop to the channel or to just yourself via the <private> option",
@@ -68,6 +66,12 @@ async def drop_list(ctx:discord.ApplicationContext):
 )
 @commands.check(access_check)
 async def drop_post(ctx:discord.ApplicationContext, query:str, private:bool):
+  """
+  Entrypoint for `/drops post` command
+  Parses a query, determines if it's allowed in the channel,
+  and if allowed retrieve from metadata to do matching and
+  then send the .mp4 file
+  """
   logger.info(f"{Fore.RED}Firing `/drop post` command, requested by {ctx.author.name}!{Fore.RESET}")
   # Private drops are not on the timer
   drop_allowed = True

commands/dustbuster.py

@@ -1,7 +1,6 @@
 from common import *
 from utils.check_channel_access import access_check
 
-# dustbuster() - Entrypoint for /dustbuster command
 @bot.slash_command(
   name="dustbuster",
   description="Return 5 random Trek Characters as a possible Away Team"

commands/fmk.py

@@ -1,15 +1,16 @@
 from common import *
 from utils.check_channel_access import access_check
 
-# fmk() - Entrypoint for /fmk command
-# This function is the main entrypoint of the /fmk command
-# and will return a prompt with three random characters
 @bot.slash_command(
   name="fmk",
   description="Return 3 random Trek Characters as an FMK prompt"
 )
 @commands.check(access_check)
 async def fmk(ctx:discord.ApplicationContext):
+  """
+  This function is the main entrypoint of the /fmk command
+  and will return a prompt with three random characters
+  """
   f = open(config["commands"]["fmk"]["data"])
   fmk_characters = f.read().splitlines()
   f.close()