Help.py

from twisted.plugin import IPlugin
from desertbot.moduleinterface import IModule
from desertbot.modules.commandinterface import BotCommand
from zope.interface import implementer

from desertbot.message import IRCMessage
from desertbot.response import IRCResponse, ResponseType


@implementer(IPlugin, IModule)
class Help(BotCommand):
    def triggers(self):
        return['help', 'module', 'modules']

    def help(self, query):
        return ('help/module(s) (<module>) - returns a list of loaded modules,'
                ' or the help text of a particular module if one is specified')

    def execute(self, message: IRCMessage):
        moduleHandler = self.bot.moduleHandler

        if message.parameterList:
            helpStr = moduleHandler.runActionUntilValue('help', message.parameterList)
            if isinstance(helpStr, str):
                return IRCResponse(ResponseType.Say, helpStr, message.replyTo)
            elif isinstance(helpStr, list):
                return [IRCResponse(ResponseType.Say, line, message.replyTo) for line in helpStr]
            else:
                return IRCResponse(ResponseType.Say,
                                   '"{0}" not found, try "{1}" without parameters'
                                   ' to see a list of loaded module names'
                                   .format(message.parameterList[0], message.command),
                                   message.replyTo)
        else:
            modules = ', '.join(sorted(moduleHandler.modules, key=lambda s: s.lower()))
            return [IRCResponse(ResponseType.Say,
                                "Modules loaded are"
                                " (use 'help <module>' to get help for that module):",
                                message.replyTo),
                    IRCResponse(ResponseType.Say,
                                modules,
                                message.replyTo)]


help = Help()