"""
The MIT License (MIT)
Copyright (c) 2015-present Rapptz
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.
"""
import inspect
import asyncio
from typing import (TYPE_CHECKING, Union, Awaitable, Any, List, Dict, Iterable,
Optional)
from fortnitepy.typedefs import MaybeCoro
from ._types import _BaseCommand
from .context import Context
if TYPE_CHECKING:
from .bot import Bot
__all__ = (
'CogMeta',
'Cog',
)
[github]def _cog_special_method(func: MaybeCoro) -> MaybeCoro:
func.__cog_special_method__ = None
return func
[github][docs] class Cog(metaclass=CogMeta):
"""The base class that all cogs must inherit from.
A cog is a collection of commands, listeners, and optional state to
help group commands together. More information on them can be found on
the :ref:`ext_commands_cogs` page.
When inheriting from this class, the options shown in :class:`CogMeta`
are equally valid here.
"""
[github] def __new__(cls, *args: list, **kwargs: dict) -> None:
self = super().__new__(cls)
cmd_attrs = cls.__cog_settings__
self.__cog_commands__ = tuple(
c._update_copy(cmd_attrs) for c in cls.__cog_commands__
)
lookup = {
cmd.qualified_name: cmd for cmd in self.__cog_commands__
}
for command in self.__cog_commands__:
setattr(self, command.callback.__name__, command)
parent = command.parent
if parent is not None:
parent = lookup[parent.qualified_name]
parent.remove_command(command.name)
parent.add_command(command)
return self
[github][docs] def get_commands(self) -> List[_BaseCommand]:
r"""Returns a :class:`list` of :class:`.Command`\s that are
defined inside this cog.
.. note::
This does not include subcommands.
"""
return [c for c in self.__cog_commands__ if c.parent is None]
[github] @property
def qualified_name(self) -> str:
""":class:`str`: Returns the cog's specified name, not
the class name.
"""
return self.__cog_name__
[github] @property
def description(self) -> str:
""":class:`str`: Returns the cog's description, typically
the cleaned docstring.
"""
try:
return self.__cog_cleaned_doc__
except AttributeError:
self.__cog_cleaned_doc__ = inspect.getdoc(self)
return self.__cog_cleaned_doc__
[github][docs] def walk_commands(self) -> Iterable:
"""An iterator that recursively walks through this cog's
commands and subcommands.
"""
from .core import GroupMixin
for command in self.__cog_commands__:
if command.parent is None:
yield command
if isinstance(command, GroupMixin):
yield from command.walk_commands()
[github] @property
def event_handlers(self) -> Dict[str, Awaitable]:
""":class:`list`: A list of (name, function) event handler pairs
that are defined in this cog.
"""
return {
name: getattr(self, method_name)
for name, method_name, _
in self.__cog_event_handlers__
}
[github] @classmethod
def _get_overridden_method(cls, method: MaybeCoro) -> MaybeCoro:
"""Return None if the method is not overridden. Otherwise returns the
overridden method.
"""
return getattr(method.__func__, '__cog_special_method__', method)
[github][docs] @classmethod
def event(cls, event: Union[str, Awaitable[Any]] = None) -> Awaitable:
"""A decorator to register an event.
Usage: ::
@commands.Cog.event()
async def event_friend_message(message):
await message.reply('Thanks for your message!')
@commands.Cog.event('friend_message')
async def my_message_handler(message):
await message.reply('Thanks for your message!')
Raises
------
TypeError
The decorated function is not a coroutine.
TypeError
Event is not specified as argument or function name with event
prefix.
"""
is_coro = callable(event)
def pred(coro):
if isinstance(coro, staticmethod):
coro = coro.__func__
if not asyncio.iscoroutinefunction(coro):
raise TypeError('the decorated function must be a coroutine')
if is_coro or event is None:
name = coro.__name__
name_defined = False
else:
name = event
name_defined = True
coro.__cog_event_handler__ = True
try:
coro.__cog_event_handler_names__.append((name, name_defined))
except AttributeError:
coro.__cog_event_handler_names__ = [(name, name_defined)]
return coro
return pred(event) if is_coro else pred
[github] def _inject(self, bot: 'Bot') -> 'Cog':
cls = self.__class__
for index, command in enumerate(self.__cog_commands__):
command.cog = self
command.instance = bot
if command.parent is None:
try:
bot.add_command(command)
except Exception as e:
for to_undo in self.__cog_commands__[:index]:
bot.remove_command(to_undo)
raise e
if cls.bot_check is not Cog.bot_check:
bot.add_check(self.bot_check)
if cls.bot_check_once is not Cog.bot_check_once:
bot.add_check(self.bot_check_once, call_once=True)
# We need to do this to remove all prefixes of events registered
# with the coro's name instead of manually specifying the name.
new = []
for name, method, name_was_defined in self.__cog_event_handlers__:
if not name_was_defined:
if name.startswith(bot.event_prefix):
name = name[len(bot.event_prefix):]
new.append((name, method, name_was_defined))
self.__cog_event_handlers__ = new
for name, method_name, _ in self.__cog_event_handlers__:
bot.add_event_handler(name, getattr(self, method_name))
return self
[github] def _eject(self, bot: 'Bot') -> None:
cls = self.__class__
try:
for command in self.__cog_commands__:
if command.parent is None:
bot.remove_command(command.name)
for name, method_name, _ in self.__cog_event_handlers__:
bot.remove_event_handler(name, getattr(self, method_name))
if cls.bot_check is not Cog.bot_check:
bot.remove_check(self.bot_check)
if cls.bot_check_once is not Cog.bot_check_once:
bot.remove_check(self.bot_check_once, call_once=True)
finally:
self.cog_unload()
[github][docs] @_cog_special_method
def cog_unload(self) -> None:
"""A special method that is called when the cog gets removed.
This function **cannot** be a coroutine. It must be a regular
function.
Subclasses must replace this if they want special unloading behaviour.
"""
pass
[github][docs] @_cog_special_method
def bot_check_once(self, ctx: 'Context') -> bool:
"""A special method that registers as a :meth:`.Bot.check_once`
check.
This function **can** be a coroutine and must take a sole parameter,
``ctx``, to represent the :class:`.Context`.
"""
return True
[github][docs] @_cog_special_method
def bot_check(self, ctx: 'Context') -> bool:
"""A special method that registers as a :meth:`.Bot.check`
check.
This function **can** be a coroutine and must take a sole parameter,
``ctx``, to represent the :class:`.Context`.
"""
return True
[github][docs] @_cog_special_method
def cog_check(self, ctx: 'Context') -> bool:
"""A special method that registers as a :func:`commands.check`
for every command and subcommand in this cog.
This function **can** be a coroutine and must take a sole parameter,
``ctx``, to represent the :class:`.Context`.
"""
return True
[github][docs] @_cog_special_method
def cog_command_error(self, ctx: 'Context',
error: Exception) -> Optional[bool]:
"""A special method that is called whenever an error
is dispatched inside this cog.
This is similar to :func:`.event_command_error` except only applying
to the commands inside this cog.
Command error handlers are raised in a specific order. Returning
``False`` in any of them will invoke the next handler in the chain. If
there are no handlers left to call, the error is printed.
The order goes as follows:
1. The local command error handler is called. (Handler specified by
:meth:`.Command.check`)
2. The local cog command error handler is called. (This)
3. All :func:`.event_command_error()` handlers are called
simultaneously. If any of them return False, the error will
be printed.
This **must** be a coroutine.
Parameters
-----------
ctx: :class:`.Context`
The invocation context where the error happened.
error: :class:`CommandError`
The error that happened.
"""
return False
[github][docs] @_cog_special_method
async def cog_before_invoke(self, ctx: 'Context') -> None:
"""A special method that acts as a cog local pre-invoke hook.
This is similar to :meth:`.Command.before_invoke`.
This **must** be a coroutine.
Parameters
-----------
ctx: :class:`.Context`
The invocation context.
"""
pass
[github][docs] @_cog_special_method
async def cog_after_invoke(self, ctx: Context) -> None:
"""A special method that acts as a cog local post-invoke hook.
This is similar to :meth:`.Command.after_invoke`.
This **must** be a coroutine.
Parameters
-----------
ctx: :class:`.Context`
The invocation context.
"""
pass