Source code for hikari.interactions.command_interactions

# -*- coding: utf-8 -*-
# cython: language_level=3
# Copyright (c) 2020 Nekokatt
# Copyright (c) 2021-present davfsa
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Models and enums used for Discord's Slash Commands interaction flow."""
from __future__ import annotations

__all__: typing.Sequence[str] = (
    "AutocompleteInteraction",
    "BaseCommandInteraction",
    "CommandInteractionOption",
    "AutocompleteInteractionOption",
    "CommandInteraction",
    "COMMAND_RESPONSE_TYPES",
    "CommandResponseTypesT",
)

import typing

import attrs

from hikari import channels
from hikari import commands
from hikari import snowflakes
from hikari import traits
from hikari import undefined
from hikari.interactions import base_interactions
from hikari.internal import attrs_extensions

if typing.TYPE_CHECKING:
    from typing_extensions import Self

    from hikari import guilds
    from hikari import permissions as permissions_
    from hikari import users as users_
    from hikari.api import special_endpoints


[docs] COMMAND_RESPONSE_TYPES: typing.Final[typing.AbstractSet[CommandResponseTypesT]] = frozenset( [base_interactions.ResponseType.MESSAGE_CREATE, base_interactions.ResponseType.DEFERRED_MESSAGE_CREATE] )
"""Set of the response types which are valid for a command interaction. This includes: * `hikari.interactions.base_interactions.ResponseType.MESSAGE_CREATE` * `hikari.interactions.base_interactions.ResponseType.DEFERRED_MESSAGE_CREATE` """
[docs] CommandResponseTypesT = typing.Literal[ base_interactions.ResponseType.MESSAGE_CREATE, 4, base_interactions.ResponseType.DEFERRED_MESSAGE_CREATE, 5 ]
"""Type-hint of the response types which are valid for a command interaction. The following types are valid for this: * `hikari.interactions.base_interactions.ResponseType.MESSAGE_CREATE`/`4` * `hikari.interactions.base_interactions.ResponseType.DEFERRED_MESSAGE_CREATE`/`5` """ InteractionChannel = base_interactions.InteractionChannel """Deprecated alias of `hikari.base_interactions.InteractionChannel`.""" ResolvedOptionData = base_interactions.ResolvedOptionData """Deprecated alias of `hikari.base_interactions.ResolvedOptionData`.""" @attrs_extensions.with_copy @attrs.define(hash=False, kw_only=True, weakref_slot=False)
[docs] class CommandInteractionOption: """Represents the options passed for a command interaction."""
[docs] name: str = attrs.field(repr=True)
"""Name of this option."""
[docs] type: typing.Union[commands.OptionType, int] = attrs.field(repr=True)
"""Type of this option."""
[docs] value: typing.Union[snowflakes.Snowflake, str, int, bool, None] = attrs.field(repr=True)
"""Value provided for this option. Either `CommandInteractionOption.value` or `CommandInteractionOption.options` will be provided with `value` being provided when an option is provided as a parameter with a value and `options` being provided when an option donates a subcommand or group. """
[docs] options: typing.Optional[typing.Sequence[Self]] = attrs.field(repr=True)
"""Options provided for this option. Either `CommandInteractionOption.value` or `CommandInteractionOption.options` will be provided with `value` being provided when an option is provided as a parameter with a value and `options` being provided when an option donates a subcommand or group. """
@attrs_extensions.with_copy @attrs.define(hash=False, kw_only=True, weakref_slot=False)
[docs] class AutocompleteInteractionOption(CommandInteractionOption): """Represents the options passed for a command autocomplete interaction."""
[docs] is_focused: bool = attrs.field(default=False, repr=True)
"""Whether this option is the currently focused option for autocomplete. Focused options are not guaranteed to be parsed so the value may be a string even if the option type says otherwise. """
@attrs_extensions.with_copy @attrs.define(hash=True, kw_only=True, weakref_slot=False)
[docs] class BaseCommandInteraction(base_interactions.PartialInteraction): """Represents a base command interaction on Discord. May be a command interaction or an autocomplete interaction. """
[docs] channel_id: snowflakes.Snowflake = attrs.field(eq=False, hash=False, repr=True)
"""ID of the channel this command interaction event was triggered in."""
[docs] guild_id: typing.Optional[snowflakes.Snowflake] = attrs.field(eq=False, hash=False, repr=True)
"""ID of the guild this command interaction event was triggered in. This will be `None` for command interactions triggered in DMs. """
[docs] guild_locale: typing.Optional[str] = attrs.field(eq=False, hash=False, repr=True)
"""The preferred language of the guild this command interaction was triggered in. This will be `None` for command interactions triggered in DMs. .. note:: This value can usually only be changed if `COMMUNITY` is in `hikari.guilds.Guild.features` for the guild and will otherwise default to `en-US`. """
[docs] member: typing.Optional[base_interactions.InteractionMember] = attrs.field(eq=False, hash=False, repr=True)
"""The member who triggered this command interaction. This will be `None` for command interactions triggered in DMs. .. note:: This member object comes with the extra field `permissions` which contains the member's permissions in the current channel. """
[docs] user: users_.User = attrs.field(eq=False, hash=False, repr=True)
"""The user who triggered this command interaction."""
[docs] locale: str = attrs.field(eq=False, hash=False, repr=True)
"""The selected language of the user who triggered this command interaction."""
[docs] command_id: snowflakes.Snowflake = attrs.field(eq=False, hash=False, repr=True)
"""ID of the command being invoked."""
[docs] command_name: str = attrs.field(eq=False, hash=False, repr=True)
"""Name of the command being invoked."""
[docs] command_type: typing.Union[commands.CommandType, int] = attrs.field(eq=False, hash=False, repr=True)
"""The type of the command."""
[docs] async def fetch_channel(self) -> channels.TextableChannel: """Fetch the guild channel this was triggered in. Returns ------- hikari.channels.TextableChannel The requested partial channel derived object of the channel this was triggered in. Raises ------ hikari.errors.UnauthorizedError If you are unauthorized to make the request (invalid/missing token). hikari.errors.ForbiddenError If you are missing the `READ_MESSAGES` permission in the channel. hikari.errors.NotFoundError If the channel is not found. hikari.errors.RateLimitTooLongError Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request. hikari.errors.RateLimitTooLongError Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request. hikari.errors.InternalServerError If an internal error occurs on Discord while handling the request. """ channel = await self.app.rest.fetch_channel(self.channel_id) assert isinstance(channel, channels.TextableChannel) return channel
[docs] def get_channel(self) -> typing.Optional[channels.TextableGuildChannel]: """Get the guild channel this was triggered in from the cache. .. note:: This will always return `None` for interactions triggered in a DM channel. Returns ------- typing.Optional[hikari.channels.TextableGuildChannel] The object of the guild channel that was found in the cache or `None`. """ if isinstance(self.app, traits.CacheAware): channel = self.app.cache.get_guild_channel(self.channel_id) assert channel is None or isinstance(channel, channels.TextableGuildChannel) return channel return None
[docs] async def fetch_command(self) -> commands.PartialCommand: """Fetch the command which triggered this interaction. Returns ------- hikari.commands.PartialCommand Object of this interaction's command. Raises ------ hikari.errors.ForbiddenError If you cannot access the target command. hikari.errors.NotFoundError If the command isn't found. hikari.errors.UnauthorizedError If you are unauthorized to make the request (invalid/missing token). hikari.errors.RateLimitTooLongError Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request. hikari.errors.InternalServerError If an internal error occurs on Discord while handling the request. """ return await self.app.rest.fetch_application_command( application=self.application_id, command=self.id, guild=self.guild_id or undefined.UNDEFINED )
[docs] async def fetch_guild(self) -> typing.Optional[guilds.RESTGuild]: """Fetch the guild this interaction happened in. Returns ------- typing.Optional[hikari.guilds.RESTGuild] Object of the guild this interaction happened in or `None` if this occurred within a DM channel. Raises ------ hikari.errors.ForbiddenError If you are not part of the guild. hikari.errors.NotFoundError If the guild is not found. hikari.errors.UnauthorizedError If you are unauthorized to make the request (invalid/missing token). hikari.errors.RateLimitTooLongError Raised in the event that a rate limit occurs that is longer than `max_rate_limit` when making a request. hikari.errors.InternalServerError If an internal error occurs on Discord while handling the request. """ if not self.guild_id: return None return await self.app.rest.fetch_guild(self.guild_id)
[docs] def get_guild(self) -> typing.Optional[guilds.GatewayGuild]: """Get the object of this interaction's guild guild from the cache. Returns ------- typing.Optional[hikari.guilds.GatewayGuild] The object of the guild if found, else `None`. """ if self.guild_id and isinstance(self.app, traits.CacheAware): return self.app.cache.get_guild(self.guild_id) return None
@attrs_extensions.with_copy @attrs.define(hash=True, kw_only=True, weakref_slot=False)
[docs] class CommandInteraction( BaseCommandInteraction, base_interactions.MessageResponseMixin[CommandResponseTypesT], base_interactions.ModalResponseMixin, ): """Represents a command interaction on Discord."""
[docs] app_permissions: typing.Optional[permissions_.Permissions] = attrs.field(eq=False, hash=False, repr=False)
"""Permissions the bot has in this interaction's channel if it's in a guild."""
[docs] options: typing.Optional[typing.Sequence[CommandInteractionOption]] = attrs.field(eq=False, hash=False, repr=True)
"""Parameter values provided by the user invoking this command."""
[docs] resolved: typing.Optional[base_interactions.ResolvedOptionData] = attrs.field(eq=False, hash=False, repr=False)
"""Mappings of the objects resolved for the provided command options."""
[docs] target_id: typing.Optional[snowflakes.Snowflake] = attrs.field(default=None, eq=False, hash=False, repr=True)
"""The target of the command. Only available if the command is a context menu command."""
[docs] def build_response(self) -> special_endpoints.InteractionMessageBuilder: """Get a message response builder for use in the REST server flow. .. note:: For interactions received over the gateway `CommandInteraction.create_initial_response` should be used to set the interaction response message. Examples -------- .. code-block:: python async def handle_command_interaction(interaction: CommandInteraction) -> InteractionMessageBuilder: return ( interaction .build_response() .add_embed(Embed(description="Hi there")) .set_content("Konnichiwa") ) Returns ------- hikari.api.special_endpoints.InteractionMessageBuilder Interaction message response builder object. """ return self.app.rest.interaction_message_builder(base_interactions.ResponseType.MESSAGE_CREATE)
[docs] def build_deferred_response(self) -> special_endpoints.InteractionDeferredBuilder: """Get a deferred message response builder for use in the REST server flow. .. note:: For interactions received over the gateway `CommandInteraction.create_initial_response` should be used to set the interaction response message. .. note:: Unlike `hikari.api.special_endpoints.InteractionMessageBuilder`, the result of this call can be returned as is without any modifications being made to it. Examples -------- .. code-block:: python async def handle_command_interaction(interaction: CommandInteraction) -> InteractionMessageBuilder: yield interaction.build_deferred_response() await interaction.edit_initial_response("Pong!") Returns ------- hikari.api.special_endpoints.InteractionMessageBuilder Deferred interaction message response builder object. """ return self.app.rest.interaction_deferred_builder(base_interactions.ResponseType.DEFERRED_MESSAGE_CREATE)
@attrs_extensions.with_copy @attrs.define(hash=True, kw_only=True, weakref_slot=False)
[docs] class AutocompleteInteraction(BaseCommandInteraction): """Represents an autocomplete interaction on Discord."""
[docs] options: typing.Sequence[AutocompleteInteractionOption] = attrs.field(eq=False, hash=False, repr=True)
"""Parameter values provided by the user invoking this command."""
[docs] def build_response( self, choices: typing.Sequence[special_endpoints.AutocompleteChoiceBuilder] ) -> special_endpoints.InteractionAutocompleteBuilder: """Get a message response builder for use in the REST server flow. .. note:: For interactions received over the gateway `AutocompleteInteraction.create_response` should be used to set the interaction response. Parameters ---------- choices : typing.Sequence[hikari.api.special_endpoints.AutocompleteChoiceBuilder] The choices for the autocomplete. Examples -------- .. code-block:: python async def handle_autocomplete_interaction(interaction: AutocompleteInteraction) -> InteractionAutocompleteBuilder: return ( interaction .build_response( [ AutocompleteChoiceBuilder(name="foo", value="a"), AutocompleteChoiceBuilder(name="bar", value="b"), AutocompleteChoiceBuilder(name="baz", value="c"), ] ) ) Returns ------- hikari.api.special_endpoints.InteractionAutocompleteBuilder Interaction autocomplete response builder object. """ return self.app.rest.interaction_autocomplete_builder(choices)
[docs] async def create_response(self, choices: typing.Sequence[special_endpoints.AutocompleteChoiceBuilder]) -> None: """Create a response for this autocomplete interaction. Parameters ---------- choices : typing.Sequence[hikari.api.special_endpoints.AutocompleteChoiceBuilder] The choices for the autocomplete. """ await self.app.rest.create_autocomplete_response(self.id, self.token, choices)