summaryrefslogtreecommitdiff
path: root/wsgitools/middlewares.py
diff options
context:
space:
mode:
authorHelmut Grohne <helmut@subdivi.de>2008-09-09 18:57:17 +0200
committerHelmut Grohne <helmut@subdivi.de>2008-09-09 18:57:17 +0200
commit8d739dfd35ec93587c0dbc7da99f62af9e897851 (patch)
tree786b8b64ff649b510904005af827af0ec8d8ca6e /wsgitools/middlewares.py
parentcded5172465b7bcd8bb2d013a856a898303c4b6b (diff)
downloadwsgitools-8d739dfd35ec93587c0dbc7da99f62af9e897851.tar.gz
update BasicAuthMiddleware docs to reflect api change
Diffstat (limited to 'wsgitools/middlewares.py')
-rw-r--r--wsgitools/middlewares.py7
1 files changed, 4 insertions, 3 deletions
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