Spring cleanup

bot/__init__.py

@@ -64,12 +64,12 @@ def monkeypatch_trace(self: logging.Logger, msg: str, *args, **kwargs) -> None:
 
 # Setup new logging configuration
 logging.basicConfig(
-    format='%(asctime)s - %(name)s %(levelname)s: %(message)s',
+    format="%(asctime)s - %(name)s %(levelname)s: %(message)s",
     datefmt="%D %H:%M:%S",
     level=logging.TRACE if Client.debug else logging.DEBUG,
     handlers=[console_handler, file_handler],
 )
-logging.getLogger().info('Logging initialization complete')
+logging.getLogger().info("Logging initialization complete")
 
 
 # On Windows, the selector event loop is required for aiodns.

bot/bot.py

@@ -101,7 +101,7 @@ async def check_channels(self) -> None:
 
         all_channels_ids = [channel.id for channel in self.get_all_channels()]
         for name, channel_id in vars(constants.Channels).items():
-            if name.startswith('_'):
+            if name.startswith("_"):
                 continue
             if channel_id not in all_channels_ids:
                 log.error(f'Channel "{name}" with ID {channel_id} missing')

bot/exts/christmas/advent_of_code/_cog.py

@@ -72,11 +72,15 @@ async def aoc_subscribe(self, ctx: commands.Context) -> None:
 
         if role not in ctx.author.roles:
             await ctx.author.add_roles(role)
-            await ctx.send("Okay! You have been __subscribed__ to notifications about new Advent of Code tasks. "
-                           f"You can run `{unsubscribe_command}` to disable them again for you.")
+            await ctx.send(
+                "Okay! You have been __subscribed__ to notifications about new Advent of Code tasks. "
+                f"You can run `{unsubscribe_command}` to disable them again for you."
+            )
         else:
-            await ctx.send("Hey, you already are receiving notifications about new Advent of Code tasks. "
-                           f"If you don't want them any more, run `{unsubscribe_command}` instead.")
+            await ctx.send(
+                "Hey, you already are receiving notifications about new Advent of Code tasks. "
+                f"If you don't want them any more, run `{unsubscribe_command}` instead."
+            )
 
     @in_month(Month.DECEMBER)
     @adventofcode_group.command(name="unsubscribe", aliases=("unsub",), brief="Notifications for new days")
@@ -110,8 +114,10 @@ async def aoc_countdown(self, ctx: commands.Context) -> None:
             else:
                 delta_str = f"{delta.days} days"
 
-            await ctx.send(f"The Advent of Code event is not currently running. "
-                           f"The next event will start in {delta_str}.")
+            await ctx.send(
+                "The Advent of Code event is not currently running. "
+                f"The next event will start in {delta_str}."
+            )
             return
 
         tomorrow, time_left = _helpers.time_left_to_est_midnight()
@@ -124,7 +130,7 @@ async def aoc_countdown(self, ctx: commands.Context) -> None:
     @whitelist_override(channels=AOC_WHITELIST)
     async def about_aoc(self, ctx: commands.Context) -> None:
         """Respond with an explanation of all things Advent of Code."""
-        await ctx.send("", embed=self.cached_about_aoc)
+        await ctx.send(embed=self.cached_about_aoc)
 
     @adventofcode_group.command(name="join", aliases=("j",), brief="Learn how to join the leaderboard (via DM)")
     @whitelist_override(channels=AOC_WHITELIST)
@@ -135,7 +141,7 @@ async def join_leaderboard(self, ctx: commands.Context) -> None:
             await ctx.send(f"The Python Discord leaderboard for {current_year} is not yet available!")
             return
 
-        author = ctx.message.author
+        author = ctx.author
         log.info(f"{author.name} ({author.id}) has requested a PyDis AoC leaderboard code")
 
         if AocConfig.staff_leaderboard_id and any(r.id == Roles.helpers for r in author.roles):
@@ -273,8 +279,7 @@ def cog_unload(self) -> None:
 
     def _build_about_embed(self) -> discord.Embed:
         """Build and return the informational "About AoC" embed from the resources file."""
