Merge branch 'slash' of https://github.com/Pycord-Development/pycord into slash

Author: BobDotCom

examples/app_commands/context_menus.py

@@ -2,13 +2,16 @@
 
 bot = discord.Bot()
 
+
 @bot.user_command(guild_ids=[...])  # create a user command for the supplied guilds
-async def mention(ctx, member: discord.Member): # user commands return the member
+async def mention(ctx, member: discord.Member):  # user commands return the member
     await ctx.respond(f"{ctx.author.name} just mentioned {member.mention}!")
 
+
 # user commands and message commands can have spaces in their names
-@bot.message_command(name='Show ID')  # creates a global message command
-async def show_id(ctx, message: discord.Message): # message commands return the message
+@bot.message_command(name="Show ID")  # creates a global message command
+async def show_id(ctx, message: discord.Message):  # message commands return the message
     await ctx.respond(f"{ctx.author.name}, here's the message id: {message.id}!")
 
+
 bot.run("TOKEN")

examples/app_commands/slash_basic.py

@@ -1,23 +1,31 @@
 import discord
 
-bot = discord.Bot() 
+bot = discord.Bot()
 
-# If you use commands.Bot, @bot.slash_command should be used for 
+# If you use commands.Bot, @bot.slash_command should be used for
 # slash commands. You can use @bot.slash_command with discord.Bot aswell
 
 
 @bot.command(guild_ids=[...])  # create a slash command for the supplied guilds
 async def hello(ctx):
-    """Say hello to the bot""" # the command description can be supplied as the docstring
+    """Say hello to the bot"""  # the command description can be supplied as the docstring
     await ctx.send(f"Hello {ctx.author}!")
 
-@bot.command(name='hi')  # Not passing in guild_ids creates a global slash command (might take an hour to register)
-async def global_command(ctx, num: int): # Takes one integer parameter 
+
+@bot.command(
+    name="hi"
+)  # Not passing in guild_ids creates a global slash command (might take an hour to register)
+async def global_command(ctx, num: int):  # Takes one integer parameter
     await ctx.send(f"This is a global command, {num}!")
 
+
 @bot.command(guild_ids=[...])
-async def joined(ctx, member: discord.Member = None): # Passing a default value makes the argument optional
-    user = member or ctx.author 
-    await ctx.send(f'{user.name} joined at {discord.utils.format_dt(user.joined_at)}')
+async def joined(
+    ctx, member: discord.Member = None
+):  # Passing a default value makes the argument optional
+    user = member or ctx.author
+    await ctx.send(f"{user.name} joined at {discord.utils.format_dt(user.joined_at)}")
+
 
+# To learn how to add descriptions, choices to options check slash_options.py
 bot.run("TOKEN")

examples/app_commands/slash_options.py

@@ -0,0 +1,17 @@
+import discord
+from discord.app import Option
+
+bot = discord.Bot()
+
+# If you use commands.Bot, @bot.slash_command should be used for
+# slash commands. You can use @bot.slash_command with discord.Bot aswell
+
+
+@bot.command(guild_ids=[...])
+async def hello(
+    ctx,
+    name: Option(str, "Enter your name"),
+    gender: Option(str, "Choose your gender", choices=["Male", "Female", "Other"]),
+    age: Option(int, "Enter your age", required=False, default=18),
+):
+    await ctx.send(f"Hello {name}")

examples/background_task.py

@@ -2,6 +2,7 @@
 
 import discord
 
+
 class MyClient(discord.Client):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -13,18 +14,19 @@ def __init__(self, *args, **kwargs):
         self.my_background_task.start()
 
     async def on_ready(self):
-        print(f'Logged in as {self.user} (ID: {self.user.id})')
-        print('------')
+        print(f"Logged in as {self.user} (ID: {self.user.id})")
+        print("------")
 
-    @tasks.loop(seconds=60) # task runs every 60 seconds
+    @tasks.loop(seconds=60)  # task runs every 60 seconds
     async def my_background_task(self):
-        channel = self.get_channel(1234567) # channel ID goes here
+        channel = self.get_channel(1234567)  # channel ID goes here
         self.counter += 1
         await channel.send(self.counter)
 
     @my_background_task.before_loop
     async def before_my_task(self):
-        await self.wait_until_ready() # wait until the bot logs in
+        await self.wait_until_ready()  # wait until the bot logs in
+
 
 client = MyClient()
-client.run('token')
+client.run("token")

examples/background_task_asyncio.py

