Changeset 1336

Timestamp:

09/05/06 17:54:42

Author:

fumanchu

Message:

Moved request.namespaces back to the class level (each instance gets a copy). Renamed "tool_up" to "configure". Also, request.handler should not set response.body anymore: it should return it to the caller instead (this allows custom namespaces to wrap the handler and munge output). Full demo in test_config.

Files:

• trunk/cherrypy/_cpconfig.py (modified) (1 diff)
• trunk/cherrypy/_cprequest.py (modified) (10 diffs)
• trunk/cherrypy/test/test_config.py (modified) (3 diffs)

trunk/cherrypy/_cpconfig.py

@@ -65 +65 @@
-    log:        Configures the logging for each application.
-                These can only be declared in the global or / config.
- during the tool_up phase
- during the tool_up phase
+
+
-    server:     Controls the default HTTP server via cherrypy.server.
-                These can only be declared in the global config.

trunk/cherrypy/_cprequest.py

@@ -99 +99 @@
-    
-    def __call__(self):
-cherrypy.response.body =
+return
-
-
@@ -228 +228 @@
-        pi = request.path_info
-        
-tool_up
+configure
-        if request.config.get("request.redirect_on_missing_slash",
-                              request.redirect_on_missing_slash):
@@ -243 +243 @@
-        pi = request.path_info
-        
-tool_up
+configure
-        if request.config.get("request.redirect_on_extra_slash",
-                              request.redirect_on_extra_slash):
@@ -294 +294 @@
-
-
+# Config namespace handlers
+def tools_namespace(k, v):
+    """Attach tools specified in config."""
+    toolname, arg = k.split(".", 1)
+    bucket = cherrypy.request.toolmap.setdefault(toolname, {})
+    bucket[arg] = v
+
+def hooks_namespace(k, v):
+    """Attach bare hooks declared in config."""
+    # Use split again to allow multiple hooks for a single
+    # hookpoint per path (e.g. "hooks.before_handler.1").
+    # Little-known fact you only get from reading source ;)
+    hookpoint = k.split(".", 1)[0]
+    if isinstance(v, basestring):
+        v = cherrypy.lib.attributes(v)
+    if not isinstance(v, Hook):
+        v = Hook(v)
+    cherrypy.request.hooks[hookpoint].append(v)
+
+def request_namespace(k, v):
+    """Attach request attributes declared in config."""
+    setattr(cherrypy.request, k, v)
+
+def response_namespace(k, v):
+    """Attach response attributes declared in config."""
+    setattr(cherrypy.response, k, v)
+
+def error_page_namespace(k, v):
+    """Attach error pages declared in config."""
+    cherrypy.request.error_page[int(k)] = v
+
+
-class Request(object):
-    """An HTTP request."""
@@ -346 +378 @@
-    throw_errors = False
-    
+    namespaces = {"tools": tools_namespace,
+                  "hooks": hooks_namespace,
+                  "request": request_namespace,
+                  "response": response_namespace,
+                  "error_page": error_page_namespace,
+                  }
-    
-    def __init__(self, local_host, remote_host, scheme="http",
@@ -366 +404 @@
-        self.error_page = self.error_page.copy()
-        
-
-
-
-
-
-
+
+
-    
-    def close(self):
@@ -500 +534 @@
-                    self.hooks = HookMap(self.hookpoints)
-                    self.get_resource(path_info)
-tool_up
+configure
-                    
-                    self.hooks.run('on_start_resource')
@@ -521 +555 @@
-                    self.hooks.run('before_handler')
-                    if self.handler:
-
+cherrypy.response.body = 
-                    self.hooks.run('before_finalize')
-                    cherrypy.response.finalize()
@@ -587 +621 @@
-        while trail:
-            nodeconf = self.app.config.get(trail, {})
+            
-            d = nodeconf.get("request.dispatch")
-            if d:
@@ -603 +638 @@
-        dispatch(path)
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-        """Process self.config, populate self.toolmap and set up each tool."""
-        # Get all 'tools.*' config entries as a {toolname: {k: v}} dict.
-        self.toolmap = tm = {}
+        
+        # Process config namespaces (including tools.*)
-        reqconf = self.config
-        for k in reqconf:

trunk/cherrypy/test/test_config.py

@@ -45 +45 @@
-        index.exposed = True
-    
+    
+    def raw_namespace(key, value):
+        if key == 'input.map':
+            params = cherrypy.request.params
+            for name, coercer in value.iteritems():
+                try:
+                    params[name] = coercer(params[name])
+                except KeyError:
+                    pass
+        elif key == 'output':
+            handler = cherrypy.request.handler
+            def wrapper():
+                return value(handler())
+            cherrypy.request.handler = wrapper
+    cherrypy.engine.request_class.namespaces['raw'] = raw_namespace
+    
+    class Raw:
+        
+        _cp_config = {'raw.output': repr}
+        
+        def incr(self, num):
+            return num + 1
+        incr.exposed = True
+        incr._cp_config = {'raw.input.map': {'num': int}}
+    
-    ioconf = StringIO.StringIO("""
-[/]
@@ -52 +77 @@
-    root = Root()
-    root.foo = Foo()
+    root.raw = Raw()
-    cherrypy.tree.mount(root, config=ioconf)
-    cherrypy.tree.mount(Another(), "/another")
@@ -106 +132 @@
-            self.getPage("/foo/bar?key=" + key)
-            self.assertBody(`expected`)
+    
+    def testCustomNamespaces(self):
+        self.getPage("/raw/incr?num=12")
+        self.assertBody("13")
-
-