TODO

[erebus.git] / modlib.py

diff --git a/modlib.py b/modlib.py
index e4686a2546aa1044018e4fa330562f2573f701f8..ee94e9ee38679a7dd928a89a9b69c1c40677645c 100644 (file)
--- a/modlib.py
+++ b/modlib.py
@@ -1,14 +1,17 @@
 # Erebus IRC bot - Author: John Runyon
+# vim: fileencoding=utf-8
 # module helper functions, see modules/modtest.py for usage
 # This file is released into the public domain; see http://unlicense.org/
 
 import sys
+from functools import wraps
 
 if sys.version_info.major < 3:
        stringbase = basestring
 else:
        stringbase = str
 
+"""Used to return an error to the bot core."""
 class error(object):
        def __init__(self, desc):
                self.errormsg = desc
@@ -26,9 +29,9 @@ class modlib(object):
        MANAGER =  99
        ADMIN   =  75
        STAFF   =  50
-       AUTHED  =   0
-       ANYONE  =  -1
-       IGNORED =  -2
+       AUTHED  =   0 # Users which have are known to be authed
+       ANYONE  =  -1 # non-authed users have glevel set to -1
+       IGNORED =  -2 # The default reqglevel is ANYONE, so any commands will be ignored from IGNORED users unless the command reglevel=-2
 
        # (channel) access levels
        COWNER  =   5
@@ -36,8 +39,8 @@ class modlib(object):
        OP      =   3
        VOICE   =   2
        KNOWN   =   1
-       PUBLIC  =   0 #anyone (use glevel to control auth-needed)
-       BANNED  =  -1
+       PUBLIC  =   0 # Anyone (use glevel to control whether auth is needed)
+       BANNED  =  -1 # The default reqclevel is PUBLIC, so any commands which needchan will be ignored from BANNED users unless the command reqclevel=-1
        #         [   0         1        2     3         4        5    -1]
        clevs   = [None, 'Friend', 'Voice', 'Op', 'Master', 'Owner', None]
 
@@ -118,6 +121,9 @@ class modlib(object):
                        if isinstance(cmd, stringbase):
                                cmd = (cmd,)
 
+                       if clevel > self.PUBLIC and not needchan:
+                               raise Exception('clevel must be left at default if needchan is False')
+
                        func.needchan = needchan
                        func.wantchan = wantchan
                        func.reqglevel = glevel
@@ -141,25 +147,23 @@ class modlib(object):
 
        def argsEQ(self, num):
                def realhook(func):
+                       @wraps(func)
                        def checkargs(bot, user, chan, realtarget, *args):
                                if len(args) == num:
                                        return func(bot, user, chan, realtarget, *args)
                                else:
                                        bot.msg(user, self.WRONGARGS)
-                       checkargs.__name__ = func.__name__
-                       checkargs.__module__ = func.__module__
                        return checkargs
                return realhook
 
        def argsGE(self, num):
                def realhook(func):
+                       @wraps(func)
                        def checkargs(bot, user, chan, realtarget, *args):
                                if len(args) >= num:
                                        return func(bot, user, chan, realtarget, *args)
                                else:
                                        bot.msg(user, self.WRONGARGS)
-                       checkargs.__name__ = func.__name__
-                       checkargs.__module__ = func.__module__
                        return checkargs
                return realhook