@@ -1,6 +1,7 @@
 import discord
 import asyncio
 
+
 class MyClient(discord.Client):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -9,18 +10,18 @@ def __init__(self, *args, **kwargs):
         self.bg_task = self.loop.create_task(self.my_background_task())
 
     async def on_ready(self):
-        print(f'Logged in as {self.user} (ID: {self.user.id})')
-        print('------')
+        print(f"Logged in as {self.user} (ID: {self.user.id})")
+        print("------")
 
     async def my_background_task(self):
         await self.wait_until_ready()
         counter = 0
-        channel = self.get_channel(1234567) # channel ID goes here
+        channel = self.get_channel(1234567)  # channel ID goes here
         while not self.is_closed():
             counter += 1
             await channel.send(counter)
-            await asyncio.sleep(60) # task runs every 60 seconds
+            await asyncio.sleep(60)  # task runs every 60 seconds
 
 
 client = MyClient()
-client.run('token')
+client.run("token")

examples/basic_bot.py

@@ -4,53 +4,60 @@
 from discord.ext import commands
 import random
 
-description = '''An example bot to showcase the discord.ext.commands extension
+description = """An example bot to showcase the discord.ext.commands extension
 module.
 
-There are a number of utility commands being showcased here.'''
+There are a number of utility commands being showcased here."""
 
 intents = discord.Intents.default()
 intents.members = True
 
-bot = commands.Bot(command_prefix='?', description=description, intents=intents)
+bot = commands.Bot(command_prefix="?", description=description, intents=intents)
+
 
 @bot.event
 async def on_ready():
-    print(f'Logged in as {bot.user} (ID: {bot.user.id})')
-    print('------')
+    print(f"Logged in as {bot.user} (ID: {bot.user.id})")
+    print("------")
+
 
 @bot.command()
 async def add(ctx, left: int, right: int):
     """Adds two numbers together."""
     await ctx.send(left + right)
 
+
 @bot.command()
 async def roll(ctx, dice: str):
     """Rolls a dice in NdN format."""
     try:
-        rolls, limit = map(int, dice.split('d'))
+        rolls, limit = map(int, dice.split("d"))
     except Exception:
-        await ctx.send('Format has to be in NdN!')
+        await ctx.send("Format has to be in NdN!")
         return
 
-    result = ', '.join(str(random.randint(1, limit)) for r in range(rolls))
+    result = ", ".join(str(random.randint(1, limit)) for r in range(rolls))
     await ctx.send(result)
 
-@bot.command(description='For when you wanna settle the score some other way')
+
+@bot.command(description="For when you wanna settle the score some other way")
 async def choose(ctx, *choices: str):
     """Chooses between multiple choices."""
     await ctx.send(random.choice(choices))
 
+
 @bot.command()
-async def repeat(ctx, times: int, content='repeating...'):
+async def repeat(ctx, times: int, content="repeating..."):
     """Repeats a message multiple times."""
     for i in range(times):
         await ctx.send(content)
 
+
 @bot.command()
 async def joined(ctx, member: discord.Member):
     """Says when a member joined."""
-    await ctx.send(f'{member.name} joined in {member.joined_at}')
+    await ctx.send(f"{member.name} joined in {member.joined_at}")
+
 
 @bot.group()
 async def cool(ctx):
@@ -59,11 +66,13 @@ async def cool(ctx):
     In reality this just checks if a subcommand is being invoked.
     """
     if ctx.invoked_subcommand is None:
-        await ctx.send(f'No, {ctx.subcommand_passed} is not cool')
+        await ctx.send(f"No, {ctx.subcommand_passed} is not cool")
 
-@cool.command(name='bot')
+
+@cool.command(name="bot")
 async def _bot(ctx):
     """Is the bot cool?"""
-    await ctx.send('Yes, the bot is cool.')
+    await ctx.send("Yes, the bot is cool.")
+
 
-bot.run('token')
+bot.run("token")

examples/basic_voice.py

@@ -6,26 +6,24 @@
 from discord.ext import commands
 
 # Suppress noise about console usage from errors
