style: Using black formatter

Author: kkrypt0nn

CONTRIBUTING.md

@@ -22,7 +22,7 @@ Pull requests are the best way to propose changes to the codebase. We actively w
 
 1. Fork the repo and create your branch from `main`.
 2. Keep consistency with the current state of the codebase, this includes but is not limited to naming convention, Discord embeds, etc.
-3. Format the code of the files you've edited with the **autopep8** formatter.
+3. Format the code of the files you've edited with the **black** formatter.
 4. Issue that pull request!
 
 ## Commit messages guidelines

README.md

@@ -6,8 +6,8 @@
   <a href="https://github.com/kkrypt0nn/Python-Discord-Bot-Template/commits/main"><img src="https://img.shields.io/github/last-commit/kkrypt0nn/Python-Discord-Bot-Template"></a>
   <a href="https://github.com/kkrypt0nn/Python-Discord-Bot-Template/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/kkrypt0nn/Python-Discord-Bot-Template"></a>
   <a href="https://github.com/kkrypt0nn/Python-Discord-Bot-Template"><img src="https://img.shields.io/github/languages/code-size/kkrypt0nn/Python-Discord-Bot-Template"></a>
-  <a href="https://github.com/kkrypt0nn/Python-Discord-Bot-Template/issues"><img src="https://img.shields.io/github/issues-raw/kkrypt0nn/Python-Discord-Bot-Template"></a>
   <a href="https://conventionalcommits.org/en/v1.0.0/"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white"></a>
+  <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 </p>
 
 This repository is a template that everyone can use for the start of their discord bot.

bot.py

@@ -70,10 +70,15 @@
 """
 # intents.message_content = True
 
-bot = Bot(command_prefix=commands.when_mentioned_or(
-    config["prefix"]), intents=intents, help_command=None)
+bot = Bot(
+    command_prefix=commands.when_mentioned_or(config["prefix"]),
+    intents=intents,
+    help_command=None,
+)
 
 # Setup both of the loggers
+
+
 class LoggingFormatter(logging.Formatter):
     # Colors
     black = "\x1b[30m"
@@ -91,7 +96,7 @@ class LoggingFormatter(logging.Formatter):
         logging.INFO: blue + bold,
         logging.WARNING: yellow + bold,
         logging.ERROR: red,
-        logging.CRITICAL: red + bold
+        logging.CRITICAL: red + bold,
     }
 
     def format(self, record):
@@ -112,10 +117,10 @@ def format(self, record):
 console_handler = logging.StreamHandler()
 console_handler.setFormatter(LoggingFormatter())
 # File handler
-file_handler = logging.FileHandler(
-    filename="discord.log", encoding="utf-8", mode="w")
+file_handler = logging.FileHandler(filename="discord.log", encoding="utf-8", mode="w")
 file_handler_formatter = logging.Formatter(
-    "[{asctime}] [{levelname:<8}] {name}: {message}", "%Y-%m-%d %H:%M:%S", style="{")
+    "[{asctime}] [{levelname:<8}] {name}: {message}", "%Y-%m-%d %H:%M:%S", style="{"
+)
 file_handler.setFormatter(file_handler_formatter)
 
 # Add the handlers
@@ -125,8 +130,12 @@ def format(self, record):
 
 
 async def init_db():
-    async with aiosqlite.connect(f"{os.path.realpath(os.path.dirname(__file__))}/database/database.db") as db:
-        with open(f"{os.path.realpath(os.path.dirname(__file__))}/database/schema.sql") as file:
+    async with aiosqlite.connect(
+        f"{os.path.realpath(os.path.dirname(__file__))}/database/database.db"
+    ) as db:
+        with open(
+            f"{os.path.realpath(os.path.dirname(__file__))}/database/schema.sql"
+        ) as file:
             await db.executescript(file.read())
         await db.commit()
 
@@ -149,8 +158,7 @@ async def on_ready() -> None:
     bot.logger.info(f"Logged in as {bot.user.name}")
     bot.logger.info(f"discord.py API version: {discord.__version__}")
     bot.logger.info(f"Python version: {platform.python_version()}")
-    bot.logger.info(
-        f"Running on: {platform.system()} {platform.release()} ({os.name})")
+    bot.logger.info(f"Running on: {platform.system()} {platform.release()} ({os.name})")
     bot.logger.info("-------------------")
     status_task.start()
     if config["sync_commands_globally"]:
@@ -191,10 +199,12 @@ async def on_command_completion(context: Context) -> None:
     executed_command = str(split[0])
     if context.guild is not None:
         bot.logger.info(
-            f"Executed {executed_command} command in {context.guild.name} (ID: {context.guild.id}) by {context.author} (ID: {context.author.id})")
+            f"Executed {executed_command} command in {context.guild.name} (ID: {context.guild.id}) by {context.author} (ID: {context.author.id})"
+        )
     else:
         bot.logger.info(
-            f"Executed {executed_command} command by {context.author} (ID: {context.author.id}) in DMs")
+            f"Executed {executed_command} command by {context.author} (ID: {context.author.id}) in DMs"
+        )
 
 
 @bot.event
@@ -211,7 +221,7 @@ async def on_command_error(context: Context, error) -> None:
         hours = hours % 24
         embed = discord.Embed(
             description=f"**Please slow down** - You can use this command again in {f'{round(hours)} hours' if round(hours) > 0 else ''} {f'{round(minutes)} minutes' if round(minutes) > 0 else ''} {f'{round(seconds)} seconds' if round(seconds) > 0 else ''}.",
-            color=0xE02B2B
+            color=0xE02B2B,
         )
         await context.send(embed=embed)
     elif isinstance(error, exceptions.UserBlacklisted):
@@ -220,49 +230,55 @@ async def on_command_error(context: Context, error) -> None:
         the @checks.not_blacklisted() check in your command, or you can raise the error by yourself.
         """
         embed = discord.Embed(
-            description="You are blacklisted from using the bot!",
-            color=0xE02B2B
+            description="You are blacklisted from using the bot!", color=0xE02B2B
         )
         await context.send(embed=embed)
         if context.guild:
