Changeset 1574

Timestamp:

12/28/06 14:34:24

Author:

fumanchu

Message:

Moved checker back to cherrypy.checker from engine, and also added a new check_config_types method. There's also a new checker config namespace, so you can turn off the checker with "checker.on = False", or turn off specific methods with "checker.check_method_foo = None".

Files:

• trunk/cherrypy/__init__.py (modified) (1 diff)
• trunk/cherrypy/_cpchecker.py (modified) (8 diffs)
• trunk/cherrypy/_cpconfig.py (modified) (6 diffs)
• trunk/cherrypy/_cpengine.py (modified) (3 diffs)
• trunk/cherrypy/test/checkerdemo.py (modified) (1 diff)

trunk/cherrypy/__init__.py

@@ -270 +270 @@
-# without shadowing cherrypy.config.
-config = _global_conf_alias = _cpconfig.Config()
+
+from cherrypy import _cpchecker
+checker = _cpchecker.Checker()

trunk/cherrypy/_cpchecker.py

@@ -7 +7 @@
-class Checker(object):
-    
-
+
+
+
+
-    
-    def __call__(self):
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-    
-    def formatwarning(self, message, category, filename, lineno):
-        """Function to format a warning."""
-        return "CherryPy Checker:\n%s\n\n" % message
+    
+    # This value should be set inside _cpconfig.
+    global_config_contained_paths = False
-    
-    def check_skipped_app_config(self):
@@ -59 +67 @@
-                            fulldir = dir
-                            if root:
-
+
+
-                                testdir = os.path.join(root, dir[1:])
-                                if os.path.exists(testdir):
-
-
+
+
+
-                        else:
-                            if not root:
@@ -75 +85 @@
-                            if msg:
-                                msg += "\n"
-
+
+
-                    
-                    if msg:
-                        warnings.warn("%s\nsection: [%s]\nroot: %r\ndir: %r"
-                                      % (msg, section, root, dir))
+    
+    
+    # -------------------------- Compatibility -------------------------- #
-    
-    obsolete = {
@@ -91 +105 @@
-        'show_tracebacks': 'request.show_tracebacks',
-        'throw_errors': 'request.throw_errors',
-
+
+
-        }
-    
@@ -103 +118 @@
-                    if k in self.obsolete:
-                        warnings.warn("%r is obsolete. Use %r instead.\n"
-
+
+
-                    elif k in self.deprecated:
-                        warnings.warn("%r is deprecated. Use %r instead.\n"
-
+
+
-            else:
-                if section in self.obsolete:
@@ -121 +138 @@
-            self._compat(app.config)
-    
-
-
+
+
+
+
+
+
+
-    
-    def _known_ns(self, config):
@@ -132 +154 @@
-                    if len(atoms) > 1:
-                        if atoms[0] not in self.known_config_namespaces:
-
+
+
-                                msg = ("The config entry %r is invalid; "
-                                       "try %r instead.\nsection: [%s]"
@@ -146 +169 @@
-        for sn, app in cherrypy.tree.apps.iteritems():
-            self._known_ns(app.config)
+    
+    
+    # -------------------------- Config Types -------------------------- #
+    
+    known_config_types = {}
+    
+    def _populate_known_types(self):
+        import __builtin__
+        builtins = [x for x in vars(__builtin__).values()
+                    if type(x) is type(str)]
+        
+        def traverse(obj, namespace):
+            for name in dir(obj):
+                vtype = type(getattr(obj, name, None))
+                if vtype in builtins:
+                    self.known_config_types[namespace + "." + name] = vtype
+        
+        traverse(cherrypy.request, "request")
+        traverse(cherrypy.response, "response")
+        traverse(cherrypy.server, "server")
+        traverse(cherrypy.engine, "engine")
+        traverse(cherrypy.log, "log")
+    
+    def _known_types(self, config):
+        msg = ("The config entry %r in section %r is of type %r, "
+               "which does not match the expected type %r.")
+        
+        for section, conf in config.iteritems():
+            if isinstance(conf, dict):
+                for k, v in conf.iteritems():
+                    if v is not None:
+                        expected_type = self.known_config_types.get(k, None)
+                        vtype = type(v)
+                        if expected_type and vtype != expected_type:
+                            warnings.warn(msg % (k, section, vtype.__name__,
+                                                 expected_type.__name__))
+            else:
+                k, v = section, conf
+                if v is not None:
+                    expected_type = self.known_config_types.get(k, None)
+                    vtype = type(v)
+                    if expected_type and vtype != expected_type:
+                        warnings.warn(msg % (k, section, vtype.__name__,
+                                             expected_type.__name__))
+    
+    def check_config_types(self):
+        """Assert that config values are of the same type as default values."""
+        self._known_types(cherrypy.config)
+        for sn, app in cherrypy.tree.apps.iteritems():
+            self._known_types(app.config)
+
+

trunk/cherrypy/_cpconfig.py

@@ -70 +70 @@
-                These can only be declared in the global config.
-    tools:      Runs and configures additional request-processing packages.
+    checker:    Controls the 'checker', which looks for common errors in
+                app state (including config) when the engine starts.
+                Global config only.
-
-The only key that does not exist in a namespace is the "environment" entry.
@@ -93 +96 @@
-    "staging": {
-        'engine.autoreload_on': False,
-engine.checker': Non
+checker.on': Fals
-        'tools.log_headers.on': False,
-        'request.show_tracebacks': False,
@@ -99 +102 @@
-    "production": {
-        'engine.autoreload_on': False,
-engine.checker': Non
+checker.on': Fals
-        'tools.log_headers.on': False,
-        'request.show_tracebacks': False,
@@ -106 +109 @@
-    "test_suite": {
-        'engine.autoreload_on': False,
-engine.checker': Non
+checker.on': Fals
-        'tools.log_headers.on': False,
-        'request.show_tracebacks': True,
@@ -204 +207 @@
-                  "engine": lambda k, v: setattr(cherrypy.engine, k, v),
-                  "log": lambda k, v: setattr(cherrypy.log, k, v),
+                  "checker": lambda k, v: setattr(cherrypy.checker, k, v),
-                  }
-    
@@ -229 +233 @@
-        if isinstance(config.get("global", None), dict):
-            if len(config) > 1:
-engine.
+
-            config = config["global"]
-        

trunk/cherrypy/_cpengine.py

@@ -10 +10 @@
-
-import cherrypy
-, _cpchecker
+
-
-# Use a flag to indicate the state of the application engine.
@@ -53 +53 @@
-    autoreload_frequency = 1
-    autoreload_match = ".*"
-    checker = _cpchecker.Checker()
-    
-    def __init__(self):
@@ -76 +75 @@
-        self.state = STARTING
-        
-
-
+
-        
-        for func in self.on_start_engine_list:

trunk/cherrypy/test/checkerdemo.py

@@ -34 +34 @@
-            # Warn special on cherrypy.<known ns>.*
-            '/cpknown': {'cherrypy.tools.encode.on': True},
+            # Warn on mismatched types
+            '/conftype': {'request.show_tracebacks': 14},
-            }
-    cherrypy.quickstart(Root(), config=conf)