-youtube_dl.utils.bug_reports_message = lambda: ''
+youtube_dl.utils.bug_reports_message = lambda: ""
 
 
 ytdl_format_options = {
-    'format': 'bestaudio/best',
-    'outtmpl': '%(extractor)s-%(id)s-%(title)s.%(ext)s',
-    'restrictfilenames': True,
-    'noplaylist': True,
-    'nocheckcertificate': True,
-    'ignoreerrors': False,
-    'logtostderr': False,
-    'quiet': True,
-    'no_warnings': True,
-    'default_search': 'auto',
-    'source_address': '0.0.0.0' # bind to ipv4 since ipv6 addresses cause issues sometimes
+    "format": "bestaudio/best",
+    "outtmpl": "%(extractor)s-%(id)s-%(title)s.%(ext)s",
+    "restrictfilenames": True,
+    "noplaylist": True,
+    "nocheckcertificate": True,
+    "ignoreerrors": False,
+    "logtostderr": False,
+    "quiet": True,
+    "no_warnings": True,
+    "default_search": "auto",
+    "source_address": "0.0.0.0",  # bind to ipv4 since ipv6 addresses cause issues sometimes
 }
 
-ffmpeg_options = {
-    'options': '-vn'
-}
+ffmpeg_options = {"options": "-vn"}
 
 ytdl = youtube_dl.YoutubeDL(ytdl_format_options)
 
@@ -36,19 +34,21 @@ def __init__(self, source, *, data, volume=0.5):
 
         self.data = data
 
-        self.title = data.get('title')
-        self.url = data.get('url')
+        self.title = data.get("title")
+        self.url = data.get("url")
 
     @classmethod
     async def from_url(cls, url, *, loop=None, stream=False):
         loop = loop or asyncio.get_event_loop()
-        data = await loop.run_in_executor(None, lambda: ytdl.extract_info(url, download=not stream))
+        data = await loop.run_in_executor(
+            None, lambda: ytdl.extract_info(url, download=not stream)
+        )
 
-        if 'entries' in data:
+        if "entries" in data:
             # take first item from a playlist
-            data = data['entries'][0]
+            data = data["entries"][0]
 
-        filename = data['url'] if stream else ytdl.prepare_filename(data)
+        filename = data["url"] if stream else ytdl.prepare_filename(data)
         return cls(discord.FFmpegPCMAudio(filename, **ffmpeg_options), data=data)
 
 
@@ -70,29 +70,35 @@ async def play(self, ctx, *, query):
         """Plays a file from the local filesystem"""
 
         source = discord.PCMVolumeTransformer(discord.FFmpegPCMAudio(query))
-        ctx.voice_client.play(source, after=lambda e: print(f'Player error: {e}') if e else None)
+        ctx.voice_client.play(
+            source, after=lambda e: print(f"Player error: {e}") if e else None
+        )
 
-        await ctx.send(f'Now playing: {query}')
+        await ctx.send(f"Now playing: {query}")
 
     @commands.command()
     async def yt(self, ctx, *, url):
         """Plays from a url (almost anything youtube_dl supports)"""
 
         async with ctx.typing():
             player = await YTDLSource.from_url(url, loop=self.bot.loop)
-            ctx.voice_client.play(player, after=lambda e: print(f'Player error: {e}') if e else None)
+            ctx.voice_client.play(
+                player, after=lambda e: print(f"Player error: {e}") if e else None
+            )
 
-        await ctx.send(f'Now playing: {player.title}')
+        await ctx.send(f"Now playing: {player.title}")
 
     @commands.command()
     async def stream(self, ctx, *, url):
         """Streams from a url (same as yt, but doesn't predownload)"""
 
         async with ctx.typing():
             player = await YTDLSource.from_url(url, loop=self.bot.loop, stream=True)
-            ctx.voice_client.play(player, after=lambda e: print(f'Player error: {e}') if e else None)
+            ctx.voice_client.play(
+                player, after=lambda e: print(f"Player error: {e}") if e else None
+            )
 
-        await ctx.send(f'Now playing: {player.title}')
+        await ctx.send(f"Now playing: {player.title}")
 
     @commands.command()
     async def volume(self, ctx, volume: int):
@@ -123,13 +129,18 @@ async def ensure_voice(self, ctx):
         elif ctx.voice_client.is_playing():
             ctx.voice_client.stop()
 
-bot = commands.Bot(command_prefix=commands.when_mentioned_or("!"),
-                   description='Relatively simple music bot example')
+
+bot = commands.Bot(
+    command_prefix=commands.when_mentioned_or("!"),
+    description="Relatively simple music bot example",
+)
+
 
 @bot.event
 async def on_ready():
-    print(f'Logged in as {bot.user} (ID: {bot.user.id})')
-    print('------')
+    print(f"Logged in as {bot.user} (ID: {bot.user.id})")
+    print("------")
+
 
 bot.add_cog(Music(bot))
-bot.run('token')
+bot.run("token")