Skip to content

discord_lfg.commands

Creates discord commands programmatically.

AutocompleteError(messages) #

Bases: Exception

Autocompletion error message handler.

Initialisation.

Source code in src\discord_lfg\commands.py 
15
16
17
def __init__(self, messages):
    """Initialisation."""
    self.messages = messages

messages = messages instance-attribute #

ChannelWhitelistError(message) #

Bases: Exception

Autocompletion error message handler.

Initialisation.

Source code in src\discord_lfg\commands.py 
23
24
25
def __init__(self, message):
    """Initialisation."""
    self.messages = message

messages = message instance-attribute #

autocomplete_validator(interaction, **kwargs) #

Validates that the user inputs match the autocomplete lists they choose from.

When discord shows an autocompletion list to a user, there is no validation of what the user puts in, so you can get a result that doesn't match the autocomplete list. This function is designed to validate the result and respond to the user if they did not enter values that match the autocompletion list.

Source code in src\discord_lfg\commands.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def autocomplete_validator(interaction: discord.Interaction, **kwargs):
    """Validates that the user inputs match the autocomplete lists they choose from.

    When discord shows an autocompletion list to a user, there is no validation of what the user
    puts in, so you can get a result that doesn't match the autocomplete list.
    This function is designed to validate the result and respond to the user if they
    did not enter values that match the autocompletion list.
    """
    errors = []
    for arg_value, command_arg in kwargs.items():
        command_arg: CommandArgument
        if command_arg.autocomplete_channel_numbers:
            if isinstance(interaction.channel.name, str):  # type: ignore
                choices = get_numbers_from_channel_name(interaction.channel.name)  # type: ignore
        else:
            choices = command_arg.autocomplete_options
        if choices is not None and arg_value not in choices:
            errors.append(
                f"You must provide an input matching the autocomplete list for "
                f"`{command_arg.displayed_name}`\n"
                f"You input: `{arg_value}`. "
                f"It must match one of: `{choices}`"
            )

    if errors:
        raise AutocompleteError(errors)

build_command(user_inputs, command_config, func_name, func_desc, func_call) #

Builds a discord slash command programmatically.

Source code in src\discord_lfg\commands.py 
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def build_command(
    user_inputs: list[CommandArgument],
    command_config: CommandConfig,
    func_name: str,
    func_desc: str,
    func_call,
) -> discord.app_commands.Command:
    """Builds a discord slash command programmatically."""
    input_params = [user_input.as_parameter for user_input in user_inputs]
    interaction_param = inspect.Parameter(
        "interaction", inspect.Parameter.POSITIONAL_ONLY, annotation=discord.Interaction
    )
    params = [interaction_param, *input_params]

    sig = inspect.Signature(parameters=params)

    user_inputs_dict = {user_input.name: user_input for user_input in user_inputs}

    async def wrapper(interaction: discord.Interaction, **kwargs):
        if interaction.channel.name not in command_config.channel_whitelist:  # type: ignore
            await _message_func(interaction)(
                "This command cannot be used in this channel.", ephemeral=True
            )
            return None

        try:
            autocomplete_validator(
                interaction, **{str(value): user_inputs_dict[key] for key, value in kwargs.items()}
            )
        except AutocompleteError as e:
            response = "\n".join(e.messages)
            await _message_func(interaction)(response, ephemeral=True)
            return None

        return await func_call(interaction, **kwargs, config=command_config)

    wrapper.__signature__ = sig
    wrapper.__name__ = func_name

    cmd = app_commands.Command(name=func_name, description=func_desc, callback=wrapper)

    for user_input in user_inputs:
        user_input.discord_rename(cmd)
        user_input.discord_description(cmd)
        user_input.discord_autocomplete(cmd)

    return cmd