Adds proper type hints to every argument in every function, and every return value

techsupport_bot/bot.py

@@ -50,7 +50,7 @@ class TechSupportBot(commands.Bot):
     )
 
     def __init__(
-        self, intents: discord.Intents, allowed_mentions: discord.AllowedMentions
+        self: Self, intents: discord.Intents, allowed_mentions: discord.AllowedMentions
     ) -> None:
         # Sets a few properires to None to avoid ValueErrors later on
         self.startup_time: datetime = None
@@ -109,7 +109,7 @@ def __init__(
 
     # Entry point
 
-    async def start(self) -> None:
+    async def start(self: Self) -> None:
         """Starts the bot, connects to discord, irc, and postgres
         This function should not be used to interact with discord in any way
         Any discord interactions should be done with setup_hook
@@ -143,7 +143,7 @@ async def start(self) -> None:
 
     # Discord.py called functions
 
-    async def setup_hook(self) -> None:
+    async def setup_hook(self: Self) -> None:
         """This function is automatically called after the bot has been logged into discord
         This creates postgres tables if needed, registers new guild configs if needed,
         Loads extensions, registers the custom help command
@@ -183,7 +183,7 @@ async def setup_hook(self) -> None:
         self.extension_name_list = []
         await self.load_extensions()
 
-    async def on_guild_join(self, guild: discord.Guild) -> None:
+    async def on_guild_join(self: Self, guild: discord.Guild) -> None:
         """Configures a new guild upon joining.
         This registers a new guild config, and starts any loop jobs that are configured
 
@@ -203,7 +203,7 @@ async def on_guild_join(self, guild: discord.Guild) -> None:
                         exception=exception,
                     )
 
-    async def on_ready(self) -> None:
+    async def on_ready(self: Self) -> None:
         """Callback for when the bot is finished starting up.
         This function may be called more than once and should not have discord interactions in it
         """
@@ -219,7 +219,7 @@ async def on_ready(self) -> None:
 
     # DM Logging
 
-    async def log_DM(self, sent_from: str, source: str, content: str) -> None:
+    async def log_DM(self: Self, sent_from: str, source: str, content: str) -> None:
         """Logs a DM from any source
 
         Args:
@@ -234,7 +234,7 @@ async def log_DM(self, sent_from: str, source: str, content: str) -> None:
         embed.timestamp = datetime.datetime.utcnow()
         await owner.send(embed=embed)
 
-    async def on_message(self, message: discord.Message) -> None:
+    async def on_message(self: Self, message: discord.Message) -> None:
         """Logs DMs and ensure that commands are processed
 
         Args:
@@ -260,7 +260,7 @@ async def on_message(self, message: discord.Message) -> None:
 
     # Guild config management functions
 
-    async def register_new_guild_config(self, guild_id: str) -> bool:
+    async def register_new_guild_config(self: Self, guild_id: str) -> bool:
         """This creates a config for a new guild if needed
 
         Args:
@@ -279,7 +279,7 @@ async def register_new_guild_config(self, guild_id: str) -> bool:
                 return True
             return False
 
-    async def create_new_context_config(self, guild_id: str) -> munch.Munch:
+    async def create_new_context_config(self: Self, guild_id: str) -> munch.Munch:
         """Creates a new guild config for a given guild.
 
         Args:
@@ -335,7 +335,7 @@ async def create_new_context_config(self, guild_id: str) -> munch.Munch:
 
         return config_
 
-    async def write_new_config(self, guild_id: str, config: str) -> None:
+    async def write_new_config(self: Self, guild_id: str, config: str) -> None:
         """Takes a config and guild and updates the config in the database
         This is only needed when a new guild is joined or the config is modifed
 
@@ -358,7 +358,7 @@ async def write_new_config(self, guild_id: str, config: str) -> None:
             await new_database_config.create()
 
     def add_extension_config(
-        self, extension_name: str, config: extensionconfig.ExtensionConfig
+        self: Self, extension_name: str, config: extensionconfig.ExtensionConfig
     ) -> None:
         """Adds an extensions defined config to the guild config as a whole
 
@@ -376,7 +376,7 @@ def add_extension_config(
         self.extension_configs[extension_name] = config
 
     async def get_log_channel_from_guild(
-        self, guild: discord.Guild, key: str
+        self: Self, guild: discord.Guild, key: str
     ) -> str | None:
         """Gets the log channel ID associated with the given guild.
 
@@ -402,7 +402,7 @@ async def get_log_channel_from_guild(
 
     # File config loading functions
 
-    def load_file_config(self, validate: bool = True) -> None:
+    def load_file_config(self: Self, validate: bool = True) -> None:
         """Loads the config yaml file into a bot object.
 
         Args:
@@ -423,7 +423,9 @@ def load_file_config(self, validate: bool = True) -> None:
         for subsection in ["required"]:
             self.validate_bot_config_subsection("bot_config", subsection)
 
-    def validate_bot_config_subsection(self, section: str, subsection: str) -> None:
+    def validate_bot_config_subsection(
+        self: Self, section: str, subsection: str
+    ) -> None:
         """Loops through a config subsection to check for missing values.
 
         Args:
@@ -449,7 +451,7 @@ def validate_bot_config_subsection(self, section: str, subsection: str) -> None:
     # Error handling and logging functions
 
     async def on_app_command_error(
-        self,
+        self: Self,
         interaction: discord.Interaction,
         error: app_commands.AppCommandError,
     ) -> None:
@@ -474,7 +476,7 @@ async def on_app_command_error(
             await interaction.response.send_message(embed=embed)
 
     async def handle_error(
-        self,
+        self: Self,
         exception: Exception,
         channel: discord.abc.Messageable,
         guild: discord.Guild,
@@ -530,7 +532,7 @@ async def handle_error(
         return error_message
 
     async def on_command_error(
-        self, context: commands.Context, exception: Exception
+        self: Self, context: commands.Context, exception: Exception
     ) -> None:
         """Catches command errors and sends them to the error logger for processing.
 
@@ -560,7 +562,7 @@ async def on_command_error(
 
     # Postgres setup function
 
-    async def get_postgres_ref(self) -> None:
+    async def get_postgres_ref(self: Self) -> None:
         """Connects to postgres based on the database login defined the in the file_config
         Adds self.db to be the database reference
         """
@@ -598,7 +600,7 @@ async def get_postgres_ref(self) -> None:
 
     # Extension loading and management functions
 
-    async def get_potential_extensions(self) -> list[str]:
+    async def get_potential_extensions(self: Self) -> list[str]:
         """Gets the current list of extensions in the defined directory.
         This ONLY gets commands, not functions"""
         self.logger.console.info(f"Searching {self.EXTENSIONS_DIR} for extensions")
@@ -609,7 +611,7 @@ async def get_potential_extensions(self) -> list[str]:
         ]
         return extensions_list
 
-    async def get_potential_function_extensions(self) -> list[str]:
+    async def get_potential_function_extensions(self: Self) -> list[str]:
         """Gets the current list of extensions in the defined directory.
         This ONLY gets functions, not commands"""
         self.logger.console.info(f"Searching {self.FUNCTIONS_DIR} for extensions")
@@ -620,7 +622,7 @@ async def get_potential_function_extensions(self) -> list[str]:
         ]
         return extensions_list
 
-    async def load_extensions(self, graceful: bool = True) -> None:
+    async def load_extensions(self: Self, graceful: bool = True) -> None:
         """Loads all extensions currently in the extensions directory.
 
         Args:
@@ -670,7 +672,7 @@ async def load_extensions(self, graceful: bool = True) -> None:
                 if not graceful:
                     raise exception
 
-    def get_command_extension_name(self, command: commands.Command) -> str:
+    def get_command_extension_name(self: Self, command: commands.Command) -> str:
         """Gets the subname of an extension from a command.
         Used only for commands, should never be run for a function
 
@@ -683,7 +685,7 @@ def get_command_extension_name(self, command: commands.Command) -> str:
         return extension_name
 
     async def register_file_extension(
-        self, extension_name: str, fp: io.BufferedIOBase
+        self: Self, extension_name: str, fp: io.BufferedIOBase
     ) -> None:
         """Offers an interface for loading an extension from an external source.
 
@@ -709,7 +711,7 @@ async def register_file_extension(
 
     # Bot properties
 
-    async def is_bot_admin(self, member: discord.Member) -> bool:
+    async def is_bot_admin(self: Self, member: discord.Member) -> bool:
         """Processes command context against admin/owner data.
 
         Command checks are disabled if the context author is the owner.
@@ -743,7 +745,7 @@ async def is_bot_admin(self, member: discord.Member) -> bool:
 
         return False
 
-    async def get_owner(self) -> discord.User | None:
+    async def get_owner(self: Self) -> discord.User | None:
         """Gets the owner object from the bot application."""
         if not self.owner:
             try:
@@ -760,7 +762,7 @@ async def get_owner(self) -> discord.User | None:
 
         return self.owner
 
-    async def get_prefix(self, message: discord.Message) -> str:
+    async def get_prefix(self: Self, message: discord.Message) -> str:
         """Gets the appropriate prefix for a command.
         This is called by discord.py and must be async
 
@@ -774,7 +776,7 @@ async def get_prefix(self, message: discord.Message) -> str:
 
     # Can run command checks
 
-    async def command_run_admin_check(self, member: discord.Member) -> bool:
+    async def command_run_admin_check(self: Self, member: discord.Member) -> bool:
         """Part of the can_run function set. This is responsible for checking if
         the caller is a bot admin
 
@@ -787,7 +789,7 @@ async def command_run_admin_check(self, member: discord.Member) -> bool:
         return await self.is_bot_admin(member)
 
     def command_run_rate_limit_check(
-        self, member: discord.Member, guild: discord.Guild, command_id: int
+        self: Self, member: discord.Member, guild: discord.Guild, command_id: int
     ) -> bool:
         """Handle the command rate limiter
 
@@ -830,7 +832,7 @@ def command_run_rate_limit_check(
         return True
 
     def command_run_extension_disabled_check(
-        self, guild: discord.Guild, extension_name: str
+        self: Self, guild: discord.Guild, extension_name: str
     ) -> bool:
         """Checks if the extension is disabled
         Works for both prefix and slash commands
@@ -849,7 +851,7 @@ def command_run_extension_disabled_check(
 
     # Logging and checking if commands can run
 
-    async def interaction_check(self, interaction: discord.Interaction) -> bool:
+    async def interaction_check(self: Self, interaction: discord.Interaction) -> bool:
         """This is a default function of the command tree that always returns true
         We can use this to log and evaluate if commands should be run
 
@@ -912,7 +914,7 @@ async def interaction_check(self, interaction: discord.Interaction) -> bool:
         # Finally, return the default check, which is always True
         return True
 
-    async def slash_command_log(self, interaction: discord.Interaction) -> None:
+    async def slash_command_log(self: Self, interaction: discord.Interaction) -> None:
         """A command to log the call of a slash command
 
         Args:
@@ -996,7 +998,7 @@ async def can_run(
 
     # IRC Stuff
 
-    async def start_irc(self) -> None:
+    async def start_irc(self: Self) -> None:
         """Starts the IRC connection in a seperate thread"""
         irc_config = self.file_config.api.irc
         main_loop = asyncio.get_running_loop()

techsupport_bot/botlogging/common.py

@@ -1,8 +1,9 @@
 """A few common functions to help the logging system work smoothly"""
 
+from __future__ import annotations
+
 from dataclasses import dataclass
 from enum import Enum
-from typing import Optional
 
 import discord
 
@@ -23,10 +24,10 @@ class LogContext:
     This is used to determine if some guild settings means the log shouldn't be logged
 
     Args:
-        guild (discord.Guild): The guild the log occured with. Optional
-        channel (discord.abc.Messageble): The channel, DM, thread,
+        guild (discord.Guild | None): The guild the log occured with. Optional
+        channel (discord.abc.Messageble | None): The channel, DM, thread,
             or other messagable the log occured in
     """
 
-    guild: Optional[discord.Guild] = None
-    channel: Optional[discord.abc.Messageable] = None
+    guild: discord.Guild | None = None
+    channel: discord.abc.Messageable | None = None

techsupport_bot/botlogging/delayed.py

@@ -1,8 +1,10 @@
 """Module for delayed logging."""
 
+from __future__ import annotations
+
 import asyncio
 import os
-from typing import Any
+from typing import Any, Self
 
 from botlogging import logger
 
@@ -18,13 +20,13 @@ class DelayedLogger(logger.BotLogger):
         queue_size (int): the max number of queue events
     """
 
-    def __init__(self, *args: tuple, **kwargs: dict[str, Any]) -> None:
+    def __init__(self: Self, *args: tuple, **kwargs: dict[str, Any]) -> None:
         self.wait_time = kwargs.pop("wait_time", 1)
         self.queue_size = kwargs.pop("queue_size", 1000)
         self.__send_queue = None
         super().__init__(*args, **kwargs)
 
-    async def send_log(self, *args: tuple, **kwargs: dict[str, Any]) -> None:
+    async def send_log(self: Self, *args: tuple, **kwargs: dict[str, Any]) -> None:
         """Adds a log to the queue
         Does nothing different than the Logger send_log function()
         Will disregard debug logs if debug is off
@@ -37,11 +39,11 @@ async def send_log(self, *args: tuple, **kwargs: dict[str, Any]) -> None:
 
         await self.__send_queue.put(super().send_log(*args, **kwargs))
 
-    def register_queue(self) -> None:
+    def register_queue(self: Self) -> None:
         """Registers the asyncio.Queue object to make delayed logging possible"""
         self.__send_queue = asyncio.Queue(maxsize=self.queue_size)
 
-    async def run(self) -> None:
+    async def run(self: Self) -> None:
         """A forever loop that pulls from the queue and then waits based on the config"""
         while True:
             try:

techsupport_bot/botlogging/embed.py

@@ -1,6 +1,9 @@
 """Module for log embeds."""
 
+from __future__ import annotations
+
 import datetime
+from typing import Self
 
 import discord
 
@@ -11,13 +14,13 @@ class LogEmbed(discord.Embed):
     title = None
     color = None
 
-    def __init__(self, message):
+    def __init__(self: Self, message: str) -> None:
         super().__init__(
             title=self.title.upper(), description=message, color=self.color
         )
         self.timestamp = datetime.datetime.utcnow()
 
-    def modify_embed(self, embed: discord.Embed) -> discord.Embed:
+    def modify_embed(self: Self, embed: discord.Embed) -> discord.Embed:
         """This modifies an existing embed to match with the LogEmbed style
 
         Args: