Merge branch 'discord-py-slash-commands:master' into master

FayeDel · web-flow · commit 5f98d04bddd3 · 2021-07-13T16:31:10.000-04:00
diff --git a/.github/banner_transparent.png b/.github/banner_transparent.png
diff --git a/README.md b/README.md
@@ -1,68 +1,89 @@
+<div align="center">
+    <a href="https://pypi.org/project/discord-py-slash-command/">
+        <img src="https://raw.githubusercontent.com/discord-py-slash-commands/discord-py-interactions/goverfl0w-new-readme/.github/banner_transparent.png" alt="discord-py-interactions" height="128">
+    </a>
+    <h2>Your ultimate discord interactions library for <a href="https://github.com/Rapptz/discord.py">discord.py</a>.</h2>
+</div>
+
+<div align="center">
+        <a href="https://app.codacy.com/gh/eunwoo1104/discord-py-slash-command?utm_source=github.com&utm_medium=referral&utm_content=eunwoo1104/discord-py-slash-command&utm_campaign=Badge_Grade_Settings">
+            <img src="https://api.codacy.com/project/badge/Grade/224bdbe58f8f43f28a093a33a7546456" alt="Codacy Badge">
+        </a>
+        <a href="https://discord.gg/KkgMBVuEkx">
+            <img alt="Discord" src="https://img.shields.io/discord/789032594456576001">
+        </a>
+</div>
+
 <p align="center">
-    <br>
-    <a href="https://pypi.org/project/discord-py-slash-command/"><img src="https://raw.githubusercontent.com/eunwoo1104/discord-py-slash-command/master/.github/discordpyslashlogo.png" alt="discord-py-slash-command" height="128"></a>
-    <h2 align = "center">A simple discord slash command handler for <a href="https://github.com/Rapptz/discord.py">discord.py</a></h2>
-</p>
-<p align="center">
-        <a href="https://app.codacy.com/gh/eunwoo1104/discord-py-slash-command?utm_source=github.com&utm_medium=referral&utm_content=eunwoo1104/discord-py-slash-command&utm_campaign=Badge_Grade_Settings"><img src="https://api.codacy.com/project/badge/Grade/224bdbe58f8f43f28a093a33a7546456" alt="Codacy Badge"></a>
-        <a href="https://discord.gg/KkgMBVuEkx"> <img alt="Discord" src="https://img.shields.io/discord/789032594456576001"></a>
-</p>
-<p align="center">
-   <a href="#about">About</a> ⦿
-   <a href="#installation">Installation</a> ⦿
-   <a href="#examples">Examples</a> ⦿
-   <a href="https://discord-py-slash-command.readthedocs.io/en/latest/">Documentation</a> ⦿
-   <a href="https://discord.gg/KkgMBVuEkx">Discord Server</a>
+    <a href="#about">About</a> |
+    <a href="#installation">Installation</a> |
+    <a href="#examples">Examples</a> |
+    <a href="https://discord.gg/KkgMBVuEkx">Discord</a> |
+    <a href="https://pypi.org/project/discord-py-slash-command/">PyPI</a>
 </p>
 
-## About
-Discord Slash Commands are a new implementation for the Bot API that utilize the forward-slash "/" symbol.
-Released on 15 December 2020, many bot developers are still learning to learn how to implement this into
-their very own bots. This command handler aims to help serve as a guidance for those looking into wanting to add
-these new slash commands into their bots for those that use discord.py, building off of the current library
-code and substituting its own for where it's needed. *discord-py-slash-command* stands as the first public
-slash command handler library to be made for Discord Bot API libraries.
+# About
+## What is discord-interactions?
+discord-interactions is, in the simplest terms, a library extension that builds off of the currently existing
+discord.py API wrapper. While we do use our own basic class code for our own library, a large majority of
+this library uses discord.py base events in order to make contextualization of interactions relatively easy
+for us.
+
+### When did this begin?
+In mid-December of 2020, Discord released the very first type of components, **slash commands.** These were
+relatively primitive at the time of their debut, however, over time they slowly came to grew more complex
+and mutable. This library was created 2 days after the release of slash commands to Discord, and ever since
+has been actively growing.
+
+## What do we currently support?
+At this time, we are able to provide you an non-exhaustive list, however, incomplete (because Discord are actively
+creating more interactions at this time) of all components integrated as interactions:
+
+* Slash Commands
+* Buttons
+* Selects (also known as *dropdowns* or *menus*)
 
-## Installation
-You are able to easily install the *discord-py-slash-command* library by using the given PIP line below:
+# Installation
+## (Recommended)
+We recommend using pip in order to install our library. You are able to do this by typing the following line below:
 
 `pip install -U discord-py-slash-command`
 
