Limnoria/plugins/Plugin/plugin.py

64 lines
2.5 KiB
Python
Raw Normal View History

2005-02-09 08:07:11 +01:00
###
# Copyright (c) 2005, Jeremiah Fincher
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
import supybot.utils as utils
from supybot.commands import *
import supybot.plugins as plugins
import supybot.ircutils as ircutils
import supybot.callbacks as callbacks
class Plugin(callbacks.Plugin):
"""Add the help for "@help Plugin" here
This should describe *how* to use this plugin."""
def help(self, irc, msg, args, cb):
"""<plugin>
Returns a useful description of how to use <plugin>, if the plugin has
one.
"""
if hasattr(cb, '__doc__') and cb.__doc__:
irc.reply(utils.str.normalizeWhitespace(cb.__doc__))
else:
irc.reply('That plugin is loaded, but has no plugin help.')
help = wrap(help, ['plugin'])
def list(self, irc, msg, args):
"""takes no arguments
Returns a list of the currently loaded plugins.
"""
L = [cb.name() for cb in irc.callbacks]
L.sort()
irc.reply(format('%L', L))
Class = Plugin
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: