# Erebus IRC bot - Author: Erebus Team
+# vim: fileencoding=utf-8
# help module
# This file is released into the public domain; see http://unlicense.org/
if parent.cfg.getboolean('erebus', 'nofakelag'):
lib.hook('help', needchan=False)(lib.help('[@<module>|<command>]', 'lists commands or describes a command', 'with @<module>, lists all commands in <module>')(help_nolag))
else:
- lib.hook(needchan=False)(lib.help("<command>", "describes a command")(help))
+ lib.hook('help', needchan=False)(lib.help("<command>", "describes a command", "see also: showcommands")(help))
return lib.modstart(parent, *args, **kwargs)
modstop = lib.modstop
return lines
def _genhelp(bot, user, chan, realtarget, *args):
- module = None
+ module = ''
minlevel = -1
maxlevel = 100
- filepath = bot.parent.cfg.get('help', 'path', default='./help/%d.txt')
+ filepath = bot.parent.cfg.get('help', 'path', default='./help/%(@)s%(#)d.txt')
for arg in args:
if arg.startswith("@"):
+ if "." in arg[1:]:
+ raise Exception('Module option must not contain "."')
module = arg[1:]
elif arg.startswith("#") and user.glevel >= lib.ADMIN:
minlevel = maxlevel = int(arg[1:])
+ elif arg.startswith("+"):
+ maxlevel = int(arg[1:])
+ elif arg.startswith("-"):
+ minlevel = int(arg[1:])
+ elif arg.startswith("./"):
+ if "./" in arg[1:]:
+ raise Exception('Filename option must not contain "./" except as the first two characters')
+ else:
+ filepath = os.path.join('help', arg[2:])
else:
- filepath = arg
- if minlevel != maxlevel:
- minlevel = maxlevel
+ raise Exception('Unknown option given to GENHELP: %s' % (arg))
for level in range(minlevel, maxlevel+1):
- if '%d' in filepath:
- filename = filepath % (level)
- else:
- filename = filepath
+ filename = filepath % {'#': level, '+': maxlevel, '-': minlevel, '@': module}
fo = open(filename, 'w')
lines = []
- for func in helps.itervalues():
- if module is not None and func.module != module:
+ for func in helps.values():
+ if module != '' and func.module != module:
continue
lines += _mkhelp(level, func)
for line in sorted(lines):
return True
@lib.hook(glevel=1, needchan=False)
-@lib.help("[@<module>] [#<level>] [file]", "generates help file", "arguments are all optional and may be specified in any order", "default file: ./help/<level>.txt", "config as: [help]", "path = ./help/%d.txt")
+@lib.help("[@<module>] [#<exact_level>] [+<max_level>] [-<min_level>] [./<filename>]", "generates help file", "arguments are all optional and may be specified in any order", "default file: ./<module><level>.txt, with module blank if not supplied. will always be under help/", "filename can also contain %(@)s, %(#)s, %(+)s, %(-)s", "for module, current (single) level, max and min level, respectively")
def genhelp(bot, user, chan, realtarget, *args):
try:
_genhelp(bot, user, chan, realtarget, *args)
def help_nolag(bot, user, chan, realtarget, *args):
if len(args) == 0: # list commands
lines = []
- for func in helps.itervalues():
+ for func in helps.values():
lines += _mkhelp(user, func)
for line in sorted(lines):
bot.slowmsg(user, str(line))
elif args[0].startswith("@"):
lines = []
mod = args[0][1:].lower()
- for func in helps.itervalues():
+ for func in helps.values():
if func.module == mod:
lines += _mkhelp(user, func)
for line in sorted(lines):