Changeset 1960

Timestamp:

05/17/08 13:41:37

Author:

fumanchu

Message:

New HandlerWrapperTool?.

Files:

• trunk/cherrypy/_cptools.py (modified) (1 diff)
• trunk/cherrypy/test/test_tools.py (modified) (3 diffs)

trunk/cherrypy/_cptools.py

@@ -171 +171 @@
-        cherrypy.request.hooks.attach(self._point, self._wrapper,
-                                      priority=p, **conf)
+
+
+class HandlerWrapperTool(Tool):
+    """Tool which wraps request.handler in a provided wrapper function.
+    
+    The 'newhandler' arg must be a handler wrapper function that takes a
+    'next_handler' argument, plus *args and **kwargs. Like all page handler
+    functions, it must return an iterable for use as cherrypy.response.body.
+    
+    For example, to allow your 'inner' page handlers to return dicts
+    which then get interpolated into a template:
+    
+        def interpolator(next_handler, *args, **kwargs):
+            filename = cherrypy.request.config.get('template')
+            cherrypy.response.template = env.get_template(filename)
+            response_dict = next_handler(*args, **kwargs)
+            return cherrypy.response.template.render(**response_dict)
+        cherrypy.tools.jinja = HandlerWrapperTool(interpolator)
+    """
+    
+    def __init__(self, newhandler, point='before_handler', name=None, priority=50):
+        self.newhandler = newhandler
+        self._point = point
+        self._name = name
+        self._priority = priority
+    
+    def callable(self):
+        innerfunc = cherrypy.request.handler
+        def wrap(*args, **kwargs):
+            return self.newhandler(innerfunc, *args, **kwargs)
+        cherrypy.request.handler = wrap
-
-

trunk/cherrypy/test/test_tools.py

@@ -91 +91 @@
-    cherrypy.tools.rotator = cherrypy.Tool('before_finalize', Rotator())
-    
+    def stream_handler(next_handler, *args, **kwargs):
+        cherrypy.response.output = o = StringIO.StringIO()
+        try:
+            response = next_handler(*args, **kwargs)
+            # Ignore the response and return our accumulated output instead.
+            return o.getvalue()
+        finally:
+            o.close()
+    cherrypy.tools.streamer = cherrypy._cptools.HandlerWrapperTool(stream_handler)
+    
-    class Root:
-        def index(self):
-            return "Howdy earth!"
-        index.exposed = True
+        
+        def tarfile(self):
+            cherrypy.response.output.write('I am ')
+            cherrypy.response.output.write('a tarfile')
+        tarfile.exposed = True
+        tarfile._cp_config = {'tools.streamer.on': True}
-        
-        def euro(self):
@@ -207 +223 @@
-            'tools.gzip.priority': 10,
-        },
+        # Handler wrappers
+        '/tarfile': {'tools.streamer.on': True}
-    }
-    app = cherrypy.tree.mount(root, config=conf)
@@ -333 +351 @@
-                     method="POST", body=content)
-        self.assertBody(content)
+    
+    def testHandlerWrapperTool(self):
+        self.getPage("/tarfile")
+        self.assertBody("I am a tarfile")
-
-