This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository x2gobroker. commit db2e980ae22a93a8fa1dbed3483f111b199f25ea Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Fri Sep 14 13:01:33 2018 +0200 x2gobroker/basicauth.py: Add API documentation. --- x2gobroker/basicauth.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/x2gobroker/basicauth.py b/x2gobroker/basicauth.py index 0ed69b8..d48117b 100644 --- a/x2gobroker/basicauth.py +++ b/x2gobroker/basicauth.py @@ -16,10 +16,28 @@ # Free Software Foundation, Inc., # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. +"""\ +Module providing a function for handling BasicAuth request processing. + +""" + # modules import base64 def require_basic_auth(realm, validate_callback): + """\ + Handler for ``http(s)://`` BasisAuth processing. + + :param realm: authentication realm + :type realm: ``str`` + :param validate_callback: callback function for validating credentials + :type validate_callback: ``func`` + + :returns: authentication :func:`execute()` function (or ``False``) + :rtype: ``func`` or ``bool`` + + """ + def require_basic_auth_decorator(handler_class): def wrap_execute(handler_execute): def require_basic_auth(handler, kwargs): -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2gobroker.git