From 8d739dfd35ec93587c0dbc7da99f62af9e897851 Mon Sep 17 00:00:00 2001
From: Helmut Grohne <helmut@subdivi.de>
Date: Tue, 9 Sep 2008 18:57:17 +0200
Subject: update BasicAuthMiddleware docs to reflect api change
---
wsgitools/middlewares.py | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
(limited to 'wsgitools')
diff --git a/wsgitools/middlewares.py b/wsgitools/middlewares.py
index 96c148e..57e5028 100644
--- a/wsgitools/middlewares.py
+++ b/wsgitools/middlewares.py
@@ -275,9 +275,10 @@ class BasicAuthMiddleware:
def __init__(self, app, check_function, realm='www'):
"""
@param app: is a WSGI application.
- @param check_function: is a function taking two arguments username and
- password returning a bool indicating whether the request may is
- allowed.
+ @param check_function: is a function taking three arguments username,
+ password and environment returning a bool indicating whether the
+ request may is allowed. The older interface of taking only the
+ first two arguments is still supported via catching a TypeError.
@type realm: str
"""
self.app = app
--
cgit v1.2.3