-            bot.logger.warning(f"{context.author} (ID: {context.author.id}) tried to execute a command in the guild {context.guild.name} (ID: {context.guild.id}), but the user is blacklisted from using the bot.")
+            bot.logger.warning(
+                f"{context.author} (ID: {context.author.id}) tried to execute a command in the guild {context.guild.name} (ID: {context.guild.id}), but the user is blacklisted from using the bot."
+            )
         else:
-            bot.logger.warning(f"{context.author} (ID: {context.author.id}) tried to execute a command in the bot's DMs, but the user is blacklisted from using the bot.")
+            bot.logger.warning(
+                f"{context.author} (ID: {context.author.id}) tried to execute a command in the bot's DMs, but the user is blacklisted from using the bot."
+            )
     elif isinstance(error, exceptions.UserNotOwner):
         """
         Same as above, just for the @checks.is_owner() check.
         """
         embed = discord.Embed(
-            description="You are not the owner of the bot!",
-            color=0xE02B2B
+            description="You are not the owner of the bot!", color=0xE02B2B
         )
         await context.send(embed=embed)
         if context.guild:
             bot.logger.warning(
-            f"{context.author} (ID: {context.author.id}) tried to execute an owner only command in the guild {context.guild.name} (ID: {context.guild.id}), but the user is not an owner of the bot.")
+                f"{context.author} (ID: {context.author.id}) tried to execute an owner only command in the guild {context.guild.name} (ID: {context.guild.id}), but the user is not an owner of the bot."
+            )
         else:
             bot.logger.warning(
-            f"{context.author} (ID: {context.author.id}) tried to execute an owner only command in the bot's DMs, but the user is not an owner of the bot.")
+                f"{context.author} (ID: {context.author.id}) tried to execute an owner only command in the bot's DMs, but the user is not an owner of the bot."
+            )
     elif isinstance(error, commands.MissingPermissions):
         embed = discord.Embed(
-            description="You are missing the permission(s) `" + ", ".join(
-                error.missing_permissions) + "` to execute this command!",
-            color=0xE02B2B
+            description="You are missing the permission(s) `"
+            + ", ".join(error.missing_permissions)
+            + "` to execute this command!",
+            color=0xE02B2B,
         )
         await context.send(embed=embed)
     elif isinstance(error, commands.BotMissingPermissions):
         embed = discord.Embed(
-            description="I am missing the permission(s) `" + ", ".join(
-                error.missing_permissions) + "` to fully perform this command!",
-            color=0xE02B2B
+            description="I am missing the permission(s) `"
+            + ", ".join(error.missing_permissions)
+            + "` to fully perform this command!",
+            color=0xE02B2B,
         )
         await context.send(embed=embed)
     elif isinstance(error, commands.MissingRequiredArgument):
         embed = discord.Embed(
             title="Error!",
             # We need to capitalize because the command arguments have no capital letter in the code.
             description=str(error).capitalize(),
-            color=0xE02B2B
+            color=0xE02B2B,
         )
         await context.send(embed=embed)
     else:
@@ -281,8 +297,7 @@ async def load_cogs() -> None:
                 bot.logger.info(f"Loaded extension '{extension}'")
             except Exception as e:
                 exception = f"{type(e).__name__}: {e}"
