--- a/iro/model/user.py Thu Mar 29 17:33:10 2012 +0200
+++ b/iro/model/user.py Thu Mar 29 18:27:15 2012 +0200
@@ -12,6 +12,13 @@
@validate(kwd="apikey", func=vHash, minlength=15, maxlength=15)
@dbdefer
def getuser(session, apikey):
+ """Returns a valid user object.
+
+ :param session: a valid session object (is created by decorator :func:`iro.model.dbdefer.dbdefer`)
+ :param string apikey: a vaild apikey (only [0-9a-f] is allowed)
+ :return: a :class:`iro.model.schema.User` object
+ :raises: :exc:`iro.error.UserNotFound`
+ """
user = session.query(User).filter_by(apikey=apikey).first()
if user is None:
raise UserNotFound()
@@ -20,6 +27,12 @@
@decorator
def vUser(f,*args,**kargs):
+ """A Decorator to verify the apikey and execute the function with a valid :class:`iro.model.schema.User` instead of the apikey.
+
+ The decorator expect the apikey in the **user** parameter.
+
+ :return: a defer
+ """
kp=getcallargs(f,*args,**kargs)
try:
apikey = kp["user"]