Black/lint

Author: Taaku18

bot.py

@@ -86,7 +86,9 @@ def __init__(self):
         try:
             self.db = AsyncIOMotorClient(mongo_uri).modmail_bot
         except ConfigurationError as e:
-            logger.critical("Your MONGO_URI is copied wrong, try re-copying from the source again.")
+            logger.critical(
+                "Your MONGO_URI is copied wrong, try re-copying from the source again."
+            )
             logger.critical(str(e))
             sys.exit(0)
 
@@ -213,7 +215,9 @@ def owner_ids(self):
             owner_ids = set(map(int, str(owner_ids).split(",")))
         if self.owner_id is not None:
             owner_ids.add(self.owner_id)
-        permissions = self.config["level_permissions"].get(PermissionLevel.OWNER.name, [])
+        permissions = self.config["level_permissions"].get(
+            PermissionLevel.OWNER.name, []
+        )
         for perm in permissions:
             owner_ids.add(int(perm))
         return owner_ids
@@ -230,13 +234,16 @@ def log_channel(self) -> typing.Optional[discord.TextChannel]:
             channel = self.get_channel(int(channel_id))
             if channel is not None:
                 return channel
-            logger.debug('LOG_CHANNEL_ID was invalid, removed.')
+            logger.debug("LOG_CHANNEL_ID was invalid, removed.")
             self.config.remove("log_channel_id")
         if self.main_category is not None:
             try:
                 channel = self.main_category.channels[0]
                 self.config["log_channel_id"] = channel.id
-                logger.warning("No log channel set, setting #%s to be the log channel.", channel.name)
+                logger.warning(
+                    "No log channel set, setting #%s to be the log channel.",
+                    channel.name,
+                )
                 return channel
             except IndexError:
                 pass
@@ -268,7 +275,9 @@ def aliases(self) -> typing.Dict[str, str]:
     def token(self) -> str:
         token = self.config["token"]
         if token is None:
-            logger.critical("TOKEN must be set, set this as bot token found on the Discord Dev Portal.")
+            logger.critical(
+                "TOKEN must be set, set this as bot token found on the Discord Dev Portal."
+            )
             sys.exit(0)
         return token
 
@@ -321,11 +330,13 @@ def main_category(self) -> typing.Optional[discord.CategoryChannel]:
                 if cat is not None:
                     return cat
                 self.config.remove("main_category_id")
-                logger.debug('MAIN_CATEGORY_ID was invalid, removed.')
+                logger.debug("MAIN_CATEGORY_ID was invalid, removed.")
             cat = discord.utils.get(self.modmail_guild.categories, name="Modmail")
             if cat is not None:
                 self.config["main_category_id"] = cat.id
-                logger.debug("No main category set explicitly, setting category \"Modmail\" as the main category.")
+                logger.debug(
+                    'No main category set explicitly, setting category "Modmail" as the main category.'
+                )
                 return cat
         return None
 
@@ -404,7 +415,7 @@ async def setup_indexes(self):
                     ("key", "text"),
                 ]
             )
-        logger.debug('Successfully set up database indexes.')
+        logger.debug("Successfully set up database indexes.")
 
     async def on_ready(self):
         """Bot startup, sets uptime."""
@@ -413,7 +424,7 @@ async def on_ready(self):
         await self.wait_for_connected()
 
         if self.guild is None:
-            logger.debug('Logging out due to invalid GUILD_ID.')
+            logger.debug("Logging out due to invalid GUILD_ID.")
             return await self.logout()
 
         logger.line()
@@ -444,12 +455,12 @@ async def on_ready(self):
 
             if not thread:
                 # If the channel is deleted
-                logger.debug('Failed to close thread for recipient %s.', recipient_id)
+                logger.debug("Failed to close thread for recipient %s.", recipient_id)
                 self.config["closures"].pop(recipient_id)
                 await self.config.update()
                 continue
 
