linting / code style / small fixes to strings

canary/cogs/banner.py

@@ -14,7 +14,6 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with Canary. If not, see <https://www.gnu.org/licenses/>.
-
 # discord-py requirements
 import discord
 from discord.ext import commands, tasks
@@ -175,7 +174,8 @@ def msg_check(msg):
         if date_str.lower() == "quit":
             await ctx.send("Command exited.")
             return
-        elif date_str.lower() == "now":
+
+        if date_str.lower() == "now":
             timestamp = datetime.datetime.now().timestamp()
         else:
             try:
@@ -308,6 +308,7 @@ def msg_check(msg):
                 f"It might have been manually deleted. Exiting command."
             )
             return
+
         try:
             converted_message = await self.banner_converted_channel.fetch_message(converted_message_id)
         except discord.errors.NotFound:
@@ -345,8 +346,7 @@ def msg_check(msg):
             await ctx.send("Command timed out.")
             return
 
-        confirmation_str = confirmation_msg.content
-        if confirmation_str.lower() != "yes":
+        if confirmation_msg.content.lower() != "yes":
             await ctx.send("Exiting without selecting winner.")
             return
 
@@ -397,7 +397,7 @@ def msg_check(msg):
         await ctx.send("Successfully set banner and ended contest.")
 
     @commands.command(aliases=["submitbanner"])
-    async def submit_banner(self, ctx, *args):
+    async def submit_banner(self, ctx: commands.Context, *args):
         """
         Submit a picture for an Banner Picture of the Week contest
 

canary/cogs/currency.py

@@ -396,11 +396,11 @@ async def give(self, ctx, user: discord.Member = None, amount: str = None):
         # Handle invalid cases
 
         if amount_dec is None:
-            await ctx.send("Invalid quantity: '{}'.".format(amount))
+            await ctx.send(f"Invalid quantity: '{amount}'.")
             return
 
         if amount_dec <= 0:
-            await ctx.send("You cannot give {}!".format(self.format_symbol_currency(amount_dec)))
+            await ctx.send(f"You cannot give {self.format_symbol_currency(amount_dec)}!")
             return
 
         if amount_dec > balance:

canary/cogs/games.py

@@ -51,6 +51,7 @@ def __init__(self, bot: Canary, hangman_tbl_name: str):
         self.hm_norm_win: int = bot.config.games["hm_norm_win"]
         self.hm_timeout: int = bot.config.games["hm_timeout"]
         self.hm_locks: dict[discord.TextChannel, asyncio.Lock] = dict()
+
         with open(f"{os.getcwd()}/data/premade/{hangman_tbl_name}.obj", "rb") as hangman_pkl:
             self.hangman_dict: dict[str, tuple[list[tuple[str, str | None]], str]] = pickle.load(hangman_pkl)
 
@@ -67,7 +68,8 @@ def help_str(self):
             "resend this message by typing `?{hm|hangman} help`."
         )
 
-    def hm_msg_check(self, hm_channel: discord.TextChannel, lowered: str, msg: discord.Message):
+    @staticmethod
+    def hm_msg_check(hm_channel: discord.TextChannel, lowered: str, msg: discord.Message):
         return msg.channel == hm_channel and (
             (len(msg.content) == 1 and msg.content.isalpha()) or msg.content.lower() == lowered
         )
@@ -76,15 +78,15 @@ def hm_msg_check(self, hm_channel: discord.TextChannel, lowered: str, msg: disco
     async def hangman(self, ctx, command: str | None = None):
         """
         play a nice game of hangman with internet strangers!
-        guesses must be single letters (interpreted in a case insensitive manner) or the entire correct word.
+        guesses must be single letters (interpreted in a case-insensitive manner) or the entire correct word.
         can either be called with "?{hm|hangman}" or "?{hm|hangman} x", where x is a valid category argument.
         see all categories by typing "?{hm|hangman} help".
         quit an ongoing game by typing "?{hm|hangman} quit".
 
         rules:
             - 5 wrong guesses allowed
             - for a guess to be registered, it must either be the full correct word or a single letter