-        with self.about_aoc_filepath.open("r", encoding="utf8") as f:
-            embed_fields = json.load(f)
+        embed_fields = json.loads(self.about_aoc_filepath.read_text("utf8"))
 
         about_embed = discord.Embed(
             title=self._base_url,

bot/exts/christmas/advent_of_code/_helpers.py

@@ -108,7 +108,7 @@ def _parse_raw_leaderboard_data(raw_leaderboard_data: dict) -> dict:
     # star view. We need that per star view to compute rank scores per star.
     for member in raw_leaderboard_data.values():
         name = member["name"] if member["name"] else f"Anonymous #{member['id']}"
-        member_id = member['id']
+        member_id = member["id"]
         leaderboard[member_id] = {"name": name, "score": 0, "star_1": 0, "star_2": 0}
 
         # Iterate over all days for this participant
@@ -119,7 +119,7 @@ def _parse_raw_leaderboard_data(raw_leaderboard_data: dict) -> dict:
                 leaderboard[member_id][f"star_{star}"] += 1
 
                 # Record completion datetime for this participant for this day/star
-                completion_time = datetime.datetime.fromtimestamp(int(data['get_star_ts']))
+                completion_time = datetime.datetime.fromtimestamp(int(data["get_star_ts"]))
                 star_results[(day, star)].append(
                     StarResult(member_id=member_id, completion_time=completion_time)
                 )
@@ -133,7 +133,7 @@ def _parse_raw_leaderboard_data(raw_leaderboard_data: dict) -> dict:
         if day in AdventOfCode.ignored_days:
             continue
 
-        sorted_result = sorted(results, key=operator.attrgetter('completion_time'))
+        sorted_result = sorted(results, key=operator.attrgetter("completion_time"))
         for rank, star_result in enumerate(sorted_result):
             leaderboard[star_result.member_id]["score"] += max_score - rank
 
@@ -307,7 +307,7 @@ async def fetch_leaderboard(invalidate_cache: bool = False) -> dict:
 
 def get_summary_embed(leaderboard: dict) -> discord.Embed:
     """Get an embed with the current summary stats of the leaderboard."""
-    leaderboard_url = leaderboard['full_leaderboard_url']
+    leaderboard_url = leaderboard["full_leaderboard_url"]
     refresh_minutes = AdventOfCode.leaderboard_cache_expiry_seconds // 60
 
     aoc_embed = discord.Embed(

bot/exts/christmas/hanukkah_embed.py

@@ -5,37 +5,41 @@
 from discord import Embed
 from discord.ext import commands
 
+from bot.bot import Bot
 from bot.constants import Colours, Month
 from bot.utils.decorators import in_month
 
 log = logging.getLogger(__name__)
 
+HEBCAL_URL = (
+    "https://www.hebcal.com/hebcal/?v=1&cfg=json&maj=on&min=on&mod=on&nx=on&"
+    "year=now&month=x&ss=on&mf=on&c=on&geo=geoname&geonameid=3448439&m=50&s=on"
+)
+
 
 class HanukkahEmbed(commands.Cog):
     """A cog that returns information about Hanukkah festival."""
 
-    def __init__(self, bot: commands.Bot):
+    def __init__(self, bot: Bot):
         self.bot = bot
-        self.url = ("https://www.hebcal.com/hebcal/?v=1&cfg=json&maj=on&min=on&mod=on&nx=on&"
-                    "year=now&month=x&ss=on&mf=on&c=on&geo=geoname&geonameid=3448439&m=50&s=on")
         self.hanukkah_days = []
         self.hanukkah_months = []
         self.hanukkah_years = []
 
     async def get_hanukkah_dates(self) -> List[str]:
         """Gets the dates for hanukkah festival."""
         hanukkah_dates = []
-        async with self.bot.http_session.get(self.url) as response:
+        async with self.bot.http_session.get(HEBCAL_URL) as response:
             json_data = await response.json()
-        festivals = json_data['items']
+        festivals = json_data["items"]
         for festival in festivals:
-            if festival['title'].startswith('Chanukah'):
-                date = festival['date']
+            if festival["title"].startswith("Chanukah"):
+                date = festival["date"]
                 hanukkah_dates.append(date)
         return hanukkah_dates
 
     @in_month(Month.DECEMBER)
-    @commands.command(name='hanukkah', aliases=['chanukah'])
+    @commands.command(name="hanukkah", aliases=("chanukah",))
     async def hanukkah_festival(self, ctx: commands.Context) -> None:
         """Tells you about the Hanukkah Festivaltime of festival, festival day, etc)."""
         hanukkah_dates = await self.get_hanukkah_dates()
@@ -54,49 +58,46 @@ async def hanukkah_festival(self, ctx: commands.Context) -> None:
         day = str(today.day)
         month = str(today.month)
         year = str(today.year)
-        embed = Embed()
-        embed.title = 'Hanukkah'
-        embed.colour = Colours.blue
+        embed = Embed(title="Hanukkah", colour=Colours.blue)
         if day in self.hanukkah_days and month in self.hanukkah_months and year in self.hanukkah_years:
             if int(day) == hanukkah_start_day:
                 now = datetime.datetime.utcnow()
-                now = str(now)
-                hours = int(now[11:13]) + 4  # using only hours
+                hours = now.hour + 4  # using only hours
                 hanukkah_start_hour = 18
                 if hours < hanukkah_start_hour:
-                    embed.description = (f"Hanukkah hasnt started yet, "
-                                         f"it will start in about {hanukkah_start_hour-hours} hour/s.")
-                    return await ctx.send(embed=embed)
+                    embed.description = (
+                        "Hanukkah hasnt started yet, "
+                        f"it will start in about {hanukkah_start_hour - hours} hour/s."
+                    )
+                    await ctx.send(embed=embed)
+                    return
                 elif hours > hanukkah_start_hour:
-                    embed.description = (f'It is the starting day of Hanukkah ! '
-                                         f'Its been {hours-hanukkah_start_hour} hours hanukkah started !')
-                    return await ctx.send(embed=embed)
+                    embed.description = (
+                        "It is the starting day of Hanukkah! "
+                        f"Its been {hours - hanukkah_start_hour} hours hanukkah started!"
+                    )
+                    await ctx.send(embed=embed)
+                    return
             festival_day = self.hanukkah_days.index(day)
-            number_suffixes = ['st', 'nd', 'rd', 'th']
-            suffix = ''
-            if int(festival_day) == 1:
-                suffix = number_suffixes[0]
-            if int(festival_day) == 2:
-                suffix = number_suffixes[1]
-            if int(festival_day) == 3:
-                suffix = number_suffixes[2]
-            if int(festival_day) > 3:
-                suffix = number_suffixes[3]
-            message = ''
-            for _ in range(1, festival_day + 1):
-                message += ':menorah:'
-            embed.description = f'It is the {festival_day}{suffix} day of Hanukkah ! \n {message}'
+            number_suffixes = ["st", "nd", "rd", "th"]
+            suffix = number_suffixes[festival_day - 1 if festival_day <= 3 else 3]
+            message = ":menorah:" * festival_day
+            embed.description = f"It is the {festival_day}{suffix} day of Hanukkah!\n{message}"
             await ctx.send(embed=embed)
         else:
             if today < hanukkah_start:
-                festival_starting_month = hanukkah_start.strftime('%B')
-                embed.description = (f"Hanukkah has not started yet. "
-                                     f"Hanukkah will start at sundown on {hanukkah_start_day}th "
-                                     f"of {festival_starting_month}.")
+                festival_starting_month = hanukkah_start.strftime("%B")
+                embed.description = (
+                    f"Hanukkah has not started yet. "
+                    f"Hanukkah will start at sundown on {hanukkah_start_day}th "
+                    f"of {festival_starting_month}."
+                )
             else:
-                festival_end_month = hanukkah_end.strftime('%B')
-                embed.description = (f"Looks like you missed Hanukkah !"
-                                     f"Hanukkah ended on {hanukkah_end_day}th of {festival_end_month}.")
+                festival_end_month = hanukkah_end.strftime("%B")
+                embed.description = (
+                    f"Looks like you missed Hanukkah!"
+                    f"Hanukkah ended on {hanukkah_end_day}th of {festival_end_month}."
+                )
 
             await ctx.send(embed=embed)
 
@@ -108,6 +109,6 @@ def hanukkah_dates_split(self, hanukkah_dates: List[str]) -> None:
             self.hanukkah_years.append(date[0:4])
 
 
-def setup(bot: commands.Bot) -> None:
-    """Cog load."""
+def setup(bot: Bot) -> None:
+    """Load the Hanukkah Embed Cog."""
     bot.add_cog(HanukkahEmbed(bot))

bot/exts/easter/april_fools_vids.py

@@ -1,19 +1,21 @@
 import logging
 import random
-from json import load
+from json import loads
+from pathlib import Path
 
 from discord.ext import commands
 
+from bot.bot import Bot
+
 log = logging.getLogger(__name__)
 
-with open("bot/resources/easter/april_fools_vids.json", encoding="utf-8") as f:
-    ALL_VIDS = load(f)
+ALL_VIDS = loads(Path("bot/resources/easter/april_fools_vids.json").read_text("utf-8"))
 
 
 class AprilFoolVideos(commands.Cog):
     """A cog for April Fools' that gets a random April Fools' video from Youtube."""
 
-    @commands.command(name='fool')
+    @commands.command(name="fool")
     async def april_fools(self, ctx: commands.Context) -> None:
         """Get a random April Fools' video from Youtube."""
         video = random.choice(ALL_VIDS)
@@ -23,6 +25,6 @@ async def april_fools(self, ctx: commands.Context) -> None:
         await ctx.send(f"Check out this April Fools' video by {channel}.\n\n{url}")
 
 
-def setup(bot: commands.Bot) -> None:
-    """April Fools' Cog load."""
-    bot.add_cog(AprilFoolVideos(bot))
+def setup(bot: Bot) -> None:
+    """Load the April Fools' Cog."""
+    bot.add_cog(AprilFoolVideos())

bot/exts/easter/bunny_name_generator.py

@@ -7,25 +7,26 @@
 
 from discord.ext import commands
 
+from bot.bot import Bot
+
 log = logging.getLogger(__name__)
 
-with Path("bot/resources/easter/bunny_names.json").open("r", encoding="utf8") as f:
-    BUNNY_NAMES = json.load(f)
+BUNNY_NAMES = json.loads(Path("bot/resources/easter/bunny_names.json").read_text("utf8"))
 
 
 class BunnyNameGenerator(commands.Cog):
     """Generate a random bunny name, or bunnify your Discord username!"""
 
-    def __init__(self, bot: commands.Bot):
-        self.bot = bot
-
-    def find_separators(self, displayname: str) -> Union[List[str], None]:
+    @staticmethod
+    def find_separators(displayname: str) -> Union[List[str], None]:
         """Check if Discord name contains spaces so we can bunnify an individual word in the name."""
-        new_name = re.split(r'[_.\s]', displayname)
+        new_name = re.split(r"[_.\s]", displayname)
         if displayname not in new_name:
             return new_name
+        return None
 
-    def find_vowels(self, displayname: str) -> str:
+    @staticmethod
+    def find_vowels(displayname: str) -> str:
         """
         Finds vowels in the user's display name.
 
@@ -34,21 +35,22 @@ def find_vowels(self, displayname: str) -> str:
         Only the most recently matched pattern will apply the changes.
         """
         expressions = [
-            (r'a.+y', 'patchy'),
-            (r'e.+y', 'ears'),
-            (r'i.+y', 'ditsy'),
-            (r'o.+y', 'oofy'),
-            (r'u.+y', 'uffy'),
+            ("a.+y", "patchy"),
+            ("e.+y", "ears"),
+            ("i.+y", "ditsy"),
+            ("o.+y", "oofy"),
+            ("u.+y", "uffy"),
         ]
 
         for exp, vowel_sub in expressions:
             new_name = re.sub(exp, vowel_sub, displayname)
             if new_name != displayname:
                 return new_name
 
-    def append_name(self, displayname: str) -> str:
+    @staticmethod
+    def append_name(displayname: str) -> str:
         """Adds a suffix to the end of the Discord name."""
-        extensions = ['foot', 'ear', 'nose', 'tail']
+        extensions = ["foot", "ear", "nose", "tail"]
         suffix = random.choice(extensions)
         appended_name = displayname + suffix
 
@@ -62,7 +64,7 @@ async def bunnyname(self, ctx: commands.Context) -> None:
     @commands.command()
     async def bunnifyme(self, ctx: commands.Context) -> None:
         """Gets your Discord username and bunnifies it."""
-        username = ctx.message.author.display_name
+        username = ctx.author.display_name
 
         # If name contains spaces or other separators, get the individual words to randomly bunnify
         spaces_in_name = self.find_separators(username)
@@ -75,7 +77,7 @@ async def bunnifyme(self, ctx: commands.Context) -> None:
         unmatched_name = self.append_name(username)
 
         if spaces_in_name is not None:
-            replacements = ['Cotton', 'Fluff', 'Floof' 'Bounce', 'Snuffle', 'Nibble', 'Cuddle', 'Velvetpaw', 'Carrot']
+            replacements = ["Cotton", "Fluff", "Floof" "Bounce", "Snuffle", "Nibble", "Cuddle", "Velvetpaw", "Carrot"]
             word_to_replace = random.choice(spaces_in_name)
             substitute = random.choice(replacements)
             bunnified_name = username.replace(word_to_replace, substitute)
@@ -87,6 +89,6 @@ async def bunnifyme(self, ctx: commands.Context) -> None:
         await ctx.send(bunnified_name)
 
 
-def setup(bot: commands.Bot) -> None:
-    """Bunny Name Generator Cog load."""
-    bot.add_cog(BunnyNameGenerator(bot))
+def setup(bot: Bot) -> None:
+    """Load the Bunny Name Generator Cog."""
+    bot.add_cog(BunnyNameGenerator())