-            logger.debug('Closing thread for recipient %s.', recipient_id)
+            logger.debug("Closing thread for recipient %s.", recipient_id)
 
             await thread.close(
                 closer=self.get_user(items["closer_id"]),
@@ -579,7 +590,7 @@ async def _process_blocked(self, message: discord.Message) -> bool:
             reaction = blocked_emoji
             changed = False
             delta = human_timedelta(min_account_age)
-            logger.debug('Blocked due to account age, user %s.', message.author.name)
+            logger.debug("Blocked due to account age, user %s.", message.author.name)
 
             if str(message.author.id) not in self.blocked_users:
                 new_reason = (
@@ -603,7 +614,7 @@ async def _process_blocked(self, message: discord.Message) -> bool:
             reaction = blocked_emoji
             changed = False
             delta = human_timedelta(min_guild_age)
-            logger.debug('Blocked due to guild age, user %s.', message.author.name)
+            logger.debug("Blocked due to guild age, user %s.", message.author.name)
 
             if str(message.author.id) not in self.blocked_users:
                 new_reason = (
@@ -628,13 +639,15 @@ async def _process_blocked(self, message: discord.Message) -> bool:
             ):
                 # Met the age limit already, otherwise it would've been caught by the previous if's
                 reaction = sent_emoji
-                logger.debug('No longer internally blocked, user %s.', message.author.name)
+                logger.debug(
+                    "No longer internally blocked, user %s.", message.author.name
+                )
                 self.blocked_users.pop(str(message.author.id))
             else:
                 reaction = blocked_emoji
                 end_time = re.search(r"%(.+?)%$", reason)
                 if end_time is not None:
-                    logger.debug('No longer blocked, user %s.', message.author.name)
+                    logger.debug("No longer blocked, user %s.", message.author.name)
                     after = (
                         datetime.fromisoformat(end_time.group(1)) - now
                     ).total_seconds()
@@ -643,7 +656,7 @@ async def _process_blocked(self, message: discord.Message) -> bool:
                         reaction = sent_emoji
                         self.blocked_users.pop(str(message.author.id))
                 else:
-                    logger.debug('User blocked, user %s.', message.author.name)
+                    logger.debug("User blocked, user %s.", message.author.name)
         else:
             reaction = sent_emoji
 
@@ -652,7 +665,7 @@ async def _process_blocked(self, message: discord.Message) -> bool:
             try:
                 await message.add_reaction(reaction)
             except (discord.HTTPException, discord.InvalidArgument):
-                logger.warning('Failed to add reaction %s.', reaction, exc_info=True)
+                logger.warning("Failed to add reaction %s.", reaction, exc_info=True)
         return str(message.author.id) in self.blocked_users
 
     async def process_modmail(self, message: discord.Message) -> None:
@@ -839,9 +852,13 @@ async def on_raw_reaction_add(self, payload):
         if isinstance(channel, discord.DMChannel):
             if str(reaction) == str(close_emoji):  # closing thread
                 try:
-                    recipient_thread_close = strtobool(self.config["recipient_thread_close"])
+                    recipient_thread_close = strtobool(
+                        self.config["recipient_thread_close"]
+                    )
                 except ValueError:
-                    recipient_thread_close = self.config.remove("recipient_thread_close")
+                    recipient_thread_close = self.config.remove(
+                        "recipient_thread_close"
+                    )
                 if not recipient_thread_close:
                     return
                 thread = await self.threads.find(recipient=user)
@@ -875,7 +892,7 @@ async def on_guild_channel_delete(self, channel):
 
         if isinstance(channel, discord.CategoryChannel):
             if self.main_category.id == channel.id:
-                logger.debug('Main category was deleted.')
+                logger.debug("Main category was deleted.")
                 self.config.remove("main_category_id")
                 await self.config.update()
             return
@@ -884,14 +901,14 @@ async def on_guild_channel_delete(self, channel):
             return
 
         if self.log_channel is None or self.log_channel.id == channel.id:
-            logger.info('Log channel deleted.')
+            logger.info("Log channel deleted.")
             self.config.remove("log_channel_id")
             await self.config.update()
             return
 
         thread = await self.threads.find(channel=channel)
         if thread:
-            logger.debug('Manually closed channel %s.', channel.name)
+            logger.debug("Manually closed channel %s.", channel.name)
             await thread.close(closer=mod, silent=True, delete_channel=False)
 
     async def on_member_remove(self, member):
@@ -1062,7 +1079,8 @@ async def after_post_metadata(self):
 if __name__ == "__main__":
     try:
         import uvloop
-        logger.debug('Setting up with uvloop.')
+
+        logger.debug("Setting up with uvloop.")
         uvloop.install()
     except ImportError:
         pass

cogs/plugins.py

@@ -136,7 +136,7 @@ async def load_plugin(self, username, repo, plugin_name, branch):
                     # so there's no terminal output unless there's an error
             except subprocess.CalledProcessError as exc:
                 err = exc.stderr.decode("utf8").strip()
-                logger.error('Error.', exc_info=True)
+                logger.error("Error.", exc_info=True)
                 if err:
                     msg = f"Requirements Download Error: {username}/{repo}@{branch}[{plugin_name}]"
                     logger.error(msg)
@@ -174,7 +174,9 @@ async def plugin_add(self, ctx, *, plugin_name: str):
 
         if plugin_name in self.registry:
             details = self.registry[plugin_name]
-            plugin_name = details["repository"] + "/" + plugin_name + "@" + details["branch"]
+            plugin_name = (
+                details["repository"] + "/" + plugin_name + "@" + details["branch"]
+            )
 
             required_version = details["bot_version"]
 
@@ -213,7 +215,9 @@ async def plugin_add(self, ctx, *, plugin_name: str):
                     await self.download_plugin_repo(username, repo, branch)
                 except Exception as exc:
                     if not isinstance(exc, DownloadError):
-                        logger.error('Unknown error when adding a plugin:', exc_info=True)
+                        logger.error(
+                            "Unknown error when adding a plugin:", exc_info=True
+                        )
                     embed = discord.Embed(
                         description=f"Unable to fetch this plugin from Github: `{exc}`.",
                         color=self.bot.main_color,
@@ -226,7 +230,9 @@ async def plugin_add(self, ctx, *, plugin_name: str):
                     await self.load_plugin(username, repo, name, branch)
                 except Exception as exc:
                     if not isinstance(exc, DownloadError):
-                        logger.error('Unknown error when adding a plugin:', exc_info=True)
+                        logger.error(
+                            "Unknown error when adding a plugin:", exc_info=True
+                        )
                     embed = discord.Embed(
                         description=f"Unable to load this plugin: `{exc}`.",
                         color=self.bot.main_color,
@@ -249,7 +255,7 @@ async def plugin_add(self, ctx, *, plugin_name: str):
             else:
                 embed = discord.Embed(
                     description="Invalid plugin name format: use plugin-name or "
-                                "username/repo/plugin or username/repo/plugin@branch.",
+                    "username/repo/plugin or username/repo/plugin@branch.",
                     color=self.bot.main_color,
                 )
                 await ctx.send(embed=embed)
@@ -272,7 +278,7 @@ async def plugin_remove(self, ctx, *, plugin_name: str):
                     f"plugins.{username}-{repo}-{branch}.{name}.{name}"
                 )
             except commands.ExtensionNotLoaded:
-                logger.error('Plugin was never loaded.')
+                logger.error("Plugin was never loaded.")
 
             self.bot.config["plugins"].remove(plugin_name)
 
@@ -291,8 +297,8 @@ def onerror(func, path, exc_info):  # pylint: disable=W0613
                     shutil.rmtree(
                         f"plugins/{username}-{repo}-{branch}", onerror=onerror
                     )
-            except Exception as exc:
-                logger.error('Failed to remove plugin %s.', plugin_name, exc_info=True)
+            except Exception:
+                logger.error("Failed to remove plugin %s.", plugin_name, exc_info=True)
                 self.bot.config["plugins"].append(plugin_name)
                 return
 
@@ -316,7 +322,9 @@ async def plugin_update(self, ctx, *, plugin_name: str):
 
         if plugin_name in self.registry:
             details = self.registry[plugin_name]
-            plugin_name = details["repository"] + "/" + plugin_name + "@" + details["branch"]
+            plugin_name = (
+                details["repository"] + "/" + plugin_name + "@" + details["branch"]
+            )
 
         if plugin_name not in self.bot.config["plugins"]:
             embed = discord.Embed(
@@ -328,8 +336,10 @@ async def plugin_update(self, ctx, *, plugin_name: str):
             username, repo, name, branch = self.parse_plugin(plugin_name)
 
             try:
-                cmd = f"cd plugins/{username}-{repo}-{branch} && " \
+                cmd = (
+                    f"cd plugins/{username}-{repo}-{branch} && "
                     f"git reset --hard origin/{branch} && git fetch --all && git pull"
+                )
                 cmd = await self.bot.loop.run_in_executor(
                     None, self._asubprocess_run, cmd
                 )
@@ -340,7 +350,7 @@ async def plugin_update(self, ctx, *, plugin_name: str):
                     description=f"An error occurred while updating: {err}.",
                     color=self.bot.main_color,
                 )
-                logger.error('An error occurred while updating plugin:', exc_info=True)
+                logger.error("An error occurred while updating plugin:", exc_info=True)
                 await ctx.send(embed=embed)
 
             else:
@@ -363,7 +373,9 @@ async def plugin_update(self, ctx, *, plugin_name: str):
                             description=f"Unable to start the plugin: `{exc}`.",
                             color=self.bot.main_color,
                         )
-                        logger.error('An error occurred while updating plugin:', exc_info=True)
+                        logger.error(
+                            "An error occurred while updating plugin:", exc_info=True
+                        )
                         await ctx.send(embed=embed)
 
     @plugin.command(name="enabled", aliases=["installed"])
@@ -408,7 +420,9 @@ async def plugin_registry(self, ctx, *, plugin_name: typing.Union[int, str] = No
             if index >= len(registry):
                 index = len(registry) - 1
         else:
-            index = next((i for i, (n, _) in enumerate(registry) if plugin_name == n), 0)
+            index = next(
+                (i for i, (n, _) in enumerate(registry) if plugin_name == n), 0
+            )
 
         if not index and plugin_name is not None:
             embed = discord.Embed(

cogs/utility.py

@@ -246,6 +246,8 @@ async def changelog(self, ctx, version: str.lower = ""):
             paginator = PaginatorSession(ctx, *changelog.embeds)
             paginator.current = index
             await paginator.run()
+        except asyncio.CancelledError:
+            pass
         except Exception:
             await ctx.send(changelog.CHANGELOG_URL)
 

core/changelog.py

@@ -120,12 +120,15 @@ class Changelog:
         "https://raw.githubusercontent.com/kyb3r/modmail/master/CHANGELOG.md"
     )
     CHANGELOG_URL = "https://github.com/kyb3r/modmail/blob/master/CHANGELOG.md"
-    VERSION_REGEX = re.compile(r"# ([vV]\d+\.\d+(?:\.\d+)?)(.*?(?=# (?:[vV]\d+\.\d+(?:\.\d+)?)|$))", flags=re.DOTALL)
+    VERSION_REGEX = re.compile(
+        r"# ([vV]\d+\.\d+(?:\.\d+)?)(.*?(?=# (?:[vV]\d+\.\d+(?:\.\d+)?)|$))",
+        flags=re.DOTALL,
+    )
 
     def __init__(self, bot, text: str):
         self.bot = bot
         self.text = text
-        logger.debug('Fetching changelog from GitHub.')
+        logger.debug("Fetching changelog from GitHub.")
         self.versions = [Version(bot, *m) for m in self.VERSION_REGEX.findall(text)]
 
     @property

core/clients.py

@@ -88,17 +88,17 @@ def logs(self):
     async def get_user_logs(self, user_id: Union[str, int]) -> list:
         query = {"recipient.id": str(user_id), "guild_id": str(self.bot.guild_id)}
         projection = {"messages": {"$slice": 5}}
-        logger.debug('Retrieving user %s logs.', user_id)
+        logger.debug("Retrieving user %s logs.", user_id)
 
         return await self.logs.find(query, projection).to_list(None)
 
     async def get_log(self, channel_id: Union[str, int]) -> dict:
-        logger.debug('Retrieving channel %s logs.', channel_id)
+        logger.debug("Retrieving channel %s logs.", channel_id)
         return await self.logs.find_one({"channel_id": str(channel_id)})
 
     async def get_log_link(self, channel_id: Union[str, int]) -> str:
         doc = await self.get_log(channel_id)
-        logger.debug('Retrieving log link for channel %s.', channel_id)
+        logger.debug("Retrieving log link for channel %s.", channel_id)
         return f"{self.bot.config['log_url'].strip('/')}{self.bot.config['log_url_prefix']}/{doc['key']}"
 
     async def create_log_entry(
@@ -134,13 +134,13 @@ async def create_log_entry(
                 "messages": [],
             }
         )
-        logger.debug('Created a log entry, key %s.', key)
+        logger.debug("Created a log entry, key %s.", key)
         return f"{self.bot.config['log_url'].strip('/')}{self.bot.config['log_url_prefix']}/{key}"
 
     async def get_config(self) -> dict:
         conf = await self.db.config.find_one({"bot_id": self.bot.user.id})
         if conf is None:
-            logger.debug('Creating a new config entry for bot %s.', self.bot.user.id)
+            logger.debug("Creating a new config entry for bot %s.", self.bot.user.id)
             await self.db.config.insert_one({"bot_id": self.bot.user.id})
             return {"bot_id": self.bot.user.id}
         return conf