app_commands: cleaner autocomplete registration?

[codeofdusk]

Hello,

I have a cog that looks (roughly) like this:

class Colours2(commands.Cog):
    ID_RED = 1
    ID_BLUE = 2

    @app_commands.command()
    async def describe(self, interaction, colour: int):
        if colour == ID_RED:
            await interaction.response.send_message("The colour of blood", ephemeral=True)
        elif colour == ID_BLUE:
            await interaction.response.send_message("The colour of the sky", ephemeral=True)
        else:
            await interaction.response.send_message("No clue", ephemeral=True)

    @describe.autocomplete("colour")
    async def describe_autocomplete(
        self, interaction: discord.Interaction, current: str
    ) -> List[app_commands.Choice[str]]:
        return self._autocomplete_colour_id(current)

    @app_commands.command()
    async def red(self, interaction, colour: int):
        if colour == ID_RED:
            await interaction.response.send_message("This colour is red!", ephemeral=True)
        else:
            await interaction.response.send_message("This colour is not red!", ephemeral=True)

    @red.autocomplete("colour")
    async def red_autocomplete(
        self, interaction: discord.Interaction, current: str
    ) -> List[app_commands.Choice[str]]:
        return self._autocomplete_colour_id(current)

    def _autocomplete_colour_id(self, current: str):
        # Do some filesystem/network magic to populate the autocomplete choices...
        return [
            app_commands.Choice(name="Red", value=ID_RED),
            app_commands.Choice(name="Blue", value=ID_BLUE),
        ]

The describe_autocomplete and red_autocomplete are virtually identical: they just call _autocomplete_colour_id that does the actual completion based on the currently entered string. Is there a more elegant/idiomatic way to register these autocompletes without creating many very similar functions like this? Thanks!

[Soheab]

1. You can use the discord.app_commands.autocomplete decorator to set an autocomplete callable for a parameter.

Example:

async def my_autocomplete(...):
    ...

@app_commands.command()
@app_commands.autocomplete(colour=my_autocomplete)
async def foo(
    self,
    interaction: Interaction,
    colour: str
):
    ...

@app_commands.command()
@app_commands.autocomplete(color=my_autocomplete)
async def bar(
    self,
    interaction: Interaction,
    color: int
):
    ...

2. I'm not too sure about this and haven't tried but I guess you can try stacking the @command.autocomplete(...) decorators on one autocomplete

@foo.autocomplete("colour")
@bar.autocomplete("color")
async def my_autocomplete(...):
    ...

Apologies if I'm completely wrong on that.

[codeofdusk]

I've slightly modified my example to incorporate your first suggestion:

ID_RED = 1
ID_BLUE = 2


class Colours2(commands.Cog):
    @app_commands.command()
    @app_commands.autocomplete(colour=_autocomplete_colour_id)
    async def describe(self, interaction, colour: int):
        if colour == ID_RED:
            await interaction.response.send_message("The colour of blood", ephemeral=True)
        elif colour == ID_BLUE:
            await interaction.response.send_message("The colour of the sky", ephemeral=True)
        else:
            await interaction.response.send_message("No clue", ephemeral=True)

    @app_commands.command()
    @app_commands.autocomplete(colour=_autocomplete_colour_id)
    async def red(self, interaction, colour: int):
        if colour == ID_RED:
            await interaction.response.send_message("This colour is red!", ephemeral=True)
        else:
            await interaction.response.send_message("This colour is not red!", ephemeral=True)

    def _autocomplete_colour_id(self, interaction, current: str):
        # Do some filesystem/network magic to populate the autocomplete choices...
        return [
            app_commands.Choice(name="Red", value=ID_RED),
            app_commands.Choice(name="Blue", value=ID_BLUE),
        ]

But now I get:

Traceback (most recent call last):                                                                                      
  ...
  File "colours2.py", line 11, in <module>                                                     
    class Colours2(commands.Cog):                                                                                       
  File "colours2.py", line 13, in Colours2                                                     
    @app_commands.autocomplete(colour=_autocomplete_colour_id)                                                          
NameError: name '_autocomplete_colour_id' is not defined

[LostLuma]

You'll have to define this method first, then any decorators that make use of it.

[codeofdusk]

Thanks all!