Format application command examples

Author: Dorukyum

examples/app_commands/slash_autocomplete.py

@@ -1,5 +1,6 @@
 import discord
-from discord.commands import slash_command, Option
+from discord.commands import Option, slash_command
+
 bot = discord.Bot()
 
 COLORS = ["red", "orange", "yellow", "green", "blue", "indigo", "violet"]
@@ -85,15 +86,19 @@
     "yellowgreen",
 ]
 
-BASIC_ALLOWED = [...]  # this would normally be a list of discord user IDs for the purpose of this example
+BASIC_ALLOWED = [
+    ...
+]  # this would normally be a list of discord user IDs for the purpose of this example
 
 
 async def color_searcher(ctx: discord.AutocompleteContext):
     """Returns a list of matching colors from the LOTS_OF_COLORS list
     In this example, we've added logic to only display any results in the returned list if the user's ID exists in the BASIC_ALLOWED list.
     This is to demonstrate passing a callback in the discord.utils.basic_autocomplete function.
     """
-    return [color for color in LOTS_OF_COLORS if ctx.interaction.user.id in BASIC_ALLOWED]
+    return [
+        color for color in LOTS_OF_COLORS if ctx.interaction.user.id in BASIC_ALLOWED
+    ]
 
 
 async def get_colors(ctx: discord.AutocompleteContext):
@@ -115,7 +120,9 @@ async def get_animals(ctx: discord.AutocompleteContext):
     elif picked_color == "blue":
         return ["blue jay", "blue whale"]
     elif picked_color == "indigo":
-        return ["eastern indigo snake"]  # needs to return an iterable even if only one item
+        return [
+            "eastern indigo snake"
+        ]  # needs to return an iterable even if only one item
     elif picked_color == "violet":
         return ["purple emperor butterfly", "orchid dottyback"]
     else:
@@ -129,14 +136,26 @@ async def autocomplete_example(
     animal: Option(str, "Pick an animal!", autocomplete=get_animals),
 ):
     """This demonstrates using the ctx.options parameter to to create slash command options that are dependent on the values entered for other options."""
-    await ctx.respond(f"You picked {color} for the color, which allowed you to choose {animal} for the animal.")
+    await ctx.respond(
+        f"You picked {color} for the color, which allowed you to choose {animal} for the animal."
+    )
 
 
 @bot.slash_command(name="ac_basic_example")
 async def autocomplete_basic_example(
     ctx: discord.ApplicationContext,
-    color: Option(str, "Pick a color from this big list", autocomplete=discord.utils.basic_autocomplete(color_searcher)),  # Demonstrates passing a callback to discord.utils.basic_autocomplete
-    animal: Option(str, "Pick an animal from this small list", autocomplete=discord.utils.basic_autocomplete(["snail", "python", "cricket", "orca"])),  # Demonstrates passing a static iterable discord.utils.basic_autocomplete
+    color: Option(
+        str,
+        "Pick a color from this big list",
+        autocomplete=discord.utils.basic_autocomplete(color_searcher),
+    ),  # Demonstrates passing a callback to discord.utils.basic_autocomplete
+    animal: Option(
+        str,
+        "Pick an animal from this small list",
+        autocomplete=discord.utils.basic_autocomplete(
+            ["snail", "python", "cricket", "orca"]
+        ),
+    ),  # Demonstrates passing a static iterable discord.utils.basic_autocomplete
 ):
     """This demonstrates using the discord.utils.basic_autocomplete helper function.
     For the `color` option, a callback is passed, where additional logic can be added to determine which values are returned.
@@ -145,4 +164,5 @@ async def autocomplete_basic_example(
     Note that the basic_autocomplete function itself will still only return a maximum of 25 items."""
     await ctx.respond(f"You picked {color} as your color, and {animal} as your animal!")
 
+
 bot.run("TOKEN")

examples/app_commands/slash_basic.py

@@ -6,7 +6,7 @@
 # Note: If you want you can use commands.Bot instead of discord.Bot
 # Use discord.Bot if you don't want prefixed message commands
 
-# With discord.Bot you can use @bot.command as an alias 
+# With discord.Bot you can use @bot.command as an alias
 # of @bot.slash_command but this is overridden by commands.Bot
 
 
@@ -28,7 +28,9 @@ async def joined(
     ctx, member: discord.Member = None
 ):  # Passing a default value makes the argument optional
     user = member or ctx.author
-    await ctx.respond(f"{user.name} joined at {discord.utils.format_dt(user.joined_at)}")
+    await ctx.respond(
+        f"{user.name} joined at {discord.utils.format_dt(user.joined_at)}"
+    )
 
 
 # To learn how to add descriptions and choices to options, check slash_options.py

examples/app_commands/slash_cog.py

@@ -1,18 +1,19 @@
+from discord.commands import slash_command  # Importing the decorator that makes slash commands.
 from discord.ext import commands
-from discord.commands import slash_command # Importing the decorator that makes slash commands.
+
 
 class Example(commands.Cog):
     def __init__(self, bot):
         self.bot = bot
- 
-    @slash_command(guild_ids=[...]) # Create a slash command for the supplied guilds.
+
+    @slash_command(guild_ids=[...])  # Create a slash command for the supplied guilds.
     async def hello(self, ctx):
         await ctx.respond("Hi, this is a slash command from a cog!")
-    
 
-    @slash_command() # Not passing in guild_ids creates a global slash command (might take an hour to register).
+    @slash_command()  # Not passing in guild_ids creates a global slash command (might take an hour to register).
     async def hi(self, ctx):
         await ctx.respond("Hi, this is a global slash command from a cog!")
 
+
 def setup(bot):
     bot.add_cog(Example(bot))

examples/app_commands/slash_options.py

@@ -16,4 +16,5 @@ async def hello(
 ):
     await ctx.respond(f"Hello {name}")
 
-bot.run('TOKEN')
+
+bot.run("TOKEN")

examples/app_commands/slash_perms.py

@@ -1,5 +1,4 @@
 import discord
-
 # Imports permissions from discord.commands
 from discord.commands import permissions
 
@@ -8,7 +7,7 @@
 # Note: If you want you can use commands.Bot instead of discord.Bot
 # Use discord.Bot if you don't want prefixed message commands
 
-# With discord.Bot you can use @bot.command as an alias 
+# With discord.Bot you can use @bot.command as an alias
 # of @bot.slash_command but this is overridden by commands.Bot
 
 # by default, default_permission is set to True, you can use
@@ -31,45 +30,60 @@
 # Note: Please replace token, GUILD_ID, USER_ID and ROLE_NAME.
 
 # Guild Slash Command Example with User Permissions
+
+GUILD_ID = ...
+USER_ID = ...
+
+
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.is_user(USER_ID)
 async def user(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Owner Permissions
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.is_owner()
 async def owner(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Role Permissions
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.has_role("ROLE_NAME")
 async def role(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Any Specified Role Permissions
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.has_any_role("ROLE_NAME", "ROLE_NAME2")
 async def multirole(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Permission Decorator
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.permission(user_id=USER_ID, permission=True)
 async def permission_decorator(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Permissions Kwarg
-@bot.slash_command(guild_ids=[GUILD_ID], default_permission=False, permissions=[permissions.Permission(id=USER_ID, type=2, permission=True)])
+@bot.slash_command(
+    guild_ids=[GUILD_ID],
+    default_permission=False,
+    permissions=[permissions.Permission(id=USER_ID, type=2, permission=True)],
+)
 async def permission_kwarg(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # To learn how to add descriptions, choices to options check slash_options.py
 bot.run("token")