-            - guesses are interpreted in a case insensitive manner
+            - guesses are interpreted in a case-insensitive manner
         """
 
         await ctx.trigger_typing()

canary/cogs/helpers.py

@@ -170,12 +170,14 @@ def retrieve_string(label):
 
         feels_like_string = (
             Helpers._calculate_feels_like(**{k: float(v.group()) for k, v in feels_like_values.items()})
-            if all((
-                humidity_string,
-                temperature_string,
-                wind_string,
-                *feels_like_values.values(),
-            ))
+            if all(
+                (
+                    humidity_string,
+                    temperature_string,
+                    wind_string,
+                    *feels_like_values.values(),
+                )
+            )
             else "n/a"
         )
 
@@ -292,10 +294,12 @@ async def course(self, ctx: commands.Context, *, query: str):
             (a, b) = i.get_text().split(":", 1)
             tidbits.append((a.strip(), b.strip()))
 
-        em = discord.Embed(title=title, description=url, colour=0xDA291C)
-        em.add_field(name="Overview", value=overview, inline=False)
-        em.add_field(name="Terms", value=terms, inline=False)
-        em.add_field(name="Instructor(s)", value=instructors, inline=False)
+        em = (
+            discord.Embed(title=title, description=url, colour=0xDA291C)
+            .add_field(name="Overview", value=overview, inline=False)
+            .add_field(name="Terms", value=terms, inline=False)
+            .add_field(name="Instructor(s)", value=instructors, inline=False)
+        )
         for (a, b) in tidbits:
             em.add_field(name=a, value=b, inline=False)
         await ctx.send(embed=em)

canary/cogs/info.py

@@ -27,6 +27,7 @@ def __init__(self, bot):
 
     @commands.command()
     async def version(self, ctx):
+        # TODO: use asyncio.create_subprocess_shell
         version = subprocess.check_output(("git", "describe", "--tags"), universal_newlines=True).strip()
         commit, authored = (
             subprocess.check_output(("git", "log", "-1", "--pretty=format:%h %aI"), universal_newlines=True)

canary/cogs/reminder.py

@@ -89,6 +89,7 @@
 # Regex for time HH:MM
 HM_REGEX = re.compile(r"\b([0-1]?[0-9]|2[0-4]):([0-5][0-9])")
 
+FREQUENCIES = {"daily": 1, "weekly": 7, "monthly": 30}
 
 class Reminder(commands.Cog):
     def __init__(self, bot: Canary):
@@ -104,11 +105,11 @@ async def check_reminders(self):
 
         await self.bot.wait_until_ready()
         while not self.bot.is_closed():
+            if not (guild := self.guild):
+                return
+
             conn = sqlite3.connect(self.bot.config.db_path)
             c = conn.cursor()
-            guild = self.bot.get_guild(self.bot.config.server_id)
-            if not guild:
-                return
             reminders = c.execute("SELECT * FROM Reminders").fetchall()
             for i in range(len(reminders)):
                 member = discord.utils.get(guild.members, id=reminders[i][0])
@@ -132,7 +133,7 @@ async def check_reminders(self):
                 else:
                     last_date = datetime.datetime.strptime(reminders[i][5], "%Y-%m-%d %H:%M:%S.%f")
 
-                    if datetime.datetime.now() - last_date > datetime.timedelta(days=self.frequencies[reminders[i][3]]):
+                    if datetime.datetime.now() - last_date > datetime.timedelta(days=FREQUENCIES[reminders[i][3]]):
                         await member.send(f"Reminding you to {reminders[i][2]}! [{i + 1:d}]")
 
                         c.execute(
@@ -448,7 +449,7 @@ async def __remindme_repeating(self, ctx: commands.Context, freq: str = "", *, q
         freq = freq.strip()
         quote = quote.strip()
 
-        if freq not in self.frequencies.keys():
+        if freq not in FREQUENCIES.keys():
             await ctx.send(
                 "Please ensure you specify a frequency from the following "
                 "list: `daily`, `weekly`, `monthly`, before your message!"

canary/main.py

@@ -53,10 +53,11 @@
 
 @bot.event
 async def on_ready():
-    if bot.config.dev_log_webhook_id and bot.config.dev_log_webhook_token:
-        webhook_string = " and to the log webhook"
-    else:
-        webhook_string = ""
+    webhook_string = (
+        " and to the log webhook"
+        if bot.config.dev_log_webhook_id and bot.config.dev_log_webhook_token
+        else ""
+    )
     sys.stdout.write(f"Bot is ready, program output will be written to a " f"log file{webhook_string}.\n")
     sys.stdout.flush()
     bot.dev_logger.info(f"Logged in as {bot.user.name} ({bot.user.id})")
@@ -68,12 +69,13 @@ async def load(ctx, extension_name: str):
     """
     Load a specific extension. Specify as cogs.<name>
     """
+
     try:
         bot.load_extension(extension_name)
     except (AttributeError, ImportError) as e:
         await ctx.send(f"```{type(e).__name__}: {str(e)}\n```")
-
         return
+
     await ctx.send(f"{extension_name} loaded.")
 
 
@@ -83,6 +85,7 @@ async def unload(ctx: Context, extension_name: str):
     """
     Unload a specific extension. Specify as cogs.<name>
     """
+
     try:
         bot.unload_extension(extension_name)
     except Exception as e:
@@ -155,6 +158,7 @@ async def on_user_update(before, after):
 def main():
     if os.name == "posix":
         import uvloop
+
         uvloop.install()
 
     for extension in startup: