Merge pull request #361 from zeffo/autocontext

Add AutocompleteContext for autocomplete callbacks

Author: zeffo

discord/commands/commands.py

@@ -36,7 +36,7 @@
 from ..member import Member
 from ..user import User
 from ..message import Message
-from .context import ApplicationContext
+from .context import ApplicationContext, AutocompleteContext
 from ..utils import find, get_or_fetch, async_all
 from ..errors import ValidationError, ClientException
 from .errors import ApplicationCommandError, CheckFailure, ApplicationCommandInvokeError
@@ -500,10 +500,8 @@ async def invoke_autocomplete_callback(self, interaction: Interaction):
                     i["name"]:i["value"] 
                     for i in interaction.data["options"]
                 })
-                # This will only pass args depending on the argcount
-                arg_count = option.autocomplete.__code__.co_argcount
-                args = [interaction, op.get("value", None), values][:arg_count] 
-                result = await option.autocomplete(*args)
+                ctx = AutocompleteContext(interaction, command=self, focused=option, value=op.get("value"), options=values)
+                result = await option.autocomplete(ctx)
                 choices = [
                     o if isinstance(o, OptionChoice) else OptionChoice(o)
                     for o in result

discord/commands/context.py

@@ -32,7 +32,7 @@
     import discord
     from discord.state import ConnectionState
 
-    from .commands import ApplicationCommand
+    from .commands import ApplicationCommand, Option
     from ..cog import Cog
 
 from ..guild import Guild
@@ -142,3 +142,34 @@ def cog(self) -> Optional[Cog]:
             return None
 
         return self.command.cog
+
+
+class AutocompleteContext:
+    """Represents context for a slash command's option autocomplete.
+
+    This class is not created manually and is instead passed to an Option's autocomplete callback.
+
+    .. versionadded:: 2.0
+
+    Attributes
+    -----------
+    interaction: :class:`.Interaction`
+        The interaction object that invoked the autocomplete.
+    command: :class:`.ApplicationCommand`
+        The command that this context belongs to.
+    focused: :class:`.Option`
+        The option the user is currently typing.
+    value: :class:`.str`
+        The content of the focused option.
+    options :class:`.dict`
+        A name to value mapping of the options that the user has selected before this option.
+    """
+
+    __slots__ = ("interaction", "command", "focused", "value", "options")
+    
+    def __init__(self, interaction: Interaction, *, command: ApplicationCommand, focused: Option, value: str, options: dict) -> None:
+        self.interaction = interaction
+        self.command = command
+        self.focused = focused
+        self.value = value
+        self.options = options

discord/utils.py

@@ -85,6 +85,7 @@
     'escape_mentions',
     'as_chunks',
     'format_dt',
+    'basic_autocomplete'
 )
 
 DISCORD_EPOCH = 1420070400000
@@ -128,6 +129,7 @@ def __get__(self, instance, owner):
     from .abc import Snowflake
     from .invite import Invite
     from .template import Template
+    from .commands.context import AutocompleteContext
 
     class _RequestLike(Protocol):
         headers: Mapping[str, Any]
@@ -1027,3 +1029,16 @@ def format_dt(dt: datetime.datetime, /, style: Optional[TimestampStyle] = None)
     if style is None:
         return f'<t:{int(dt.timestamp())}>'
     return f'<t:{int(dt.timestamp())}:{style}>'
+
+def basic_autocomplete(*values):
+    """A helper function to make a basic autocomplete for slash commands. This is a pretty standard autocomplete and
+    will return any options that start with the value from the user, case insensitive.
+    .. versionadded:: 2.0
+    Parameters
+    -----------
+    values: `str`
+        Possible values for the option."""
+    async def autocomplete_callback(ctx: AutocompleteContext):
+        return [x for x in values if x.lower().startswith(ctx.value.lower())]
+
+    return autocomplete_callback