-## Examples
-### Quick Startup
-This is a quick startup method towards using slash commands.
+# Examples
+## Slash Commands
+This example shows a very quick and simplistic solution to implementing a slash command.
+
 ```py
-import discord
-from discord.ext import commands
+from discord import Client, Intents, Embed
 from discord_slash import SlashCommand, SlashContext
 
-bot = commands.Bot(command_prefix="!", intents=discord.Intents.all())
+bot = Client(intents=Intents.default())
 slash = SlashCommand(bot)
 
 @slash.slash(name="test")
-async def _test(ctx: SlashContext):
-    embed = discord.Embed(title="embed test")
-    await ctx.send(content="test", embeds=[embed])
+async def test(ctx: SlashContext):
+    embed = Embed(title="Embed Test")
+    await ctx.send(embed=embed)
 
 bot.run("discord_token")
 ```
 
-### Advanced
-This offers implementation of the slash command library in the usage of a cog.
+### Cogs
+This example serves as an alternative method for using slash commands in a cog instead.
+
 ```py
 # bot.py
-from discord.ext import commands
-from discord_slash import SlashCommand
+from discord import Client, Intents, Embed
+from discord_slash import SlashCommand, SlashContext
 
-bot = commands.Bot(command_prefix="prefix")
-slash = SlashCommand(bot, sync_commands=True, sync_on_cog_reload=True)
+bot = Client(intents=Intents.default())
+slash = SlashCommand(bot)
 
 bot.load_extension("cog")
-bot.run("TOKEN")
+bot.run("discord_token")
 
 # cog.py
-import discord
-from discord.ext import commands
+from discord import Embed
 from discord_slash import cog_ext, SlashContext
 
 class Slash(commands.Cog):
@@ -71,17 +92,65 @@ class Slash(commands.Cog):
 
     @cog_ext.cog_slash(name="test")
     async def _test(self, ctx: SlashContext):
-        embed = discord.Embed(title="embed test")
-        await ctx.send(content="test", embeds=[embed])
-
+        embed = Embed(title="Embed Test")
+        await ctx.send(embed=embed)
+    
 def setup(bot):
     bot.add_cog(Slash(bot))
 ```
 
+## Buttons
+This basic example shows how to easily integrate buttons into your commands. Buttons are not limited to
+slash commands and may be used in regular discord.py commands as well.
+(This example refers off of [slash commands.](#slash-commands))
+
+```py
+from discord_slash.utils.manage_components import create_button, create_actionrow
+from discord_slash.model import ButtonStyle
+
+buttons = [
+    create_button(style=ButtonStyle.green, label="A green button"),
+    create_button(style=ButtonStyle.blue, label="A blue button")
+]
+action_row = create_actionrow(*buttons)
+
+await ctx.send(components=[action_row])
+```
+
+### Advanced
+For more advanced use, please refer to our official documentation on [buttons here.](https://discord-py-slash-command.readthedocs.io/en/latest/components.html#responding-to-interactions)
+
+## Selects
+This basic example shows how to add selects into our bot. Selects offer the same accessibility as buttons do
+in premise of limitations.
+(This exmaple refers off of [slash commands.](#slash-commands))
+
+```py
+from discord_slash.utils.manage_components import create_select, create_select_option, create_actionrow
+
+select = create_select(
+    options=[
+        create_select_option("Lab Coat", value="coat", emoji="🥼"),
+        create_select_option("Test Tube", value="tube", emoji="🧪"),
+        create_select_option("Petri Dish", value="dish", emoji="🧫")
+    ],
+    placeholder="Choose your option",
+    min_values=1, # the minimum number of options a user must select
+    max_values=2 # the maximum number of options a user can select
+)
+action_row = create_actionrow(select)
+
+await ctx.send(components=[action_row])
+```
+
+### Advanced
+For more advanced use, please refer to our official documentation on [selects here.](https://discord-py-slash-command.readthedocs.io/en/latest/components.html#what-about-selects-dropdowns)
+
 --------
-- This library is based on gateway event. If you are looking for webserver based, have a look at this:
+
+- The discord-interactions library is based off of API gateway events. If you are looking for a library webserver-based, please consider:
     - [dispike](https://github.com/ms7m/dispike)
     - [discord-interactions-python](https://github.com/discord/discord-interactions-python)
-- Or for other languages:
+- If you are looking for a similar library for other languages, please refer to here:
     - [discord-api-docs Community Resources: Interactions](https://discord.com/developers/docs/topics/community-resources#interactions)
 
diff --git a/discord_slash/const.py b/discord_slash/const.py
@@ -1,5 +1,5 @@
 """Discord Slash Constants"""
 
-__version__ = "2.2.0"
+__version__ = "2.3.2"
 
 BASE_API = "https://discord.com/api/v8"
diff --git a/discord_slash/context.py b/discord_slash/context.py
@@ -321,7 +321,10 @@ def __init__(
             )
             self.component = self.origin_message.get_component(self.custom_id)
 
-        self.selected_options = _json["data"]["values"] if self.component_type == 3 else None
+        self.selected_options = None
+
+        if self.component_type == 3:
+            self.selected_options = _json["data"].get("values", [])
 
     async def defer(self, hidden: bool = False, edit_origin: bool = False):
         """
diff --git a/discord_slash/model.py b/discord_slash/model.py
@@ -549,15 +549,15 @@ async def _slash_edit(self, **fields):
 
         allowed_mentions = fields.get("allowed_mentions")
         if allowed_mentions is not None:
-            if self.bot.allowed_mentions is not None:
-                _resp["allowed_mentions"] = self.bot.allowed_mentions.merge(
+            if self._state.allowed_mentions is not None:
+                _resp["allowed_mentions"] = self._state.allowed_mentions.merge(
                     allowed_mentions
                 ).to_dict()
             else:
                 _resp["allowed_mentions"] = allowed_mentions.to_dict()
         else:
-            if self.bot.allowed_mentions is not None:
-                _resp["allowed_mentions"] = self.bot.allowed_mentions.to_dict()
+            if self._state.allowed_mentions is not None:
+                _resp["allowed_mentions"] = self._state.allowed_mentions.to_dict()
             else:
                 _resp["allowed_mentions"] = {}
 
diff --git a/discord_slash/utils/manage_commands.py b/discord_slash/utils/manage_commands.py
@@ -184,7 +184,7 @@ async def update_single_command_permissions(bot_id, bot_token, guild_id, command
     url = f"https://discord.com/api/v8/applications/{bot_id}/guilds/{guild_id}/commands/{command_id}/permissions"
     async with aiohttp.ClientSession() as session:
         async with session.put(
-            url, headers={"Authorization": f"Bot {bot_token}"}, json=permissions
+            url, headers={"Authorization": f"Bot {bot_token}"}, json={"permissions": permissions}
         ) as resp:
             if resp.status == 429:
                 _json = await resp.json()
diff --git a/discord_slash/utils/manage_components.py b/discord_slash/utils/manage_components.py
@@ -202,6 +202,7 @@ def create_select(
     placeholder: typing.Optional[str] = None,
     min_values: typing.Optional[int] = None,
     max_values: typing.Optional[int] = None,
+    disabled: bool = False,
 ):
     """
     Creates a select (dropdown) component for use with the ``components`` field. Must be inside an ActionRow to be used (see :meth:`create_actionrow`).
@@ -211,6 +212,7 @@ def create_select(
     :param placeholder: Custom placeholder text if nothing is selected
     :param min_values: The minimum number of items that **must** be chosen
     :param max_values: The maximum number of items that **can** be chosen
+    :param disabled: Disables this component. Defaults to ``False``.
     """
     if not len(options) or len(options) > 25:
         raise IncorrectFormat("Options length should be between 1 and 25.")
@@ -222,6 +224,7 @@ def create_select(
         "placeholder": placeholder or "",
         "min_values": min_values,
         "max_values": max_values,
+        "disabled": disabled,
     }
 
 
@@ -302,7 +305,7 @@ async def wait_for_component(
     custom_ids = list(get_components_ids(components)) if components else None
 
     # automatically convert improper custom_ids
-    if not all(isinstance(x, str) for x in custom_ids):
+    if custom_ids and not all(isinstance(x, str) for x in custom_ids):
         custom_ids = [str(i) for i in custom_ids]
         logger.warning(
             "Custom_ids have been automatically converted to a list of strings. Please use lists of strings in future.\n"
diff --git a/docs/components.rst b/docs/components.rst
@@ -117,11 +117,11 @@ Each button gets a ``custom_id`` (which is always a string), this is a unique id
 What about selects / Dropdowns?
 _______________________________
 
-Yep we support those too. You use them much the same as buttons:
+Yep we support those too. You use them much the same as buttons. You can only have 1 select per action row, but each select can have up to 25 options in it!
 
 .. code-block:: python
 
-    from discord_slash.utils.manage_components import create_select, create_select_option
+    from discord_slash.utils.manage_components import create_select, create_select_option, create_actionrow
 
     select = create_select(
         options=[# the options in your dropdown
@@ -133,8 +133,10 @@ Yep we support those too. You use them much the same as buttons:
         min_values=1,  # the minimum number of options a user must select
         max_values=2,  # the maximum number of options a user can select
     )
+    
+    await ctx.send("test", components=[create_actionrow(select)])  # like action row with buttons but without * in front of the variable
 
     @bot.event
     async def on_component(ctx: ComponentContext):
         # ctx.selected_options is a list of all the values the user selected
-        await ctx.send(content=f"You selected {ctx.selected_options}")
+        await ctx.send(content=f"You selected {ctx.selected_options}")
