Template v3.1

* Added a `@checks.is_owner` check which raises a `UserNotOwner` exception
* Added a `@checks.not_blacklisted` check which raises a `UserBlacklisted` exception
* Using checks instead of same code for every command
* Various code cleanup

Author: Krypton

README.md

@@ -46,15 +46,15 @@ the `guild_ids` parameter in the command decorator so that it gets registered in
 @cog_ext.cog_slash(
     name="command",
     description="Command description",
-    guild_ids=[GUILD_ID1, GUILD_ID2] # These should be testing guild(s) ID, as always: an integer.
+    guild_ids=[GUILD_ID1, GUILD_ID2]  # These should be testing guild(s) ID, as always: an integer.
 )
 ```
 
 When using the template you confirm that you have read the [license](LICENSE.md) and comprehend that I can take down
 your repository if you do not meet these requirements.
 
 Please do not open issues or pull requests about things that are written in the [TODO file](TODO.md), they are **
-already** under work for the version 3.0 of the template.
+already** under work for a future version of the template.
 
 ## How to download it
 
@@ -70,7 +70,9 @@ Alternatively you can do the following:
 * Get your bot token
 * Invite your bot on servers using the following invite:
   https://discord.com/oauth2/authorize?&client_id=YOUR_APPLICATION_ID_HERE&scope=bot+applications.commands&permissions=PERMISSIONS (
-  Replace `YOUR_APPLICATION_ID_HERE` with the application ID and replace `PERMISSIONS` with the required permissions your bot needs that it can be get at the bottom of a this page https://discord.com/developers/applications/YOUR_APPLICATION_ID_HERE/bot)
+  Replace `YOUR_APPLICATION_ID_HERE` with the application ID and replace `PERMISSIONS` with the required permissions
+  your bot needs that it can be get at the bottom of a this
+  page https://discord.com/developers/applications/YOUR_APPLICATION_ID_HERE/bot)
 
 ## How to set up
 
@@ -81,7 +83,6 @@ Here is an explanation of what everything is:
 
 | Variable                  | What it is                                                            |
 | ------------------------- | ----------------------------------------------------------------------|
-| YOUR_BOT_PREFIX_HERE      | The prefix(es) of your bot                                            |
 | YOUR_BOT_TOKEN_HERE       | The token of your bot                                                 |
 | YOUR_APPLICATION_ID_HERE  | The application ID of your bot                                        |
 | OWNERS                    | The user ID of all the bot owners                                     |
@@ -136,7 +137,7 @@ the [tags on this repository](https://github.com/kkrypt0nn/Python-Discord-Bot-Te
 
 ## Built With
 
-* [Python 3.8](https://www.python.org/)
+* [Python 3.9](https://www.python.org/)
 
 ## License
 

UPDATES.md

@@ -2,6 +2,13 @@
 
 Here is the list of all the updates that I made on this template.
 
+### Version 3.1
+
+* Added a `@checks.is_owner` check which raises a `UserNotOwner` exception
+* Added a `@checks.not_blacklisted` check which raises a `UserBlacklisted` exception
+* Using checks instead of same code for every command
+* Various code cleanup
+
 ### Version 3.0
 
 **Now using slash commands**

bot.py

@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 3.0
+Version: 3.1
 """
 
 import json
@@ -17,6 +17,8 @@
 from discord.ext.commands import Bot
 from discord_slash import SlashCommand, SlashContext
 
+import exceptions
+
 if not os.path.isfile("config.json"):
     sys.exit("'config.json' not found! Please add it and try again.")
 else:
@@ -55,7 +57,7 @@
 
 intents = discord.Intents.default()
 
-bot = Bot(command_prefix=config["bot_prefix"], intents=intents)
+bot = Bot(command_prefix=None, intents=intents)  # The command prefix is a required argument, but will never be used
 slash = SlashCommand(bot, sync_commands=True)
 
 
@@ -73,7 +75,7 @@ async def on_ready():
 # Setup the game status task of the bot
 @tasks.loop(minutes=1.0)
 async def status_task():
-    statuses = ["with you!", "with Krypton!", f"{config['bot_prefix']}help", "with humans!"]
+    statuses = ["with you!", "with Krypton!", "with humans!"]
     await bot.change_presence(activity=discord.Game(random.choice(statuses)))
 
 
@@ -94,7 +96,7 @@ async def status_task():
 
 # The code in this event is executed every time someone sends a message, with or without the prefix
 @bot.event
-async def on_message(message):
+async def on_message(message: discord.Message):
     # Ignores if a command is being executed by a bot or by the bot itself
     if message.author == bot.user or message.author.bot:
         return
@@ -104,16 +106,25 @@ async def on_message(message):
 # The code in this event is executed every time a command has been *successfully* executed
 @bot.event
 async def on_slash_command(ctx: SlashContext):
-    fullCommandName = ctx.name
-    split = fullCommandName.split(" ")
-    executedCommand = str(split[0])
+    full_command_name = ctx.name
+    split = full_command_name.split(" ")
+    executed_command = str(split[0])
     print(
-        f"Executed {executedCommand} command in {ctx.guild.name} (ID: {ctx.guild.id}) by {ctx.author} (ID: {ctx.author.id})")
+        f"Executed {executed_command} command in {ctx.guild.name} (ID: {ctx.guild.id}) by {ctx.author} (ID: {ctx.author.id})")
 
 
 # The code in this event is executed every time a valid commands catches an error
 @bot.event
-async def on_command_error(context, error):
+async def on_slash_command_error(context: SlashContext, error: Exception):
+    if isinstance(error, exceptions.UserBlacklisted):
+        """
+        The code here will only execute if the error is an instance of 'UserBlacklisted', which can occur when using
+        the @checks.is_owner() check in your command, or you can raise the error by yourself.
+        
+        'hidden=True' will make so that only the user who execute the command can see the message
+        """
+        print("A blacklisted user tried to execute a command.")
+        return await context.send("You are blacklisted from using the bot.", hidden=True)
     raise error
 
 

cogs/fun.py

@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 3.0
+Version: 3.1
 """
 
 import json
@@ -15,6 +15,8 @@
 from discord.ext import commands
 from discord_slash import cog_ext, SlashContext
 
+from helpers import checks
+
 if not os.path.isfile("config.json"):
     sys.exit("'config.json' not found! Please add it and try again.")
 else:
@@ -30,6 +32,7 @@ def __init__(self, bot):
         name="randomfact",
         description="Get a random fact."
     )
+    @checks.not_blacklisted()
     async def randomfact(self, context: SlashContext):
         """
         Get a random fact.

cogs/general.py

@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 3.0
+Version: 3.1
 """
 
 import json
@@ -18,34 +18,30 @@
 from discord_slash import cog_ext, SlashContext
 from discord_slash.utils.manage_commands import create_option
 
+from helpers import checks
+
 if not os.path.isfile("config.json"):
     sys.exit("'config.json' not found! Please add it and try again.")
 else:
     with open("config.json") as file:
         config = json.load(file)
 
 
-class general(commands.Cog, name="general"):
+class General(commands.Cog, name="general"):
     def __init__(self, bot):
         self.bot = bot
 
     @cog_ext.cog_slash(
         name="botinfo",
         description="Get some useful (or not) information about the bot.",
     )
+    @checks.not_blacklisted()
     async def botinfo(self, context: SlashContext):
         """
         Get some useful (or not) information about the bot.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         embed = discord.Embed(
-            description="Used Krypton's template",
+            description="Used [Krypton's](https://krypt0n.co.uk) template",
             color=0x42F56C
         )
         embed.set_author(
@@ -63,7 +59,7 @@ async def botinfo(self, context: SlashContext):
         )
         embed.add_field(
             name="Prefix:",
-            value=f"{config['bot_prefix']}",
+            value=f"/ (Slash Commands)",
             inline=False
         )
         embed.set_footer(
@@ -75,17 +71,11 @@ async def botinfo(self, context: SlashContext):
         name="serverinfo",
         description="Get some useful (or not) information about the server.",
     )
+    @checks.not_blacklisted()
     async def serverinfo(self, context: SlashContext):
         """
         Get some useful (or not) information about the server.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         server = context.guild
         roles = [x.name for x in server.roles]
         role_length = len(roles)
@@ -130,18 +120,13 @@ async def serverinfo(self, context: SlashContext):
     @cog_ext.cog_slash(
         name="ping",
         description="Check if the bot is alive.",
+        guild_ids=[909709618681364531]
     )
+    @checks.not_blacklisted()
     async def ping(self, context: SlashContext):
         """
         Check if the bot is alive.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         embed = discord.Embed(
             title="🏓 Pong!",
             description=f"The bot latency is {round(self.bot.latency * 1000)}ms.",
@@ -153,17 +138,11 @@ async def ping(self, context: SlashContext):
         name="invite",
         description="Get the invite link of the bot to be able to invite it.",
     )
+    @checks.not_blacklisted()
     async def invite(self, context: SlashContext):
         """
         Get the invite link of the bot to be able to invite it.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         embed = discord.Embed(
             description=f"Invite me by clicking [here](https://discordapp.com/oauth2/authorize?&client_id={config['application_id']}&scope=bot&permissions=470150263).",
             color=0xD75BF4
@@ -179,17 +158,11 @@ async def invite(self, context: SlashContext):
         name="server",
         description="Get the invite link of the discord server of the bot for some support.",
     )
+    @checks.not_blacklisted()
     async def server(self, context: SlashContext):
         """
         Get the invite link of the discord server of the bot for some support.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         embed = discord.Embed(
             description=f"Join the support server for the bot by clicking [here](https://discord.gg/mTBrXyWxAF).",
             color=0xD75BF4
@@ -212,17 +185,11 @@ async def server(self, context: SlashContext):
             )
         ],
     )
+    @checks.not_blacklisted()
     async def poll(self, context: SlashContext, title: str):
         """
         Create a poll where members can vote.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         embed = discord.Embed(
             title="A new poll has been created!",
             description=f"{title}",
@@ -248,17 +215,11 @@ async def poll(self, context: SlashContext, title: str):
             )
         ],
     )
+    @checks.not_blacklisted()
     async def eight_ball(self, context: SlashContext, question: str):
         """
         Ask any question to the bot.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         answers = ['It is certain.', 'It is decidedly so.', 'You may rely on it.', 'Without a doubt.',
                    'Yes - definitely.', 'As I see, yes.', 'Most likely.', 'Outlook good.', 'Yes.',
                    'Signs point to yes.', 'Reply hazy, try again.', 'Ask again later.', 'Better not tell you now.',
@@ -278,17 +239,11 @@ async def eight_ball(self, context: SlashContext, question: str):
         name="bitcoin",
         description="Get the current price of bitcoin.",
     )
+    @checks.not_blacklisted()
     async def bitcoin(self, context):
         """
         Get the current price of bitcoin.
         """
-
-        # This is, for now, only temporary
-        with open("blacklist.json") as file:
-            blacklist = json.load(file)
-        if context.author.id in blacklist["ids"]:
-            return
-
         url = "https://api.coindesk.com/v1/bpi/currentprice/BTC.json"
         # Async HTTP request
         async with aiohttp.ClientSession() as session:
@@ -304,4 +259,4 @@ async def bitcoin(self, context):
 
 
 def setup(bot):
-    bot.add_cog(general(bot))
+    bot.add_cog(General(bot))