Make all files flake8 compliant

Author: ChrisLovering

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Code of Conduct
 
-The Python Discord Code of Conduct can be found [on our website](https://pydis.com/coc).
+The Python Discord Code of Conduct can be found [on our website](https://pydis.com/coc).

CONTRIBUTING.md

@@ -1,3 +1,3 @@
 # Contributing Guidelines
 
-The Contributing Guidelines for Python Discord projects can be found [on our website](https://pydis.com/contributing.md).
+The Contributing Guidelines for Python Discord projects can be found [on our website](https://pydis.com/contributing.md).

SECURITY.md

@@ -1,3 +1,3 @@
 # Security Notice
 
-The Security Notice for Python Discord projects can be found [on our website](https://pydis.com/security.md).
+The Security Notice for Python Discord projects can be found [on our website](https://pydis.com/security.md).

ban_appeals/ban_appeals.py

@@ -17,7 +17,10 @@
 
 log = getLogger(__name__)
 
+
 class BanAppeals(commands.Cog):
+    """A plugin to manage threads from a separate ban appeal server."""
+
     def __init__(self, bot: ModmailBot):
         self.bot = bot
 
@@ -30,8 +33,8 @@ def __init__(self, bot: ModmailBot):
 
         self.appeals_category: t.Optional[discord.CategoryChannel] = None
 
-        self.init_task = asyncio.create_task(self.ensure_plugin_init())
-    
+        self.init_task = asyncio.create_task(self.init_plugin())
+
     @staticmethod
     async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> t.Optional[discord.Member]:
         """
@@ -49,7 +52,7 @@ async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> t.Optiona
                 return None
             log.debug("%s (%d) fetched from API.", member, member.id)
         return member
-    
+
     @staticmethod
     async def get_or_fetch_channel(guild: discord.Guild, channel_id: int) -> t.Optional[discord.ChannelType]:
         """
@@ -69,15 +72,16 @@ async def get_or_fetch_channel(guild: discord.Guild, channel_id: int) -> t.Optio
 
         return channel
 
-    async def ensure_plugin_init(self) -> None:
+    async def init_plugin(self) -> None:
+        """Initialise the plugin's configuration."""
         self.pydis_guild = self.bot.guild
         self.appeals_guild = self.bot.get_guild(self._appeals_guild_id)
         self.appeals_category = await self.get_or_fetch_channel(self.pydis_guild, self._pydis_appeals_category_id)
         self.logs_channel = discord.utils.get(self.appeals_guild.channels, name="logs")
 
         log.info("Plugin loaded, checking if there are people to kick.")
         await self._sync_kicks()
-    
+
     async def _sync_kicks(self) -> None:
         """Iter through all members in appeals guild, kick them if they meet criteria."""
         for member in self.appeals_guild.members:
@@ -102,7 +106,7 @@ async def _maybe_kick_user(self, member: discord.Member) -> None:
                 log.error("Failed to kick %s (%d)due to insufficient permissions.", member, member.id)
             await self.logs_channel.send(f"Kicked {member} ({member.id}) on join as they're not banned in main server.")
             log.info("Kicked %s (%d).", member, member.id)
-    
+
     async def _is_banned_pydis(self, member: discord.Member) -> bool:
         """See if the given member is banned in PyDis."""
         try:
@@ -128,7 +132,7 @@ async def on_member_join(self, member: discord.Member) -> None:
             # Join event from the appeals server
             # Kick them if they are not banned and not part of the bypass list
             await self._maybe_kick_user(member)
-    
+
     @commands.Cog.listener()
     async def on_thread_ready(self, thread: Thread, *args) -> None:
         """If the new thread is for an appeal, move it to the appeals category."""
@@ -138,5 +142,6 @@ async def on_thread_ready(self, thread: Thread, *args) -> None:
             await thread.channel.edit(category=self.appeals_category, sync_permissions=True)
 
 
-def setup(bot: ModmailBot):
+def setup(bot: ModmailBot) -> None:
+    """Add the BanAppeals cog."""
     bot.add_cog(BanAppeals(bot))

close_message/close_message.py

@@ -1,5 +1,6 @@
 from discord.ext import commands
 
+from bot import ModmailBot
 from core import checks
 from core import time
 from core.models import PermissionLevel
@@ -8,7 +9,10 @@
 
 
 class UserFriendlyTimeOnly(time.UserFriendlyTime):
-    async def convert(self, ctx, argument):
+    """A convertor class to convert user friendly time to a duration."""
+
+    async def convert(self, ctx: commands.Context, argument: str) -> str:
+        """Convert the given argument to a user friendly time."""
         converted = await super().convert(ctx, argument)
         if converted.arg:
             raise commands.BadArgument(
@@ -19,22 +23,27 @@ async def convert(self, ctx, argument):
 
 
 class CloseMessage(commands.Cog):
-    def __init__(self, bot):
+    """A plugin that adds a command to close a thread after a given period with a set message."""
+
+    def __init__(self, bot: ModmailBot):
         self.bot = bot
         self.close_command = self.bot.get_command('close')
 
-    @commands.command(name='closemessage', aliases=['cm'],
-                      usage="[after]",
-                      help='Close the current thread with the message '
-                           f'`{CLOSING_MESSAGE}`')
+    @commands.command(
+        name="closemessage", aliases=("cm"),
+        usage="[after]",
+        help=f"Close the current thread with the message `{CLOSING_MESSAGE}`"
+    )
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
-    async def close_message(self, ctx, *, after='15m'):
+    async def close_message(self, ctx: commands.Context, *, after: str = '15m') -> commands.Command:
+        """Close the thread after the given duration with the set message."""
         if after.isdigit():
             after = f'{after}m'
         after = await UserFriendlyTimeOnly().convert(ctx, after)
         return await self.close_command(ctx, after=after)
 
 
-def setup(bot):
+def setup(bot: ModmailBot) -> None:
+    """Load the CloseMessage plugin."""
     bot.add_cog(CloseMessage(bot))

mdlink/mdlink.py

@@ -1,22 +1,25 @@
-import discord
 from discord.ext import commands
 
+from bot import ModmailBot
 from core import checks
 from core.models import PermissionLevel
 
 
 class MDLink(commands.Cog):
-    def __init__(self, bot):
+    """A plugin to get a link to the modmail thread using MD syntax."""
+
+    def __init__(self, bot: ModmailBot):
         self.bot = bot
 
     @commands.command()
     @checks.has_permissions(PermissionLevel.MODERATOR)
     @checks.thread_only()
-    async def mdlink(self, ctx, *, text="ModMail"):
+    async def mdlink(self, ctx: commands.Context, *, text: str = "ModMail") -> None:
         """Return a link to the modmail thread in markdown syntax."""
         link = await self.bot.api.get_log_link(ctx.channel.id)
         await ctx.send(f"`[{text}]({link})`")
 
 
-def setup(bot):
+def setup(bot: ModmailBot) -> None:
+    """Add the MDLink plugin."""
     bot.add_cog(MDLink(bot))

reply_cooldown/reply_cooldown.py

@@ -1,7 +1,10 @@
-from collections import deque
 import time
+from collections import deque
 
 import discord
+from discord.ext import commands
+
+from bot import ModmailBot
 from core.thread import Thread
 
 # Number of messages kept in memory to check for double sends
@@ -13,11 +16,13 @@
 COOLDOWN_TIME = 10
 
 
-def setup(bot):
+def setup(bot: ModmailBot) -> None:
+    """Monkey patch the built-in reply function to add a cooldown between uses."""
     _reply = Thread.reply
 
-    async def reply(self, message: discord.Message, anonymous: bool = False, plain: bool = False):
-        # Bypass the cooldown if the message has attachements
+    async def reply(self: commands.Cog, message: discord.Message, anonymous: bool = False, plain: bool = False) -> None:
+        """The new reply function with a cooldown between uses."""
+        # Bypass the cooldown if the message has attachments.
         if not message.attachments:
             for entry in MESSAGES_BUFFER:
                 if (

tagging/tagging.py

@@ -2,19 +2,23 @@
 
 from discord.ext import commands
 
+from bot import ModmailBot
 from core import checks
 from core.models import PermissionLevel
 
 
 class Tagging(commands.Cog):
-    def __init__(self, bot):
+    """A plugin that enables mods to prefix the thread name with a tag."""
+
+    def __init__(self, bot: ModmailBot):
         self.bot = bot
 
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @commands.command()
-    async def tag(self, ctx, tag: Optional[str]):
+    async def tag(self, ctx: commands.Context, tag: Optional[str]) -> None:
         """
         Append a tag at the beginning of the channel name.
+
         Using the command without any argument will reset it.
         """
         clean_name = ctx.channel.name.split("｜", maxsplit=1)[-1]
@@ -28,5 +32,6 @@ async def tag(self, ctx, tag: Optional[str]):
         await ctx.message.add_reaction("\u2705")
 
 
-def setup(bot):
+def setup(bot: ModmailBot) -> None:
+    """Add the Tagging plugin."""
     bot.add_cog(Tagging(bot))