From 183aa59e609138653ad8107552ce66c7a9e47405 Mon Sep 17 00:00:00 2001
From: Helmut Grohne <helmut@subdivi.de>
Date: Fri, 22 Jul 2011 20:47:46 +0200
Subject: BasicAuthMiddleware docstring: mention REMOTE_USER
---
wsgitools/middlewares.py | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
(limited to 'wsgitools')
diff --git a/wsgitools/middlewares.py b/wsgitools/middlewares.py
index 709304f..c3f2871 100644
--- a/wsgitools/middlewares.py
+++ b/wsgitools/middlewares.py
@@ -313,7 +313,9 @@ class DictAuthChecker:
__all__.append("BasicAuthMiddleware")
class BasicAuthMiddleware:
- """Middleware implementing HTTP Basic Auth."""
+ """Middleware implementing HTTP Basic Auth. Upon forwarding the request to
+ the warpped application the environ dictionary is augmented by a REMOTE_USER
+ key."""
def __init__(self, app, check_function, realm='www', app401=None):
"""
@param app: is a WSGI application.
--
cgit v1.2.3