diff -r 31114e40178d -r 0a5eb5aac0be iro/model/offer.py --- a/iro/model/offer.py Thu Mar 29 13:46:37 2012 +0200 +++ b/iro/model/offer.py Thu Mar 29 16:27:40 2012 +0200 @@ -6,6 +6,17 @@ @dbdefer def extendProvider(session, user, typ, ps): + """extend and reduce the offer list to allowed routes for **user**. + + - extend the "default" to the default offerlist of the **user**. + - extend a Provider name to all routes of that provider. + + :param session: a valid session ( created by decorator :func:`iro.model.dbdefer.dbdefer`) + :param `iro.model.schema.User` user: a user object + :param string typ: typ of the message + :param ps: a list of strings or a string, each one offer name or provider name + :return: a extended an reduced offer list + """ user = session.merge(user) ret = [] if ps == "default" or ps == ["default"]: @@ -22,6 +33,10 @@ @dbdefer def loadOffers(session): + """loading Offers from database and configuration file and store them in :attr:`~iro.model.offer.offers` and :attr:`~iro.model.offer.providers`. + + :param session: a valid session ( created by decorator :func:`iro.model.dbdefer.dbdefer`) + """ offers.clear() providers.clear() for provider in ( s for s in configParser.sections() if not s in ["main",]): @@ -33,7 +48,11 @@ providers[provider]=p offers={} +"""A dict of all available offers -- key is the offer name""" + providers={} +"""A dict of all available providers -- key is the provider name""" + configParser.registerReload(loadOffers)