Changeset 1427

Timestamp:

11/07/06 15:43:06

Author:

fumanchu

Message:

Some tool buglets and docs.

Files:

• trunk/cherrypy/_cptools.py (modified) (4 diffs)
• trunk/cherrypy/lib/cptools.py (modified) (1 diff)
• trunk/cherrypy/lib/encoding.py (modified) (1 diff)
• trunk/cherrypy/lib/wsgiapp.py (modified) (2 diffs)

trunk/cherrypy/_cptools.py

@@ -4 +4 @@
-may only offer one if they choose):
-    
-
+
+
-        The arguments are straightforward and should be detailed within the
-        docstring.
@@ -14 +15 @@
-        decorated function's _cp_config attribute.
-    
-hooks: "hooks" are points in the CherryPy request-handling
-process which may hand off control to registered callbacks. The
-Request object possesses a "hooks" attribute (a HookMap) for
-manipulating this. If a tool exposes a "_setup" callable, it
-will be called once per Request (if the feature is "turned on"
-
+config:
+Hookpoints are places in the CherryPy request-handling process
+which may hand off control to registered callbacks. The Request
+object possesses a "hooks" attribute (a HookMap) for manipulating
+this. If a tool exposes a "_setup" callable, it will be called
+once per Request (if the feature is "turned on" 
-
-Tools may be implemented as any object with a namespace. The builtins
@@ -224 +225 @@
-        """Hook this tool into cherrypy.request."""
-        request = cherrypy.request
+        
-        # Guard against running this method twice.
-        if hasattr(request, 'xmlrpc'):
-            return
-        request.xmlrpc = True
+        
-        request.error_response = _xmlrpc.on_error
-        path_info = request.path_info
@@ -327 +330 @@
-
-default_toolbox = _d = Toolbox("tools")
-default_toolbox
+_d
-_d.proxy = Tool('before_request_body', cptools.proxy, priority=30)
-_d.response_headers = Tool('on_start_resource', cptools.response_headers)

trunk/cherrypy/lib/cptools.py

@@ -264 +264 @@
-        setattr(sa, k, v)
-    return sa.run()
+session_auth.__doc__ = """Session authentication hook.
+
+Any attribute of the SessionAuth class may be overridden via a keyword arg
+to this function:
+
+""" + "\n".join(["%s: %s" % (k, type(getattr(SessionAuth, k)).__name__)
+                 for k in dir(SessionAuth) if not k.startswith("__")])
-
-

trunk/cherrypy/lib/encoding.py

@@ -41 +41 @@
-            # value is a list: decode each element
-            decoded_params[key] = [v.decode(encoding) for v in value]
+        elif isinstance(value, unicode):
+            pass
-        else:
-            # value is a regular string: decode it

trunk/cherrypy/lib/wsgiapp.py

@@ -50 +50 @@
-
-def run(app, env=None):
-(WSGI) app and set response.body to its output
+given WSGI app and set response.body to its output.
-    try:
-
+.copy()
-        environ['SCRIPT_NAME'] = cherrypy.request.script_name
-        environ['PATH_INFO'] = cherrypy.request.path_info
@@ -64 +64 @@
-    response = app(environ, start_response)
-    try:
-response
+[x for x in response]
-    finally:
-        if hasattr(response, "close"):