ec6b1997ad
Cogs are basically class instances that have commands and event listeners. They allow for better organisation and grouping of commands and state. Similar to subclassing discord.Client.
441 lines
13 KiB
Python
441 lines
13 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-2016 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 asyncio
|
|
import discord
|
|
import inspect
|
|
|
|
from .core import GroupMixin, Command
|
|
from .view import StringView
|
|
from .context import Context
|
|
from .errors import CommandNotFound
|
|
|
|
def when_mentioned(bot, msg):
|
|
"""A callable that implements a command prefix equivalent
|
|
to being mentioned, e.g. ``@bot ``."""
|
|
return '{0.user.mention} '.format(bot)
|
|
|
|
class Bot(GroupMixin, discord.Client):
|
|
"""Represents a discord bot.
|
|
|
|
This class is a subclass of :class:`discord.Client` and as a result
|
|
anything that you can do with a :class:`discord.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:`discord.Message` as its second
|
|
parameter and returns the prefix. This is to facilitate "dynamic"
|
|
command prefixes.
|
|
|
|
The command prefix could also be a list or a tuple 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`.
|
|
"""
|
|
def __init__(self, command_prefix, **options):
|
|
super().__init__(**options)
|
|
self.command_prefix = command_prefix
|
|
self.extra_events = {}
|
|
self.cogs = {}
|
|
|
|
# internal helpers
|
|
|
|
def _get_variable(self, name):
|
|
stack = inspect.stack()
|
|
for frames in stack:
|
|
current_locals = frames[0].f_locals
|
|
if name in current_locals:
|
|
return current_locals[name]
|
|
|
|
def _get_prefix(self, message):
|
|
prefix = self.command_prefix
|
|
if callable(prefix):
|
|
return prefix(self, message)
|
|
else:
|
|
return prefix
|
|
|
|
@asyncio.coroutine
|
|
def _run_extra(self, coro, event_name, *args, **kwargs):
|
|
try:
|
|
yield from coro(*args, **kwargs)
|
|
except asyncio.CancelledError:
|
|
pass
|
|
except Exception:
|
|
try:
|
|
yield from self.on_error(event_name, *args, **kwargs)
|
|
except asyncio.CancelledError:
|
|
pass
|
|
|
|
def dispatch(self, event_name, *args, **kwargs):
|
|
super().dispatch(event_name, *args, **kwargs)
|
|
ev = 'on_' + event_name
|
|
if ev in self.extra_events:
|
|
for event in self.extra_events[ev]:
|
|
coro = self._run_extra(event, event_name, *args, **kwargs)
|
|
discord.utils.create_task(coro, loop=self.loop)
|
|
|
|
# utility "send_*" functions
|
|
|
|
@asyncio.coroutine
|
|
def say(self, content):
|
|
"""|coro|
|
|
|
|
A helper function that is equivalent to doing
|
|
|
|
.. code-block:: python
|
|
|
|
self.send_message(message.channel, content)
|
|
|
|
Parameters
|
|
----------
|
|
content : str
|
|
The content to pass to :class:`Client.send_message`
|
|
"""
|
|
destination = self._get_variable('_internal_channel')
|
|
result = yield from self.send_message(destination, content)
|
|
return result
|
|
|
|
@asyncio.coroutine
|
|
def whisper(self, content):
|
|
"""|coro|
|
|
|
|
A helper function that is equivalent to doing
|
|
|
|
.. code-block:: python
|
|
|
|
self.send_message(message.author, content)
|
|
|
|
Parameters
|
|
----------
|
|
content : str
|
|
The content to pass to :class:`Client.send_message`
|
|
"""
|
|
destination = self._get_variable('_internal_author')
|
|
result = yield from self.send_message(destination, content)
|
|
return result
|
|
|
|
@asyncio.coroutine
|
|
def reply(self, content):
|
|
"""|coro|
|
|
|
|
A helper function that is equivalent to doing
|
|
|
|
.. code-block:: python
|
|
|
|
msg = '{0.mention}, {1}'.format(message.author, content)
|
|
self.send_message(message.channel, msg)
|
|
|
|
Parameters
|
|
----------
|
|
content : str
|
|
The content to pass to :class:`Client.send_message`
|
|
"""
|
|
author = self._get_variable('_internal_author')
|
|
destination = self._get_variable('_internal_channel')
|
|
fmt = '{0.mention}, {1}'.format(author, str(content))
|
|
result = yield from self.send_message(destination, fmt)
|
|
return result
|
|
|
|
@asyncio.coroutine
|
|
def upload(self, fp, name=None):
|
|
"""|coro|
|
|
|
|
A helper function that is equivalent to doing
|
|
|
|
.. code-block:: python
|
|
|
|
self.send_file(message.channel, fp, name)
|
|
|
|
Parameters
|
|
----------
|
|
fp
|
|
The first parameter to pass to :meth:`Client.send_file`
|
|
name
|
|
The second parameter to pass to :meth:`Client.send_file`
|
|
"""
|
|
destination = self._get_variable('_internal_channel')
|
|
result = yield from self.send_file(destination, fp, name)
|
|
return result
|
|
|
|
@asyncio.coroutine
|
|
def type(self):
|
|
"""|coro|
|
|
|
|
A helper function that is equivalent to doing
|
|
|
|
.. code-block:: python
|
|
|
|
self.send_typing(message.channel)
|
|
|
|
See Also
|
|
---------
|
|
The :meth:`Client.send_typing` function.
|
|
"""
|
|
destination = self._get_variable('_internal_channel')
|
|
yield from self.send_typing(destination)
|
|
|
|
# listener registration
|
|
|
|
def add_listener(self, func, name=None):
|
|
"""The non decorator alternative to :meth:`listen`.
|
|
|
|
Parameters
|
|
-----------
|
|
func : coroutine
|
|
The extra event to listen to.
|
|
name : Optional[str]
|
|
The name of the command to use. Defaults to ``func.__name__``.
|
|
|
|
Examples
|
|
---------
|
|
|
|
.. code-block:: python
|
|
|
|
async def on_ready(): pass
|
|
async def my_message(message): pass
|
|
|
|
bot.add_listener(on_ready)
|
|
bot.add_listener(my_message, 'on_message')
|
|
|
|
"""
|
|
name = func.__name__ if name is None else name
|
|
|
|
if not asyncio.iscoroutinefunction(func):
|
|
raise discord.ClientException('Listeners must be coroutines')
|
|
|
|
if name in self.extra_events:
|
|
self.extra_events[name].append(func)
|
|
else:
|
|
self.extra_events[name] = [func]
|
|
|
|
def remove_listener(self, func, name=None):
|
|
"""Removes a listener from the pool of listeners.
|
|
|
|
Parameters
|
|
-----------
|
|
func
|
|
The function that was used as a listener to remove.
|
|
name
|
|
The name of the event we want to remove. Defaults to
|
|
``func.__name__``.
|
|
"""
|
|
|
|
name = func.__name__ if name is None else name
|
|
|
|
if name in self.extra_events:
|
|
try:
|
|
self.extra_events[name].remove(func)
|
|
except ValueError:
|
|
pass
|
|
|
|
|
|
def listen(self, name=None):
|
|
"""A decorator that registers another function as an external
|
|
event listener. Basically this allows you to listen to multiple
|
|
events from different places e.g. such as :func:`discord.on_ready`
|
|
|
|
The functions being listened to must be a coroutine.
|
|
|
|
Examples
|
|
---------
|
|
|
|
.. code-block:: python
|
|
|
|
@bot.listen
|
|
async def on_message(message):
|
|
print('one')
|
|
|
|
# in some other file...
|
|
|
|
@bot.listen('on_message')
|
|
async def my_message(message):
|
|
print('two')
|
|
|
|
Would print one and two in an unspecified order.
|
|
|
|
Raises
|
|
-------
|
|
discord.ClientException
|
|
The function being listened to is not a coroutine.
|
|
"""
|
|
|
|
def decorator(func):
|
|
self.add_listener(func, name)
|
|
return func
|
|
|
|
return decorator
|
|
|
|
# cogs
|
|
|
|
def add_cog(self, cog):
|
|
"""Adds a "cog" to the bot.
|
|
|
|
A cog is a class that has its own event listeners and commands.
|
|
|
|
They are meant as a way to organize multiple relevant commands
|
|
into a singular class that shares some state or no state at all.
|
|
|
|
More information will be documented soon.
|
|
|
|
Parameters
|
|
-----------
|
|
cog
|
|
The cog to register to the bot.
|
|
"""
|
|
|
|
self.cogs[type(cog).__name__] = cog
|
|
members = inspect.getmembers(cog)
|
|
for name, member in members:
|
|
# register commands the cog has
|
|
if isinstance(member, Command):
|
|
member.instance = cog
|
|
if member.parent is None:
|
|
self.add_command(member)
|
|
continue
|
|
|
|
# register event listeners the cog has
|
|
if name.startswith('on_'):
|
|
self.add_listener(member)
|
|
|
|
def get_cog(self, name):
|
|
"""Gets the cog instance requested.
|
|
|
|
If the cog is not found, ``None`` is returned instead.
|
|
|
|
Parameters
|
|
-----------
|
|
name : str
|
|
The name of the cog you are requesting.
|
|
"""
|
|
return self.cogs.get(name)
|
|
|
|
def remove_cog(self, name):
|
|
"""Removes a cog the bot.
|
|
|
|
All registered commands and event listeners that the
|
|
cog has registered will be removed as well.
|
|
|
|
If no cog is found then ``None`` is returned, otherwise
|
|
the cog instance that is being removed is returned.
|
|
|
|
Parameters
|
|
-----------
|
|
name : str
|
|
The name of the cog to remove.
|
|
"""
|
|
|
|
cog = self.cogs.pop(name, None)
|
|
if cog is None:
|
|
return cog
|
|
|
|
members = inspect.getmembers(cog)
|
|
for name, member in members:
|
|
# remove commands the cog has
|
|
if isinstance(member, Command):
|
|
member.instance = None
|
|
if member.parent is None:
|
|
self.remove_command(member.name)
|
|
continue
|
|
|
|
# remove event listeners the cog has
|
|
if name.startswith('on_'):
|
|
self.remove_listener(member)
|
|
|
|
# command processing
|
|
|
|
@asyncio.coroutine
|
|
def process_commands(self, message):
|
|
"""|coro|
|
|
|
|
This function processes the commands that have been registered
|
|
to the bot and other groups. Without this coroutine, none of the
|
|
commands will be triggered.
|
|
|
|
By default, this coroutine is called inside the :func:`on_message`
|
|
event. If you choose to override the :func:`on_message` event, then
|
|
you should invoke this coroutine as well.
|
|
|
|
Warning
|
|
--------
|
|
This function is necessary for :meth:`say`, :meth:`whisper`,
|
|
:meth:`type`, :meth:`reply`, and :meth:`upload` to work due to the
|
|
way they are written.
|
|
|
|
Parameters
|
|
-----------
|
|
message : discord.Message
|
|
The message to process commands for.
|
|
"""
|
|
_internal_channel = message.channel
|
|
_internal_author = message.author
|
|
|
|
view = StringView(message.content)
|
|
if message.author == self.user:
|
|
return
|
|
|
|
prefix = self._get_prefix(message)
|
|
invoked_prefix = prefix
|
|
|
|
if not isinstance(prefix, (tuple, list)):
|
|
if not view.skip_string(prefix):
|
|
return
|
|
else:
|
|
invoked_prefix = discord.utils.find(view.skip_string, prefix)
|
|
if invoked_prefix is None:
|
|
return
|
|
|
|
|
|
invoker = view.get_word()
|
|
tmp = {
|
|
'bot': self,
|
|
'invoked_with': invoker,
|
|
'message': message,
|
|
'view': view,
|
|
'prefix': invoked_prefix
|
|
}
|
|
ctx = Context(**tmp)
|
|
del tmp
|
|
|
|
if invoker in self.commands:
|
|
command = self.commands[invoker]
|
|
ctx.command = command
|
|
yield from command.invoke(ctx)
|
|
else:
|
|
exc = CommandNotFound('Command "{}" is not found'.format(invoker))
|
|
self.dispatch('command_error', exc, ctx)
|
|
|
|
@asyncio.coroutine
|
|
def on_message(self, message):
|
|
yield from self.process_commands(message)
|