""" The MIT License (MIT) Copyright (c) 2015-2021 Rapptz Copyright (c) 2021-present Disnake Development 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. """ from __future__ import annotations from typing import TYPE_CHECKING, Any, TypeVar import disnake from .bot_base import BotBase, when_mentioned, when_mentioned_or from .context import Context from .interaction_bot_base import InteractionBotBase if TYPE_CHECKING: from ._types import CoroFunc __all__ = ( "when_mentioned", "when_mentioned_or", "BotBase", "Bot", "InteractionBot", "AutoShardedBot", "AutoShardedInteractionBot", ) MISSING: Any = disnake.utils.MISSING T = TypeVar("T") CFT = TypeVar("CFT", bound="CoroFunc") CXT = TypeVar("CXT", bound="Context") class Bot(BotBase, InteractionBotBase, disnake.Client): """Represents a discord bot. This class is a subclass of :class:`disnake.Client` and as a result anything that you can do with a :class:`disnake.Client` you can do with this bot. This class also subclasses :class:`.GroupMixin` to provide the functionality to manage commands. Attributes ---------- command_prefix The command prefix is what the message content must contain initially to have a command invoked. This prefix could either be a string to indicate what the prefix should be, or a callable that takes in the bot as its first parameter and :class:`disnake.Message` as its second parameter and returns the prefix. This is to facilitate "dynamic" command prefixes. This callable can be either a regular function or a coroutine. An empty string as the prefix always matches, enabling prefix-less command invocation. While this may be useful in DMs it should be avoided in servers, as it's likely to cause performance issues and unintended command invocations. The command prefix could also be an iterable of strings indicating that multiple checks for the prefix should be used and the first one to match will be the invocation prefix. You can get this prefix via :attr:`.Context.prefix`. To avoid confusion empty iterables are not allowed. .. note:: When passing multiple prefixes be careful to not pass a prefix that matches a longer prefix occurring later in the sequence. For example, if the command prefix is ``('!', '!?')`` the ``'!?'`` prefix will never be matched to any message as the previous one matches messages starting with ``!?``. This is especially important when passing an empty string, it should always be last as no prefix after it will be matched. case_insensitive: :class:`bool` Whether the commands should be case insensitive. Defaults to ``False``. This attribute does not carry over to groups. You must set it to every group if you require group commands to be case insensitive as well. description: :class:`str` The content prefixed into the default help message. help_command: Optional[:class:`.HelpCommand`] The help command implementation to use. This can be dynamically set at runtime. To remove the help command pass ``None``. For more information on implementing a help command, see :ref:`ext_commands_help_command`. owner_id: Optional[:class:`int`] The user ID that owns the bot. If this is not set and is then queried via :meth:`.is_owner` then it is fetched automatically using :meth:`~.Bot.application_info`. owner_ids: Optional[Collection[:class:`int`]] The user IDs that owns the bot. This is similar to :attr:`owner_id`. If this is not set and the application is team based, then it is fetched automatically using :meth:`~.Bot.application_info`. For performance reasons it is recommended to use a :class:`set` for the collection. You cannot set both ``owner_id`` and ``owner_ids``. .. versionadded:: 1.3 strip_after_prefix: :class:`bool` Whether to strip whitespace characters after encountering the command prefix. This allows for ``! hello`` and ``!hello`` to both work if the ``command_prefix`` is set to ``!``. Defaults to ``False``. .. versionadded:: 1.7 test_guilds: List[:class:`int`] The list of IDs of the guilds where you're going to test your application commands. Defaults to ``None``, which means global registration of commands across all guilds. .. versionadded:: 2.1 sync_commands: :class:`bool` Whether to enable automatic synchronization of application commands in your code. Defaults to ``True``, which means that commands in API are automatically synced with the commands in your code. .. versionadded:: 2.1 sync_commands_on_cog_unload: :class:`bool` Whether to sync the application commands on cog unload / reload. Defaults to ``True``. .. versionadded:: 2.1 sync_commands_debug: :class:`bool` Whether to always show sync debug logs (uses ``INFO`` log level if it's enabled, prints otherwise). If disabled, uses the default ``DEBUG`` log level which isn't shown unless the log level is changed manually. Useful for tracking the commands being registered in the API. Defaults to ``False``. .. versionadded:: 2.1 .. versionchanged:: 2.4 Changes the log level of corresponding messages from ``DEBUG`` to ``INFO`` or ``print``\\s them, instead of controlling whether they are enabled at all. reload: :class:`bool` Whether to enable automatic extension reloading on file modification for debugging. Whenever you save an extension with reloading enabled the file will be automatically reloaded for you so you do not have to reload the extension manually. Defaults to ``False`` .. versionadded:: 2.1 localization_provider: :class:`.LocalizationProtocol` An implementation of :class:`.LocalizationProtocol` to use for localization of application commands. If not provided, the default :class:`.LocalizationStore` implementation is used. .. versionadded:: 2.5 strict_localization: :class:`bool` Whether to raise an exception when localizations for a specific key couldn't be found. This is mainly useful for testing/debugging, consider disabling this eventually as missing localized names will automatically fall back to the default/base name without it. Only applicable if the ``localization_provider`` parameter is not provided. Defaults to ``False``. .. versionadded:: 2.5 """ pass class AutoShardedBot(BotBase, InteractionBotBase, disnake.AutoShardedClient): """This is similar to :class:`.Bot` except that it is inherited from :class:`disnake.AutoShardedClient` instead. """ pass class InteractionBot(InteractionBotBase, disnake.Client): """Represents a discord bot for application commands only. This class is a subclass of :class:`disnake.Client` and as a result anything that you can do with a :class:`disnake.Client` you can do with this bot. This class also subclasses InteractionBotBase to provide the functionality to manage application commands. Attributes ---------- owner_id: Optional[:class:`int`] The user ID that owns the bot. If this is not set and is then queried via :meth:`.is_owner` then it is fetched automatically using :meth:`~.Bot.application_info`. owner_ids: Optional[Collection[:class:`int`]] The user IDs that owns the bot. This is similar to :attr:`owner_id`. If this is not set and the application is team based, then it is fetched automatically using :meth:`~.Bot.application_info`. For performance reasons it is recommended to use a :class:`set` for the collection. You cannot set both ``owner_id`` and ``owner_ids``. test_guilds: List[:class:`int`] The list of IDs of the guilds where you're going to test your application commands. Defaults to ``None``, which means global registration of commands across all guilds. .. versionadded:: 2.1 sync_commands: :class:`bool` Whether to enable automatic synchronization of application commands in your code. Defaults to ``True``, which means that commands in API are automatically synced with the commands in your code. .. versionadded:: 2.1 sync_commands_on_cog_unload: :class:`bool` Whether to sync the application commands on cog unload / reload. Defaults to ``True``. .. versionadded:: 2.1 sync_commands_debug: :class:`bool` Whether to always show sync debug logs (uses ``INFO`` log level if it's enabled, prints otherwise). If disabled, uses the default ``DEBUG`` log level which isn't shown unless the log level is changed manually. Useful for tracking the commands being registered in the API. Defaults to ``False``. .. versionadded:: 2.1 .. versionchanged:: 2.4 Changes the log level of corresponding messages from ``DEBUG`` to ``INFO`` or ``print``\\s them, instead of controlling whether they are enabled at all. reload: :class:`bool` Whether to enable automatic extension reloading on file modification for debugging. Whenever you save an extension with reloading enabled the file will be automatically reloaded for you so you do not have to reload the extension manually. Defaults to ``False`` .. versionadded:: 2.1 localization_provider: :class:`.LocalizationProtocol` An implementation of :class:`.LocalizationProtocol` to use for localization of application commands. If not provided, the default :class:`.LocalizationStore` implementation is used. .. versionadded:: 2.5 strict_localization: :class:`bool` Whether to raise an exception when localizations for a specific key couldn't be found. This is mainly useful for testing/debugging, consider disabling this eventually as missing localized names will automatically fall back to the default/base name without it. Only applicable if the ``localization_provider`` parameter is not provided. Defaults to ``False``. .. versionadded:: 2.5 """ pass class AutoShardedInteractionBot(InteractionBotBase, disnake.AutoShardedClient): """This is similar to :class:`.InteractionBot` except that it is inherited from :class:`disnake.AutoShardedClient` instead. """ pass