Attrs

Step-by-Step

An example showcasing how attrs utilities can be used with disnake-compass.

Say we wish to create a component, but we do not know the number of options beforehand, and we would like the user to be able to select all of them. It can be cumbersome to manually keep updating the max_values parameter of the select.

examples/attrs.py - create a select

@manager.register

    async def callback(
        self, interaction: disnake.MessageInteraction[disnake.Client]
    ) -> None:
        selection = (
            "\n".join(f"- {value}" for value in interaction.values)
            if interaction.values
            else "nothing :("
        )

To create an instance of this select where all options are selectable, we would need to do the following:

options = [...]
select = CustomisableSelect(options=options, max_values=len(options))

Luckily, with the knowledge that disnake-compass is built upon attrs, a few options become available to us.

For this example, we will be making use of attrs classes’ __attrs_post_init__ method, which is called immediately after attrs finishes its normal initialisation logic. If you’re more familiar with dataclasses, this is essentially the same as dataclasses’ similarly named __post_init__ method.

examples/attrs.py - create a select

@manager.register
class CustomisableSelect(disnake_compass.RichStringSelect):
    def __attrs_post_init__(self) -> None:
        self.max_values = len(self.options)

    async def callback(
        self, interaction: disnake.MessageInteraction[disnake.Client]
    ) -> None:
        selection = (
            "\n".join(f"- {value}" for value in interaction.values)
            if interaction.values
            else "nothing :("
        )

This allows the select to be created as follows:

options = [...]
select = CustomisableSelect(options=options)

Then we create our test command and send the previously created customisable select.

examples/attrs.py - create a command

            ephemeral=True,
        )


@bot.slash_command()
async def make_select(
    interaction: disnake.CommandInteraction[disnake.Client], options: str
) -> None:
    if not options.strip():
        await interaction.response.send_message("You must specify at least one option!")
        return

    actual_options = [
        disnake.SelectOption(label=option.strip())
        for option in options.split(",")
    ]  # fmt: skip

    if len(actual_options) > 25:
        await interaction.response.send_message("You must specify at most 25 options!")

If the string is empty or whitespace, the user did not provide options (lines 3-5). Next, we make the options by splitting over commas (lines 7-10). Before creating the component, validate that there’s max 25 options (lines 12-14). Finally, if everything went correctly, we send the component (lines 16-19).

Source Code

View on GitHub: attrs.py

examples/attrs.py

"""An example showcasing how attrs utilities can be used with disnake-compass."""

import os

import disnake
import disnake_compass
from disnake.ext import commands

bot = commands.InteractionBot()

manager = disnake_compass.get_manager()
manager.add_to_client(bot)


@manager.register
class CustomisableSelect(disnake_compass.RichStringSelect):
    def __attrs_post_init__(self) -> None:
        self.max_values = len(self.options)

    async def callback(
        self, interaction: disnake.MessageInteraction[disnake.Client]
    ) -> None:
        selection = (
            "\n".join(f"- {value}" for value in interaction.values)
            if interaction.values
            else "nothing :("
        )

        await interaction.response.send_message(
            f"You selected:\n{selection}",
            ephemeral=True,
        )


@bot.slash_command()
async def make_select(
    interaction: disnake.CommandInteraction[disnake.Client], options: str
) -> None:
    if not options.strip():
        await interaction.response.send_message("You must specify at least one option!")
        return

    actual_options = [
        disnake.SelectOption(label=option.strip())
        for option in options.split(",")
    ]  # fmt: skip

    if len(actual_options) > 25:
        await interaction.response.send_message("You must specify at most 25 options!")
        return

    component = await CustomisableSelect(options=actual_options).as_ui_component()
    await interaction.response.send_message(
        components=component,
    )


bot.run(os.getenv("EXAMPLE_TOKEN"))