"""
The MIT License (MIT)
Copyright (c) 2015-2021 Rapptz
Copyright (c) 2021-present Pycord 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 abc import ABC
from collections.abc import Iterator
from discord.commands import ApplicationContext
from discord.errors import CheckFailure, DiscordException
from discord.interactions import Interaction
from discord.message import Message
from ..commands import AutoShardedBot as ExtAutoShardedBot
from ..commands import Bot as ExtBot
from ..commands import Context as ExtContext
from ..commands import errors
from .context import BridgeApplicationContext, BridgeExtContext
from .core import (
BridgeCommand,
BridgeCommandGroup,
BridgeExtCommand,
BridgeSlashCommand,
bridge_command,
bridge_group,
)
__all__ = ("Bot", "AutoShardedBot")
class BotBase(ABC):
_bridge_commands: list[BridgeCommand | BridgeCommandGroup]
@property
def bridge_commands(self) -> list[BridgeCommand | BridgeCommandGroup]:
"""Returns all of the bot's bridge commands."""
if not (cmds := getattr(self, "_bridge_commands", None)):
self._bridge_commands = cmds = []
return cmds
def walk_bridge_commands(
self,
) -> Iterator[BridgeCommand | BridgeCommandGroup]:
"""An iterator that recursively walks through all the bot's bridge commands.
Yields
------
Union[:class:`.BridgeCommand`, :class:`.BridgeCommandGroup`]
A bridge command or bridge group of the bot.
"""
for cmd in self._bridge_commands:
yield cmd
if isinstance(cmd, BridgeCommandGroup):
yield from cmd.walk_commands()
async def get_application_context(
self, interaction: Interaction, cls=None
) -> BridgeApplicationContext:
cls = cls if cls is not None else BridgeApplicationContext
# Ignore the type hinting error here. BridgeApplicationContext is a subclass of ApplicationContext, and since
# we gave it cls, it will be used instead.
return await super().get_application_context(interaction, cls=cls) # type: ignore
async def get_context(self, message: Message, cls=None) -> BridgeExtContext:
cls = cls if cls is not None else BridgeExtContext
# Ignore the type hinting error here. BridgeExtContext is a subclass of Context, and since we gave it cls, it
# will be used instead.
return await super().get_context(message, cls=cls) # type: ignore
def add_bridge_command(self, command: BridgeCommand):
"""Takes a :class:`.BridgeCommand` and adds both a slash and traditional (prefix-based) version of the command
to the bot.
"""
# Ignore the type hinting error here. All subclasses of BotBase pass the type checks.
command.add_to(self) # type: ignore
self.bridge_commands.append(command)
def bridge_command(self, **kwargs):
"""A shortcut decorator that invokes :func:`bridge_command` and adds it to
the internal command list via :meth:`~.Bot.add_bridge_command`.
Returns
-------
Callable[..., :class:`BridgeCommand`]
A decorator that converts the provided method into an :class:`.BridgeCommand`, adds both a slash and
traditional (prefix-based) version of the command to the bot, and returns the :class:`.BridgeCommand`.
"""
def decorator(func) -> BridgeCommand:
result = bridge_command(**kwargs)(func)
self.add_bridge_command(result)
return result
return decorator
def bridge_group(self, **kwargs):
"""A decorator that is used to wrap a function as a bridge command group.
Parameters
----------
kwargs: Optional[Dict[:class:`str`, Any]]
Keyword arguments that are directly passed to the respective command constructors. (:class:`.SlashCommandGroup` and :class:`.ext.commands.Group`)
"""
def decorator(func) -> BridgeCommandGroup:
result = bridge_group(**kwargs)(func)
self.add_bridge_command(result)
return result
return decorator
async def invoke(self, ctx: ExtContext | BridgeExtContext):
if ctx.command is not None:
self.dispatch("command", ctx)
if isinstance(ctx.command, BridgeExtCommand):
self.dispatch("bridge_command", ctx)
try:
if await self.can_run(ctx, call_once=True):
await ctx.command.invoke(ctx)
else:
raise errors.CheckFailure("The global check once functions failed.")
except errors.CommandError as exc:
await ctx.command.dispatch_error(ctx, exc)
else:
self.dispatch("command_completion", ctx)
if isinstance(ctx.command, BridgeExtCommand):
self.dispatch("bridge_command_completion", ctx)
elif ctx.invoked_with:
exc = errors.CommandNotFound(f'Command "{ctx.invoked_with}" is not found')
self.dispatch("command_error", ctx, exc)
if isinstance(ctx.command, BridgeExtCommand):
self.dispatch("bridge_command_error", ctx, exc)
async def invoke_application_command(
self, ctx: ApplicationContext | BridgeApplicationContext
) -> None:
"""|coro|
Invokes the application command given under the invocation
context and handles all the internal event dispatch mechanisms.
Parameters
----------
ctx: :class:`.ApplicationCommand`
The invocation context to invoke.
"""
self._bot.dispatch("application_command", ctx)
if br_cmd := isinstance(ctx.command, BridgeSlashCommand):
self._bot.dispatch("bridge_command", ctx)
try:
if await self._bot.can_run(ctx, call_once=True):
await ctx.command.invoke(ctx)
else:
raise CheckFailure("The global check once functions failed.")
except DiscordException as exc:
await ctx.command.dispatch_error(ctx, exc)
else:
self._bot.dispatch("application_command_completion", ctx)
if br_cmd:
self._bot.dispatch("bridge_command_completion", ctx)
[docs]class Bot(BotBase, ExtBot):
"""Represents a discord bot, with support for cross-compatibility between command types.
This class is a subclass of :class:`.ext.commands.Bot` and as a result
anything that you can do with a :class:`.ext.commands.Bot` you can do with
this bot.
.. versionadded:: 2.0
"""
[docs]class AutoShardedBot(BotBase, ExtAutoShardedBot):
"""This is similar to :class:`.Bot` except that it is inherited from
:class:`.ext.commands.AutoShardedBot` instead.
.. versionadded:: 2.0
"""