Changeset 1420

Timestamp:

10/28/06 21:45:36

Author:

fumanchu

Message:

Better support for custom toolboxes and namespaces:

1. Each Toolbox is now its own config namespace handler, and self-registers as such.
   
2. The global, app, and request contexts now each allow (but do not force) config namespace handlers to be PEP 343-style context managers, with __enter__ and __exit__ methods.
   
3. Each Toolbox and Tool has a new "namespace" attribute. Each Tool automatically inherits the namespace attribute of its Toolbox when attached.
   
4. Request.toolmap has been replaced with "toolmaps", a dict of toolmap dicts.
   
5. Request.configure was reduced to a one-liner and has therefore been removed.
   

Custom Toolbox usage is now a one-liner, e.g.: mytools = cherrypy._cptools.Toolbox("mine"), where "mine" will be the name of the new (request-scoped) config namespace.

Files:

• trunk/cherrypy/__init__.py (modified) (3 diffs)
• trunk/cherrypy/_cpconfig.py (modified) (3 diffs)
• trunk/cherrypy/_cprequest.py (modified) (5 diffs)
• trunk/cherrypy/_cptools.py (modified) (9 diffs)
• trunk/cherrypy/_cptree.py (modified) (1 diff)
• trunk/cherrypy/test/test_tools.py (modified) (2 diffs)

trunk/cherrypy/__init__.py