-                bot.logger.error(
-                    f"Failed to load extension {extension}\n{exception}")
+                bot.logger.error(f"Failed to load extension {extension}\n{exception}")
 
 
 asyncio.run(init_db())

cogs/fun.py

@@ -22,7 +22,9 @@ def __init__(self):
         self.value = None
 
     @discord.ui.button(label="Heads", style=discord.ButtonStyle.blurple)
-    async def confirm(self, button: discord.ui.Button, interaction: discord.Interaction):
+    async def confirm(
+        self, button: discord.ui.Button, interaction: discord.Interaction
+    ):
         self.value = "heads"
         self.stop()
 
@@ -66,8 +68,7 @@ async def callback(self, interaction: discord.Interaction):
 
         result_embed = discord.Embed(color=0x9C84EF)
         result_embed.set_author(
-            name=interaction.user.name,
-            icon_url=interaction.user.avatar.url
+            name=interaction.user.name, icon_url=interaction.user.avatar.url
         )
 
         if user_choice_index == bot_choice_index:
@@ -83,9 +84,13 @@ async def callback(self, interaction: discord.Interaction):
             result_embed.description = f"**You won!**\nYou've chosen {user_choice} and I've chosen {bot_choice}."
             result_embed.colour = 0x9C84EF
         else:
-            result_embed.description = f"**I won!**\nYou've chosen {user_choice} and I've chosen {bot_choice}."
+            result_embed.description = (
+                f"**I won!**\nYou've chosen {user_choice} and I've chosen {bot_choice}."
+            )
             result_embed.colour = 0xE02B2B
-        await interaction.response.edit_message(embed=result_embed, content=None, view=None)
+        await interaction.response.edit_message(
+            embed=result_embed, content=None, view=None
+        )
 
 
 class RockPaperScissorsView(discord.ui.View):
@@ -98,10 +103,7 @@ class Fun(commands.Cog, name="fun"):
     def __init__(self, bot):
         self.bot = bot
 
-    @commands.hybrid_command(
-        name="randomfact",
-        description="Get a random fact."
-    )
+    @commands.hybrid_command(name="randomfact", description="Get a random fact.")
     @checks.not_blacklisted()
     async def randomfact(self, context: Context) -> None:
         """
@@ -111,24 +113,22 @@ async def randomfact(self, context: Context) -> None:
         """
         # This will prevent your bot from stopping everything when doing a web request - see: https://discordpy.readthedocs.io/en/stable/faq.html#how-do-i-make-a-web-request
         async with aiohttp.ClientSession() as session:
-            async with session.get("https://uselessfacts.jsph.pl/random.json?language=en") as request:
+            async with session.get(
+                "https://uselessfacts.jsph.pl/random.json?language=en"
+            ) as request:
                 if request.status == 200:
                     data = await request.json()
-                    embed = discord.Embed(
-                        description=data["text"],
-                        color=0xD75BF4
-                    )
+                    embed = discord.Embed(description=data["text"], color=0xD75BF4)
                 else:
                     embed = discord.Embed(
                         title="Error!",
                         description="There is something wrong with the API, please try again later",
-                        color=0xE02B2B
+                        color=0xE02B2B,
                     )
                 await context.send(embed=embed)
 
     @commands.hybrid_command(
-        name="coinflip",
-        description="Make a coin flip, but give your bet before."
+        name="coinflip", description="Make a coin flip, but give your bet before."
     )
     @checks.not_blacklisted()
     async def coinflip(self, context: Context) -> None:
@@ -138,28 +138,24 @@ async def coinflip(self, context: Context) -> None:
         :param context: The hybrid command context.
         """
         buttons = Choice()
-        embed = discord.Embed(
-            description="What is your bet?",
-            color=0x9C84EF
-        )
+        embed = discord.Embed(description="What is your bet?", color=0x9C84EF)
         message = await context.send(embed=embed, view=buttons)
         await buttons.wait()  # We wait for the user to click a button.
         result = random.choice(["heads", "tails"])
         if buttons.value == result:
             embed = discord.Embed(
                 description=f"Correct! You guessed `{buttons.value}` and I flipped the coin to `{result}`.",
-                color=0x9C84EF
+                color=0x9C84EF,
             )
         else:
             embed = discord.Embed(
                 description=f"Woops! You guessed `{buttons.value}` and I flipped the coin to `{result}`, better luck next time!",
-                color=0xE02B2B
+                color=0xE02B2B,
             )
         await message.edit(embed=embed, view=None, content=None)
 
     @commands.hybrid_command(
-        name="rps",
-        description="Play the rock paper scissors game against the bot."
+        name="rps", description="Play the rock paper scissors game against the bot."
     )
     @checks.not_blacklisted()
     async def rock_paper_scissors(self, context: Context) -> None: