Fix slash command scope image in docs (#104)

This time its visible properly

README.rst

@@ -17,18 +17,6 @@ The Future of enhanced-discord.py
 --------------------------
 
 Enhanced discord.py is a fork of Rapptz's discord.py, that went unmaintained (`gist <https://gist.github.com/Rapptz/4a2f62751b9600a31a0d3c78100287f1>`_)
-
-It is currently maintained by (in alphabetical order)
-
-- Chillymosh#8175
-- Daggy#9889
-- dank Had0cK#6081
-- Dutchy#6127
-- Eyesofcreeper#0001
-- Gnome!#6669
-- IAmTomahawkx#1000
-- Jadon#2494
-
 An overview of added features is available on the `custom features page <https://enhanced-dpy.readthedocs.io/en/latest/index.html#custom-features>`_.
 
 Key Features

discord/enums.py

@@ -55,6 +55,7 @@ __all__ = (
     "InteractionType",
     "InteractionResponseType",
     "NSFWLevel",
+    "ProtocolURL",
 )
 
 
@@ -529,6 +530,7 @@ class InteractionType(Enum):
     ping = 1
     application_command = 2
     component = 3
+    application_command_autocomplete = 4
 
 
 class InteractionResponseType(Enum):
@@ -539,6 +541,7 @@ class InteractionResponseType(Enum):
     deferred_channel_message = 5  # (with source)
     deferred_message_update = 6  # for components
     message_update = 7  # for components
+    application_command_autocomplete_result = 8
 
 
 class VideoQualityMode(Enum):
@@ -590,6 +593,74 @@ class NSFWLevel(Enum, comparable=True):
     age_restricted = 3
 
 
+class ProtocolURL(Enum):
+
+    # General
+
+    home = "discord://-/channels/@me/"
+    nitro = "discord://-/store"
+    apps = "discord://-/apps"  # Breaks the client on windows (Shows download links for different OS)
+    guild_discovery = "discord://-/guild-discovery"
+    guild_create = "discord://-/guilds/create"
+    guild_invite = "discord://-/invite/{invite_code}"
+
+    # Settings
+
+    account_settings = "discord://-/settings/account"
+    profile_settings = "discord://-/settings/profile-customization"
+    privacy_settings = "discord://-/settings/privacy-and-safety"
+    safety_settings = "discord://-/settings/privacy-and-safety"  # Alias
+    authorized_apps_settings = "discord://-/settings/authorized-apps"
+    connections_settings = "discord://-/settings/connections"
+    nitro_settings = "discord://-/settings/premium"  # Same as store, but inside of settings
+    guild_premium_subscription = "discord://-/settings/premium-guild-subscription"
+    subscription_settings = "discord://-/settings/subscriptions"
+    gift_inventory_settings = "discord://-/settings/inventory"
+    billing_settings = "discord://-/settings/billing"
+    appearance_settings = "discord://-/settings/appearance"
+    accessibility_settings = "discord://-/settings/accessibility"
+    voice_video_settings = "discord://-/settings/voice"
+    text_images_settings = "discord://-/settings/text"
+    notifications_settings = "discord://-/settings/notifications"
+    keybinds_settings = "discord://-/settings/keybinds"
+    language_settings = "discord://-/settings/locale"
+    windows_settings = "discord://-/settings/windows"  # Doesnt work if used on wrong platform
+    linux_settings = "discord://-/settings/linux"  # Doesnt work if used on wrong platform
+    streamer_mode_settings = "discord://-/settings/streamer-mode"
+    advanced_settings = "discord://-/settings/advanced"
+    activity_status_settings = "discord://-/settings/activity-status"
+    game_overlay_settings = "discord://-/settings/overlay"
+    hypesquad_settings = "discord://-/settings/hypesquad-online"
+
+    changelogs = "discord://-/settings/changelogs"
+
+    # Doesn't work if you don't have it actually activated. Just blank screen.
+    experiments = "discord://-/settings/experiments"
+
+    developer_options = "discord://-/settings/developer-options"  # Same as experiments
+    hotspot_options = "discord://-/settings/hotspot-options"  # Same as experiments
+
+    # Users, Guilds, and DMs
+
+    user_profile = "discord://-/users/{user_id}"
+    dm_channel = "discord://-/channels/@me/{channel_id}"
+    dm_message = "discord://-/channels/@me/{channel_id}/{message_id}"
+    guild_channel = "discord://-/channels/{guild_id}/{channel_id}"
+    guild_message = "discord://-/channels/{guild_id}/{channel_id}/{message_id}"
+    guild_membership_screening = "discord://-/member-verification/{guild_id}"
+
+    # Library
+
+    games_library = "discord://-/library"
+    library_settings = "discord://-/library/settings"
+
+    def __str__(self) -> str:
+        return self.value
+
+    def format(self, **kwargs: Any) -> str:
+        return self.value.format(**kwargs)
+
+
 T = TypeVar("T")
 
 

discord/ext/commands/bot.py

@@ -122,7 +122,7 @@ class _FakeSlashMessage(discord.PartialMessage):
     def mentions(self) -> List[Union[discord.Member, discord.User]]:
         client = self._state._get_client()
         if self.guild:
-            ensure_user = lambda id: self.guild.get_member(id) or client.get_user(id) # type: ignore
+            ensure_user = lambda id: self.guild.get_member(id) or client.get_user(id)  # type: ignore
         else:
             ensure_user = client.get_user
 
@@ -188,16 +188,17 @@ def _is_submodule(parent: str, child: str) -> bool:
 
 def _unwrap_slash_groups(
     data: ApplicationCommandInteractionData,
-) -> Tuple[str, List[ApplicationCommandInteractionDataOption]]:
+) -> Tuple[str, Dict[str, ApplicationCommandInteractionDataOption]]:
     command_name = data["name"]
-    command_options = data.get("options") or []
+    command_options: Any = data.get("options") or []
-    while any(o["type"] in {1, 2} for o in command_options):  # type: ignore
+    while True:
-        for option in command_options:  # type: ignore
+        try:
-            if option["type"] in {1, 2}:  # type: ignore
+            option = next(o for o in command_options if o["type"] in {1, 2})
-                command_name += f' {option["name"]}'  # type: ignore
+        except StopIteration:
-                command_options = option.get("options") or []
+            return command_name, {o["name"]: o for o in command_options}
-
+        else:
-    return command_name, command_options
+            command_name += f' {option["name"]}'
+            command_options = option.get("options") or []
 
 
 def _quote_string_safe(string: str) -> str:
@@ -1292,14 +1293,14 @@ class BotBase(GroupMixin):
 
         # Make our fake message so we can pass it to ext.commands
         message: discord.Message = _FakeSlashMessage.from_interaction(interaction, channel)  # type: ignore
-        message.content = f"/{command_name} "
+        message.content = f"/{command_name}"
 
         # Add arguments to fake message content, in the right order
         ignore_params: List[inspect.Parameter] = []
         for name, param in command.clean_params.items():
             if inspect.isclass(param.annotation) and issubclass(param.annotation, FlagConverter):
                 for name, flag in param.annotation.get_flags().items():
-                    option = next((o for o in command_options if o["name"] == name), None)
+                    option = command_options.get(name)
 
                     if option is None:
                         if flag.required:
@@ -1307,10 +1308,10 @@ class BotBase(GroupMixin):
                     else:
                         prefix = param.annotation.__commands_flag_prefix__
                         delimiter = param.annotation.__commands_flag_delimiter__
-                        message.content += f"{prefix}{name} {option['value']}{delimiter}"  # type: ignore
+                        message.content += f" {prefix}{name}{delimiter}{option['value']}"  # type: ignore
                 continue
 
-            option = next((o for o in command_options if o["name"] == name), None)
+            option = command_options.get(name)
             if option is None:
                 if param.default is param.empty and not command._is_typing_optional(param.annotation):
                     raise errors.MissingRequiredArgument(param)
@@ -1323,9 +1324,9 @@ class BotBase(GroupMixin):
             ):
                 # String with space in without "consume rest"
                 option = cast(_ApplicationCommandInteractionDataOptionString, option)
-                message.content += f"{_quote_string_safe(option['value'])} "
+                message.content += f" {_quote_string_safe(option['value'])}"
             else:
-                message.content += f'{option.get("value", "")} '
+                message.content += f' {option.get("value", "")}'
 
         ctx = await self.get_context(message)
         ctx._ignored_params = ignore_params

discord/ext/commands/context.py

@@ -22,11 +22,12 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 """
 from __future__ import annotations
+import asyncio
 
 import inspect
 import re
 from datetime import timedelta
-from typing import Any, Dict, Generic, List, Literal, Optional, TYPE_CHECKING, TypeVar, Union, overload
+from typing import Any, Dict, Generic, List, Literal, NoReturn, Optional, TYPE_CHECKING, TypeVar, Union, overload
 
 import discord.abc
 import discord.utils
@@ -155,6 +156,7 @@ class Context(discord.abc.Messageable, Generic[BotT]):
         self.command_failed: bool = command_failed
         self.current_parameter: Optional[inspect.Parameter] = current_parameter
         self._ignored_params: List[inspect.Parameter] = []
+        self._typing_task: Optional[asyncio.Task[NoReturn]] = None
         self._state: ConnectionState = self.message._state
 
     async def invoke(self, command: Command[CogT, P, T], /, *args: P.args, **kwargs: P.kwargs) -> T:
@@ -455,6 +457,10 @@ class Context(discord.abc.Messageable, Generic[BotT]):
             In a normal context, it always returns a :class:`.Message`
         """
 
+        if self._typing_task is not None:
+            self._typing_task.cancel()
+            self._typing_task = None
+
         if self.interaction is None or (
             self.interaction.response.responded_at is not None
             and discord.utils.utcnow() - self.interaction.response.responded_at >= timedelta(minutes=15)
@@ -500,3 +506,30 @@ class Context(discord.abc.Messageable, Generic[BotT]):
         self, content: Optional[str] = None, return_message: bool = True, **kwargs: Any
     ) -> Optional[Union[Message, WebhookMessage]]:
         return await self.send(content, return_message=return_message, reference=self.message, **kwargs)  # type: ignore
+
+    async def defer(self, *, ephemeral: bool = False, trigger_typing: bool = True) -> None:
+        """|coro|
+
+        Defers the Slash Command interaction if ran in a slash command **or**
+
+        Loops triggering ``Bot is typing`` in the channel if run in a message command.
+
+        Parameters
+        ------------
+        trigger_typing: :class:`bool`
+            Indicates whether to trigger typing in a message command.
+        ephemeral: :class:`bool`
+            Indicates whether the deferred message will eventually be ephemeral in a slash command.
+        """
+
+        if self.interaction is None:
+            if self._typing_task is None and trigger_typing:
+
+                async def typing_task():
+                    while True:
+                        await self.trigger_typing()
+                        await asyncio.sleep(10)
+
+                self._typing_task = self.bot.loop.create_task(typing_task())
+        else:
+            await self.interaction.response.defer(ephemeral=ephemeral)

discord/ext/commands/converter.py

@@ -1032,6 +1032,8 @@ class Option(Generic[T, DT]):  # type: ignore
         The default for this option, overwrites Option during parsing.
     description: :class:`str`
         The description for this option, is unpacked to :attr:`.Command.option_descriptions`
+    name: :class:`str`
+        The name of the option. This defaults to the parameter name.
     """
 
     description: DT
@@ -1039,17 +1041,18 @@ class Option(Generic[T, DT]):  # type: ignore
     __slots__ = (
         "default",
         "description",
+        "name",
     )
 
-    def __init__(self, default: T = inspect.Parameter.empty, *, description: DT) -> None:
+    def __init__(
+        self, default: T = inspect.Parameter.empty, *, description: DT, name: str = discord.utils.MISSING
+    ) -> None:
         self.description = description
         self.default = default
+        self.name: str = name
 
 
-if TYPE_CHECKING:
+Option: Any
-    # Terrible workaround for type checking reasons
-    def Option(default: T = inspect.Parameter.empty, *, description: str) -> T:
-        ...
 
 
 def _convert_to_bool(argument: str) -> bool:

discord/ext/commands/core.py

@@ -136,6 +136,14 @@ application_option_type_lookup = {
     discord.Role: 8,
     float: 10,
 }
+application_option_channel_types = {
+    discord.VoiceChannel: [2],
+    discord.TextChannel: [0, 5, 6],
+    discord.CategoryChannel: [4],
+    discord.Thread: [10, 11, 12],
+    discord.StageChannel: [13],
+}
+
 
 if TYPE_CHECKING:
     P = ParamSpec("P")
@@ -166,8 +174,12 @@ def get_signature_parameters(
         annotation = parameter.annotation
         if isinstance(parameter.default, Option):  # type: ignore
             option = parameter.default
-            descriptions[name] = option.description
             parameter = parameter.replace(default=option.default)
+            if option.name is not MISSING:
+                name = option.name
+                parameter.replace(name=name)
+
+            descriptions[name] = option.description
 
         if annotation is parameter.empty:
             params[name] = parameter
@@ -1226,15 +1238,25 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
             ctx.command = original
 
     def _param_to_options(
-        self, name: str, annotation: Any, required: bool, varadic: bool
+        self, name: str, annotation: Any, required: bool, varadic: bool, description: Optional[str] = None
     ) -> List[Optional[ApplicationCommandInteractionDataOption]]:
+
+        if description is not None:
+            self.option_descriptions[name] = description
+
+        description = self.option_descriptions[name]
         origin = getattr(annotation, "__origin__", None)
+
         if inspect.isclass(annotation) and issubclass(annotation, FlagConverter):
             return [
                 param
                 for name, flag in annotation.get_flags().items()
                 for param in self._param_to_options(
-                    name, flag.annotation, required=flag.required, varadic=flag.annotation is tuple
+                    name,
+                    flag.annotation,
+                    required=flag.required,
+                    varadic=flag.annotation is tuple,
+                    description=flag.description if flag.description is not MISSING else None,
                 )
             ]
 
@@ -1242,15 +1264,16 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
             annotation = str
             origin = None
 
-        if not required and origin is not None and len(annotation.__args__) == 2:
+        if not required and origin is Union and annotation.__args__[-1] is type(None):
             # Unpack Optional[T] (Union[T, None]) into just T
-            annotation, origin = annotation.__args__[0], None
+            annotation = annotation.__args__[0]
+            origin = getattr(annotation, "__origin__", None)
 
         option: Dict[str, Any] = {
             "type": 3,
             "name": name,
             "required": required,
-            "description": self.option_descriptions[name],
+            "description": description,
         }
 
         if origin is None:
@@ -1265,12 +1288,23 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
             for python_type, discord_type in application_option_type_lookup.items():
                 if issubclass(annotation, python_type):
                     option["type"] = discord_type
+                    # Set channel types
+                    if discord_type == 7:
+                        option["channel_types"] = application_option_channel_types[annotation]
                     break
 
         elif origin is Union:
             if annotation in {Union[discord.Member, discord.Role], Union[MemberConverter, RoleConverter]}:
                 option["type"] = 9
 
+            elif all([arg in application_option_channel_types for arg in annotation.__args__]):
+                option["type"] = 7
+                option["channel_types"] = [
+                    discord_value
+                    for arg in annotation.__args__
+                    for discord_value in application_option_channel_types[arg]
+                ]
+
         elif origin is Literal:
             literal_values = annotation.__args__
             python_type = type(literal_values[0])
@@ -1694,7 +1728,9 @@ class Group(GroupMixin[CogT], Command[CogT, P, T]):
             "name": self.name,
             "type": int(not (nested - 1)) + 1,
             "description": self.short_doc or "no description",
-            "options": [cmd.to_application_command(nested=nested + 1) for cmd in sorted(self.commands, key=lambda x: x.name)],
+            "options": [
+                cmd.to_application_command(nested=nested + 1) for cmd in sorted(self.commands, key=lambda x: x.name)
+            ],
         }
 
 

discord/ext/commands/errors.py

@@ -455,7 +455,7 @@ class BadInviteArgument(BadArgument):
     This inherits from :exc:`BadArgument`
 
     .. versionadded:: 1.5
-    
+
     Attributes
     -----------
     argument: :class:`str`

discord/ext/commands/flags.py

@@ -81,6 +81,8 @@ class Flag:
     ------------
     name: :class:`str`
         The name of the flag.
+    description: :class:`str`
+        The description of the flag.
     aliases: List[:class:`str`]
         The aliases of the flag name.
     attribute: :class:`str`
@@ -97,6 +99,7 @@ class Flag:
     """
 
     name: str = MISSING
+    description: str = MISSING
     aliases: List[str] = field(default_factory=list)
     attribute: str = MISSING
     annotation: Any = MISSING
@@ -117,6 +120,7 @@ class Flag:
 def flag(
     *,
     name: str = MISSING,
+    description: str = MISSING,
     aliases: List[str] = MISSING,
     default: Any = MISSING,
     max_args: int = MISSING,
@@ -129,6 +133,8 @@ def flag(
     ------------
     name: :class:`str`
         The flag name. If not given, defaults to the attribute name.
+    description: :class:`str`
+        Description of the flag for the slash commands options. The default value is `'no description'`.
     aliases: List[:class:`str`]
         Aliases to the flag name. If not given no aliases are set.
     default: Any
@@ -143,7 +149,9 @@ def flag(
         Whether multiple given values overrides the previous value. The default
         value depends on the annotation given.
     """
-    return Flag(name=name, aliases=aliases, default=default, max_args=max_args, override=override)
+    return Flag(
+        name=name, description=description, aliases=aliases, default=default, max_args=max_args, override=override
+    )
 
 
 def validate_flag_name(name: str, forbidden: Set[str]):

discord/http.py

@@ -188,8 +188,8 @@ class HTTPClient:
         self.proxy_auth: Optional[aiohttp.BasicAuth] = proxy_auth
         self.use_clock: bool = not unsync_clock
 
-        user_agent = "DiscordBot (https://github.com/iDevision/enhanced-discord.py {0}) Python/{1[0]}.{1[1]} aiohttp/{2}"
+        u_agent = "DiscordBot (https://github.com/iDevision/enhanced-discord.py {0}) Python/{1[0]}.{1[1]} aiohttp/{2}"
-        self.user_agent: str = user_agent.format(__version__, sys.version_info, aiohttp.__version__)
+        self.user_agent: str = u_agent.format(__version__, sys.version_info, aiohttp.__version__)
 
     def recreate(self) -> None:
         if self.__session.closed:

discord/interactions.py

@@ -51,6 +51,7 @@ if TYPE_CHECKING:
 
     from .types.interactions import (
         Interaction as InteractionPayload,
+        ApplicationCommandOptionChoice,
         InteractionData,
     )
     from .guild import Guild
@@ -632,6 +633,43 @@ class InteractionResponse:
 
         self.responded_at = utils.utcnow()
 
+    async def autocomplete_result(self, choices: List[ApplicationCommandOptionChoice]):
+        """|coro|
+
+        Responds to this autocomplete interaction with the resulting choices.
+        This should rarely be used.
+
+        Parameters
+        -----------
+        choices: List[Dict[:class:`str`, :class:`str`]]
+            The choices to be shown in the autocomplete UI of the user.
+            Must be a list of dictionaries with the ``name`` and ``value`` keys.
+
+        Raises
+        -------
+        HTTPException
+            Responding to the interaction failed.
+        InteractionResponded
+            This interaction has already been responded to before.
+        """
+        if self.is_done():
+            raise InteractionResponded(self._parent)
+
+        parent = self._parent
+        if parent.type is not InteractionType.application_command_autocomplete:
+            return
+
+        adapter = async_context.get()
+        await adapter.create_interaction_response(
+            parent.id,
+            parent.token,
+            session=parent._session,
+            type=InteractionResponseType.application_command_autocomplete_result.value,
+            data={"choices": choices},
+        )
+
+        self.responded_at = utils.utcnow()
+
 
 class _InteractionMessageState:
     __slots__ = ("_parent", "_interaction")

discord/ui/button.py

@@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE.
 
 from __future__ import annotations
 
-from typing import Callable, Optional, TYPE_CHECKING, Tuple, Type, TypeVar, Union
+from typing import Any, Callable, Optional, TYPE_CHECKING, Tuple, Type, TypeVar, Union
 import inspect
 import os
 
@@ -60,7 +60,7 @@ class Button(Item[V]):
         The ID of the button that gets received during an interaction.
         If this button is for a URL, it does not have a custom ID.
     url: Optional[:class:`str`]
-        The URL this button sends you to.
+        The URL this button sends you to. This param is automatically casted to :class:`str`.
     disabled: :class:`bool`
         Whether the button is disabled or not.
     label: Optional[:class:`str`]
@@ -91,7 +91,7 @@ class Button(Item[V]):
         label: Optional[str] = None,
         disabled: bool = False,
         custom_id: Optional[str] = None,
-        url: Optional[str] = None,
+        url: Optional[Any] = None,
         emoji: Optional[Union[str, Emoji, PartialEmoji]] = None,
         row: Optional[int] = None,
     ):
@@ -117,7 +117,7 @@ class Button(Item[V]):
         self._underlying = ButtonComponent._raw_construct(
             type=ComponentType.button,
             custom_id=custom_id,
-            url=url,
+            url=str(url) if url else None,
             disabled=disabled,
             label=label,
             style=style,

discord/ui/select.py

@@ -72,7 +72,7 @@ class Select(Item[V]):
         The placeholder text that is shown if nothing is selected, if any.
     min_values: :class:`int`
         The minimum number of items that must be chosen for this select menu.
-        Defaults to 1 and must be between 1 and 25.
+        Defaults to 1 and must be between 0 and 25.
     max_values: :class:`int`
         The maximum number of items that must be chosen for this select menu.
         Defaults to 1 and must be between 1 and 25.
@@ -327,7 +327,7 @@ def select(
         ordering. The row number must be between 0 and 4 (i.e. zero indexed).
     min_values: :class:`int`
         The minimum number of items that must be chosen for this select menu.
-        Defaults to 1 and must be between 1 and 25.
+        Defaults to 1 and must be between 0 and 25.
     max_values: :class:`int`
         The maximum number of items that must be chosen for this select menu.
         Defaults to 1 and must be between 1 and 25.

docs/conf.py

@@ -49,7 +49,7 @@ autodoc_typehints = "none"
 # napoleon_attr_annotations = False
 
 extlinks = {
-    "issue": ("https://github.com/Rapptz/discord.py/issues/%s", "GH-"),
+    "issue": ("https://github.com/iDevision/enhanced-discord.py/issues/%s", "GH-"),
 }
 
 # Links used for cross-referencing stuff in other documentation
@@ -168,9 +168,8 @@ html_context = {
 
 resource_links = {
     "discord": "https://discord.gg/TvqYBrGXEm",
-    "issues": "https://github.com/Rapptz/discord.py/issues",
+    "issues": "https://github.com/iDevision/enhanced-discord.py/issues",
-    "discussions": "https://github.com/Rapptz/discord.py/discussions",
+    "examples": f"https://github.com/iDevision/enhanced-discord.py/tree/{branch}/examples",
-    "examples": f"https://github.com/Rapptz/discord.py/tree/{branch}/examples",
 }
 
 # Theme options are theme-specific and customize the look and feel of a theme

docs/index.rst

@@ -38,7 +38,6 @@ If you're having trouble with something, these resources might help.
 - Ask us and hang out with us in our :resource:`Discord <discord>` server.
 - If you're looking for something specific, try the :ref:`index <genindex>` or :ref:`searching <search>`.
 - Report bugs in the :resource:`issue tracker <issues>`.
-- Ask in our :resource:`GitHub discussions page <discussions>`.
 
 Extensions
 ------------