@@ -9 +9 @@
-from cherrypy._cperror import HTTPError, HTTPRedirect, InternalRedirect, NotFound, CherryPyException
-from cherrypy._cperror import TimeoutError
+
+from cherrypy import _cprequest
+from cherrypy import _cpengine
+engine = _cpengine.Engine()
-
-from cherrypy import _cptools
@@ -18 +22 @@
-from cherrypy._cptree import Application
-from cherrypy import _cpwsgi as wsgi
-from cherrypy import _cpengine
-engine = _cpengine.Engine()
-from cherrypy import _cpserver
-server = _cpserver.Server()
@@ -90 +92 @@
-#   throughout the entire life of the webserver, but will redirect
-#   to the "_serving" object)
-from cherrypy import _cprequest
-from cherrypy.lib import http as _http
-request = _ThreadLocalProxy('request',

trunk/cherrypy/_cpconfig.py

@@ -75 +75 @@
-cherrypy._cpconfig.environments[environment]. It only applies to the global
-config, and only when you use cherrypy.config.update.
+
+You can define your own namespaces to be called at the Global, Application,
+or Request level, by adding a named handler to cherrypy.config.namespaces,
+app.namespaces, or cherrypy.engine.request_class.namespaces. The name can
+be any string, and the handler must be either a callable or a context
+manager.
-"""
-
@@ -126 +132 @@
-
-
+def _call_namespaces(config, namespaces):
+    """Iterate through config and pass it to each namespace.
+    
+    'config' should be a flat dict, where keys use dots to separate
+    namespaces, and values are arbitrary.
+    'namespaces' should be a dict whose keys are strings and whose
+    values are namespace handlers.
+    
+    The first name in each config key is used to look up the corresponding
+    namespace handler. For example, a config entry of {'tools.gzip.on': v}
+    will call the 'tools' namespace handler with the args: ('gzip.on', v)
+    
+    Each handler may be a bare callable, or it may be a context manager
+    with __enter__ and __exit__ methods, in which case the __enter__
+    method should return the callable.
+    """
+    # Separate the given config into namespaces
+    ns_confs = {}
+    for k in config:
+        if "." in k:
+            ns, name = k.split(".", 1)
+            bucket = ns_confs.setdefault(ns, {})
+            bucket[name] = config[k]
+    
+    # I chose __enter__ and __exit__ so someday this could be
+    # rewritten using Python 2.5's 'with' statement:
+    # for ns, handler in namespaces.iteritems():
+    #     with handler as callable:
+    #         for k, v in ns_confs.get(ns, {}).iteritems():
+    #             callable(k, v)
+    for ns, handler in namespaces.iteritems():
+        exit = getattr(handler, "__exit__", None)
+        if exit:
+            callable = handler.__enter__()
+            no_exc = True
+            try:
+                try:
+                    for k, v in ns_confs.get(ns, {}).iteritems():
+                        callable(k, v)
+                except:
+                    # The exceptional case is handled here
+                    no_exc = False
+                    if exit is None:
+                        raise
+                    if not exit(*sys.exc_info()):
+                        raise
+                    # The exception is swallowed if exit() returns true
+            finally:
+                # The normal and non-local-goto cases are handled here
+                if no_exc and exit:
+                    exit(None, None, None)
+        else:
+            for k, v in ns_confs.get(ns, {}).iteritems():
+                handler(k, v)
+
+
-class Config(dict):
-    """The 'global' configuration data for the entire CherryPy process."""
@@ -173 +235 @@
-            config['tools.staticdir.section'] = "global"
-        
-
-
-
+
+
-    
-    def __setitem__(self, k, v):
-        dict.__setitem__(self, k, v)
-
-
-
-
-
-
+
-
-

trunk/cherrypy/_cprequest.py

@@ -101 +101 @@
-
-# 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):
@@ -172 +167 @@
-    app = None
-    handler = None
-
+s
-    config = None
-    recursive_redirect = False
@@ -184 +179 @@
-    throw_errors = False
-    
-
-
+
-                  "request": request_namespace,
-                  "response": response_namespace,
@@ -351 +345 @@
-                    self.hooks = self.__class__.hooks.copy()
-                    self.get_resource(path_info)
-self.configure(
+cherrypy._cpconfig._call_namespaces(self.config, self.namespaces
-                    
-                    self.hooks.run('on_start_resource')
@@ -455 +449 @@
-        dispatch(path)
-    
-    def configure(self):
-        """Process self.config, populate self.toolmap and set up each tool."""
-        self.toolmap = tm = {}
-        
-        # Process config namespaces (including tools.*)
-        reqconf = self.config
-        for k in reqconf:
-            atoms = k.split(".", 1)
-            namespace = atoms[0]
-            if namespace in self.namespaces:
-                self.namespaces[namespace](atoms[1], reqconf[k])
-        
-        # Run tool._setup(conf) for each tool in the new toolmap.
-        tools = cherrypy.tools
-        for toolname in tm:
-            if tm[toolname].get("on", False):
-                tool = getattr(tools, toolname)
-                tool._setup()
-    
-    def process_body(self):
-        """Convert request.rfile into request.params (or request.body)."""

trunk/cherrypy/_cptools.py

@@ -33 +33 @@
-    help(tool.callable) should give you more information about this Tool.
-    """
+    
+    namespace = "tools"
-    
-    def __init__(self, point, callable, name=None, priority=50):
@@ -52 +54 @@
-    
-    def _merged_args(self, d=None):
-
+s[self.namespace]
-        if self._name in tm:
-            conf = tm[self._name].copy()
@@ -77 +79 @@
-                            "arguments; you must use keyword arguments."
-                            % self._name)
-wrappe
+tool_decorato
-            if not hasattr(f, "_cp_config"):
-                f._cp_config = {}
-
+
+
-            for k, v in kwargs.iteritems():
-"tools." + self._name + "."
+subspace
-            return f
-wrappe
+tool_decorato
-    
-    def _setup(self):
@@ -116 +119 @@
-                                              root=absDir)
-        """
-wrapper
+handle_func
-            handled = self.callable(*args, **self._merged_args(kwargs))
-            if not handled:
-                raise cherrypy.NotFound()
-            return cherrypy.response.body
-wrapper
-wrapper
+handle_func
+handle_func
-    
-    def _wrapper(self, **kwargs):
@@ -181 +184 @@
-class XMLRPCController(object):
-    
+    # Note we're hard-coding this into the 'tools' namespace. We could do
+    # a huge amount of work to make it relocatable, but the only reason why
+    # would be if someone actually disabled the default_toolbox. Meh.
-    _cp_config = {'tools.xmlrpc.on': True}
-    
@@ -192 +198 @@
-        if subhandler and getattr(subhandler, "exposed", False):
-            body = subhandler(*(vpath + rpcparams), **params)
-
+
-        else:
-            # http://www.cherrypy.org/ticket/533
@@ -199 +205 @@
-            # cherrypy.lib.xmlrpc.on_error
-            raise Exception, 'method "%s" is not supported' % attr
-    
-
+
+s['tools']
-        _xmlrpc.respond(body,
-                        conf.get('encoding', 'utf-8'),
@@ -284 +290 @@
-
-class Toolbox(object):
-
+
+
+
+
+
+
+
+
-    
-    def __setattr__(self, name, value):
@@ -291 +304 @@
-            if value._name is None:
-                value._name = name
+            value.namespace = self.namespace
-        object.__setattr__(self, name, value)
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-default_toolbox.session_auth = SessionAuthTool(cptools.session_auth)
-_d.proxy = Tool('before_request_body', cptools.proxy, priority=30)

trunk/cherrypy/_cptree.py

@@ -48 +48 @@
-        
-        # Handle namespaces specified in config.
-
-
-
-
-
-
+
-    
-    def wsgiapp(self, environ, start_response):

trunk/cherrypy/test/test_tools.py

@@ -15 +15 @@
-def setup_server():
-    
+    # Put check_access in a custom toolbox with its own namespace
+    myauthtools = cherrypy._cptools.Toolbox("myauth")
+    
-    def check_access():
-        if not getattr(cherrypy.request, "login", None):
-            raise cherrypy.HTTPError(401)
-
+myauth
-    
-    def numerify():
@@ -151 +154 @@
-        def restricted(self):
-            return "Welcome!"
-
+myauth
-        
-        def err_in_onstart(self):