gozerbot.plughelp

help about plugins.

class gozerbot.plughelp.PlugHelp

Bases: dict

dict holding plugins help string.

add(item, descr)

add plugin help string.

get(item)

get plugin help string.

CODE

# gozerbot/plughelp.py
#
#

"""
   help about plugins.

"""

__status__ = "ok"

PlugHelp class

class PlugHelp(dict):

    """ dict holding plugins help string. """

    def add(self, item, descr):
        """ add plugin help string. """
        item = item.lower()
        self[item] = descr

    def get(self, item):
        """ get plugin help string. """
        item = item.lower()
        try: return self[item]
        except KeyError: return None
#
# defines

plughelp = PlugHelp()