Changeset 807

Timestamp:

11/10/05 12:41:40

Author:

fumanchu

Message:

Moved filter-handling code into lib.filter.init.py. Also moved unrepr and modules(), attributes() functions into cptools.

Files:

• trunk/cherrypy/_cphttptools.py (modified) (2 diffs)
• trunk/cherrypy/_cpserver.py (modified) (3 diffs)
• trunk/cherrypy/_cputil.py (modified) (1 diff)
• trunk/cherrypy/config.py (modified) (2 diffs)
• trunk/cherrypy/lib/cptools.py (modified) (1 diff)
• trunk/cherrypy/lib/filter/__init__.py (modified) (1 diff)
• trunk/cherrypy/test/helper.py (modified) (2 diffs)
• trunk/cherrypy/test/test.py (modified) (1 diff)

trunk/cherrypy/_cphttptools.py

@@ -8 +8 @@
-import cherrypy
-from cherrypy import _cputil, _cpcgifs, _cpwsgiserver
+from cherrypy.lib.filter import applyFilters
-from cherrypy.lib import cptools, httptools
-
@@ -442 +443 @@
-            for y in flattener(x):
-                yield y 
-
-def applyFilters(methodName):
-    """Execute the given method for all registered filters."""
-    if methodName in ('onStartResource', 'beforeRequestBody', 'beforeMain'):
-        filterList = (_cputil._cpDefaultInputFilterList +
-                      _cputil.getSpecialAttribute('_cpFilterList'))
-    elif methodName in ('beforeFinalize', 'onEndResource',
-                'beforeErrorResponse', 'afterErrorResponse'):
-        filterList = (_cputil.getSpecialAttribute('_cpFilterList') +
-                      _cputil._cpDefaultOutputFilterList)
-    else:
-        assert False # Wrong methodName for the filter
-    for filter in filterList:
-        method = getattr(filter, methodName, None)
-        if method:
-            method()

trunk/cherrypy/_cpserver.py

@@ -8 +8 @@
-import cherrypy
-from cherrypy import _cphttptools
-
+, filter, cptools
-
-# Use a flag to indicate the state of the application server.
@@ -53 +53 @@
-        elif serverClass and isinstance(serverClass, basestring):
-            # Dynamically load the class from the given string
-herrypy._cputil
+ptools
-        
-        self.blocking = not initOnly
@@ -278 +278 @@
-    
-    # Initialize the built in filters
-
-
+
-
-

trunk/cherrypy/_cputil.py

@@ -308 +308 @@
-    cherrypy.HTTPError(500).set_response()
-
+
-_cpFilterList = []
-
-# Filters that are always included
-from cherrypy.lib.filter import baseurlfilter, cachefilter, \
-    decodingfilter, encodingfilter, gzipfilter, logdebuginfofilter, \
-    staticfilter, nsgmlsfilter, tidyfilter, \
-    xmlrpcfilter, sessionauthenticatefilter, \
-    sessionfilter
-
-# this contains the classes for each filter type
-# we do not store the instances here because the test
-# suite must reinitilize the filters without restarting
-# the server
-_cpDefaultFilterClasses = {
-    'BaseUrlFilter'      : baseurlfilter.BaseUrlFilter,
-    'CacheFilter'        : cachefilter.CacheFilter,
-    'DecodingFilter'     : decodingfilter.DecodingFilter,
-    'EncodingFilter'     : encodingfilter.EncodingFilter,
-    'GzipFilter'         : gzipfilter.GzipFilter,
-    'LogDebugInfoFilter' : logdebuginfofilter.LogDebugInfoFilter,
-    'NsgmlsFilter'       : nsgmlsfilter.NsgmlsFilter,
-    'SessionAuthenticateFilter' : sessionauthenticatefilter.SessionAuthenticateFilter,
-    'SessionFilter'      : sessionfilter.SessionFilter,
-    'StaticFilter'       : staticfilter.StaticFilter,
-    'TidyFilter'         : tidyfilter.TidyFilter,
-    'XmlRpcFilter'       : xmlrpcfilter.XmlRpcFilter,
-}
-
-# this is where the actual filter instances are first stored
-_cpDefaultFilterInstances = {}
-
-# These are in order for a reason!
-# They must be strings matching keys in _cpDefaultFilterClasses
-__cpDefaultInputFilterNames = [
-    'CacheFilter',
-    'LogDebugInfoFilter',
-    'BaseUrlFilter',
-    'DecodingFilter',
-    'SessionFilter',
-    'SessionAuthenticateFilter',
-    'StaticFilter',
-    'NsgmlsFilter',
-    'TidyFilter',
-    'XmlRpcFilter',
-]
-
-__cpDefaultOutputFilterNames = [
-    'XmlRpcFilter',
-    'EncodingFilter',
-    'TidyFilter',
-    'NsgmlsFilter',
-    'LogDebugInfoFilter',
-    'GzipFilter',
-    'SessionFilter',
-    'CacheFilter',
-]
-
-# these are the lists cp internally uses to access the filters
-# they are populated when _cpInitDefaultFilters is called
-_cpDefaultInputFilterList  = []
-_cpDefaultOutputFilterList = []
-
-# initilize the default filters
-def _cpInitDefaultFilters():
-    global _cpDefaultInputFilterList, _cpDefaultOutputFilterList
-    global _cpDefaultFilterInstances
-    _cpDefaultInputFilterList  = []
-    _cpDefaultOutputFilterList = []
-    _cpDefaultFilterInstances = {}
-    
-    for filterName in __cpDefaultInputFilterNames:
-        filterClass = _cpDefaultFilterClasses[filterName]
-        filterInstance = _cpDefaultFilterInstances[filterName] = filterClass()
-        _cpDefaultInputFilterList.append(filterInstance)
-    
-    for filterName in __cpDefaultOutputFilterNames:
-        filterClass = _cpDefaultFilterClasses[filterName]
-        filterInstance = _cpDefaultFilterInstances.setdefault(filterName, filterClass())
-        _cpDefaultOutputFilterList.append(filterInstance)
-
-def _cpInitUserDefinedFilters():
-    filtersRoot = cherrypy.config.get('server.filtersRoot', [])
-    inputFiltersDict = cherrypy.config.get('server.inputFiltersDict', {})
-    outputFiltersDict = cherrypy.config.get('server.outputFiltersDict', {})
-    
-    if len(filtersRoot) == 0:
-        return
-    
-    sys.path.extend(filtersRoot)
-    
-    for filterName, filterClassname in inputFiltersDict.items():
-        filterModule = __import__(filterName, globals(),  locals(), [])
-        filterClass = getattr(filterModule, filterClassname, None)
-        filterInstance = filterClass()
-        _cpDefaultInputFilterList.append(filterInstance)
-    
-    for filterName, filterClassname in outputFiltersDict.items():
-        filterModule = __import__(filterName, globals(),  locals(), [])
-        filterClass = getattr(filterModule, filterClassname, None)
-        filterInstance = filterClass()
-        _cpDefaultOutputFilterList.append(filterInstance)
-    
-    # Avoid pollution of the system path
-    for path in filtersRoot:
-        sys.path.remove(path)
-
-
-# public domain "unrepr" implementation, found on the web and then improved.
-import compiler
-
-def getObj(s):
-    s = "a=" + s
-    p = compiler.parse(s)
-    return p.getChildren()[1].getChildren()[0].getChildren()[1]
-
-
-class UnknownType(Exception):
-    pass
-
-
-class Builder:
-    
-    def build(self, o):
-        m = getattr(self, 'build_' + o.__class__.__name__, None)
-        if m is None:
-            raise UnknownType(o.__class__.__name__)
-        return m(o)
-    
-    def build_List(self, o):
-        return map(self.build, o.getChildren())
-    
-    def build_Const(self, o):
-        return o.value
-    
-    def build_Dict(self, o):
-        d = {}
-        i = iter(map(self.build, o.getChildren()))
-        for el in i:
-            d[el] = i.next()
-        return d
-    
-    def build_Tuple(self, o):
-        return tuple(self.build_List(o))
-    
-    def build_Name(self, o):
-        if o.name == 'None':
-            return None
-        if o.name == 'True':
-            return True
-        if o.name == 'False':
-            return False
-        
-        # See if the Name is a package or module
-        try:
-            return modules(o.name)
-        except ImportError:
-            pass
-        
-        raise UnknownType(o.name)
-    
-    def build_Add(self, o):
-        real, imag = map(self.build_Const, o.getChildren())
-        try:
-            real = float(real)
-        except TypeError:
-            raise UnknownType('Add')
-        if not isinstance(imag, complex) or imag.real != 0.0:
-            raise UnknownType('Add')
-        return real+imag
-    
-    def build_Getattr(self, o):
-        parent = self.build(o.expr)
-        return getattr(parent, o.attrname)
-
-
-def unrepr(s):
-    if not s:
-        return s
-    try:
-        return Builder().build(getObj(s))
-    except:
-        raise cherrypy.WrongUnreprValue(repr(s))
-
-def modules(modulePath):
-    """Load a module and retrieve a reference to that module."""
-    try:
-        mod = sys.modules[modulePath]
-        if mod is None:
-            raise KeyError()
-    except KeyError:
-        # The last [''] is important.
-        mod = __import__(modulePath, globals(), locals(), [''])
-    return mod
-
-def attributes(fullAttributeName):
-    """Load a module and retrieve an attribute of that module."""
-    
-    # Parse out the path, module, and attribute
-    lastDot = fullAttributeName.rfind(u".")
-    attrName = fullAttributeName[lastDot + 1:]
-    modPath = fullAttributeName[:lastDot]
-    
-    aMod = modules(modPath)
-    # Let an AttributeError propagate outward.
-    try:
-        attr = getattr(aMod, attrName)
-    except AttributeError:
-        raise AttributeError("'%s' object has no attribute '%s'"
-                             % (modPath, attrName))
-    
-    # Return a reference to the attribute.
-    return attr

trunk/cherrypy/config.py

@@ -4 +4 @@
-
-import cherrypy
-, _cperror
-
+
+, cptools
-
-
@@ -198 +198 @@
-            value = configParser.get(section, option)
-            try:
-_cputil
-_cperror
+cptools
+cherrypy
-                msg = ("section: %s, option: %s, value: %s" %
-                       (repr(section), repr(option), repr(value)))
-_cperror
+cherrypy
-            result[section][option] = value
-    return result

trunk/cherrypy/lib/cptools.py

@@ -181 +181 @@
-        chunk = input.read(chunkSize)
-    input.close()
+
+def modules(modulePath):
+    """Load a module and retrieve a reference to that module."""
+    try:
+        mod = sys.modules[modulePath]
+        if mod is None:
+            raise KeyError()
+    except KeyError:
+        # The last [''] is important.
+        mod = __import__(modulePath, globals(), locals(), [''])
+    return mod
+
+def attributes(fullAttributeName):
+    """Load a module and retrieve an attribute of that module."""
+    
+    # Parse out the path, module, and attribute
+    lastDot = fullAttributeName.rfind(u".")
+    attrName = fullAttributeName[lastDot + 1:]
+    modPath = fullAttributeName[:lastDot]
+    
+    aMod = modules(modPath)
+    # Let an AttributeError propagate outward.
+    try:
+        attr = getattr(aMod, attrName)
+    except AttributeError:
+        raise AttributeError("'%s' object has no attribute '%s'"
+                             % (modPath, attrName))
+    
+    # Return a reference to the attribute.
+    return attr
+
+
+# public domain "unrepr" implementation, found on the web and then improved.
+import compiler
+
+def getObj(s):
+    s = "a=" + s
+    p = compiler.parse(s)
+    return p.getChildren()[1].getChildren()[0].getChildren()[1]
+
+
+class UnknownType(Exception):
+    pass
+
+
+class Builder:
+    
+    def build(self, o):
+        m = getattr(self, 'build_' + o.__class__.__name__, None)
+        if m is None:
+            raise UnknownType(o.__class__.__name__)
+        return m(o)
+    
+    def build_List(self, o):
+        return map(self.build, o.getChildren())
+    
+    def build_Const(self, o):
+        return o.value
+    
+    def build_Dict(self, o):
+        d = {}
+        i = iter(map(self.build, o.getChildren()))
+        for el in i:
+            d[el] = i.next()
+        return d
+    
+    def build_Tuple(self, o):
+        return tuple(self.build_List(o))
+    
+    def build_Name(self, o):
+        if o.name == 'None':
+            return None
+        if o.name == 'True':
+            return True
+        if o.name == 'False':
+            return False
+        
+        # See if the Name is a package or module
+        try:
+            return modules(o.name)
+        except ImportError:
+            pass
+        
+        raise UnknownType(o.name)
+    
+    def build_Add(self, o):
+        real, imag = map(self.build_Const, o.getChildren())
+        try:
+            real = float(real)
+        except TypeError:
+            raise UnknownType('Add')
+        if not isinstance(imag, complex) or imag.real != 0.0:
+            raise UnknownType('Add')
+        return real+imag
+    
+    def build_Getattr(self, o):
+        parent = self.build(o.expr)
+        return getattr(parent, o.attrname)
+
+
+def unrepr(s):
+    if not s:
+        return s
+    try:
+        return Builder().build(getObj(s))
+    except:
+        raise cherrypy.WrongUnreprValue(repr(s))
+

trunk/cherrypy/lib/filter/__init__.py

@@ +1 @@
+import cherrypy
+from cherrypy import _cputil
+
+# Filters that are always included
+from cherrypy.lib.filter import baseurlfilter, cachefilter, \
+    decodingfilter, encodingfilter, gzipfilter, logdebuginfofilter, \
+    staticfilter, nsgmlsfilter, tidyfilter, \
+    xmlrpcfilter, sessionauthenticatefilter, \
+    sessionfilter
+
+# this contains the classes for each filter type
+# we do not store the instances here because the test
+# suite must reinitialize the filters without restarting
+# the server
+_classes = {
+    'BaseUrlFilter'      : baseurlfilter.BaseUrlFilter,
+    'CacheFilter'        : cachefilter.CacheFilter,
+    'DecodingFilter'     : decodingfilter.DecodingFilter,
+    'EncodingFilter'     : encodingfilter.EncodingFilter,
+    'GzipFilter'         : gzipfilter.GzipFilter,
+    'LogDebugInfoFilter' : logdebuginfofilter.LogDebugInfoFilter,
+    'NsgmlsFilter'       : nsgmlsfilter.NsgmlsFilter,
+    'SessionAuthenticateFilter' : sessionauthenticatefilter.SessionAuthenticateFilter,
+    'SessionFilter'      : sessionfilter.SessionFilter,
+    'StaticFilter'       : staticfilter.StaticFilter,
+    'TidyFilter'         : tidyfilter.TidyFilter,
+    'XmlRpcFilter'       : xmlrpcfilter.XmlRpcFilter,
+}
+
+# These are in order for a reason!
+# They must be strings matching keys in _classes
+_input_order = [
+    'CacheFilter',
+    'LogDebugInfoFilter',
+    'BaseUrlFilter',
+    'DecodingFilter',
+    'SessionFilter',
+    'SessionAuthenticateFilter',
+    'StaticFilter',
+    'NsgmlsFilter',
+    'TidyFilter',
+    'XmlRpcFilter',
+]
+
+_output_order = [
+    'XmlRpcFilter',
+    'EncodingFilter',
+    'TidyFilter',
+    'NsgmlsFilter',
+    'LogDebugInfoFilter',
+    'GzipFilter',
+    'SessionFilter',
+    'CacheFilter',
+]
+
+_input_methods = ['onStartResource', 'beforeRequestBody', 'beforeMain']
+_output_methods = ['beforeFinalize', 'onEndResource',
+                   'beforeErrorResponse', 'afterErrorResponse']
+
+
+def init():
+    """Initialize the filters."""
+    instances = {}
+    inputs, outputs = [], []
+    
+    conf = cherrypy.config.get
+    
+    for name in _input_order + conf('server.inputFilters', []):
+        f = instances.get(name)
+        if f is None:
+            f = instances[name] = _classes[name]()
+        inputs.append(f)
+    
+    for name in conf('server.outputFilters', []) + _output_order:
+        f = instances.get(name)
+        if f is None:
+            f = instances[name] = _classes[name]()
+        outputs.append(f)
+    
+    # Transform the instance lists into a dict of methods
+    _filterhooks.clear()
+    for name in _input_methods:
+        _filterhooks[name] = []
+        for f in inputs:
+            method = getattr(f, name, None)
+            if method:
+                _filterhooks[name].append(method)
+    for name in _output_methods:
+        _filterhooks[name] = []
+        for f in outputs:
+            method = getattr(f, name, None)
+            if method:
+                _filterhooks[name].append(method)
+
+
+_filterhooks = {}
+
+
+def applyFilters(methodName):
+    """Execute the given method for all registered filters."""
+    special_methods = []
+    for f in _cputil.getSpecialAttribute("_cpFilterList"):
+        method = getattr(f, methodName, None)
+        if method:
+            special_methods.append(method)
+    
+    if methodName in _input_methods:
+        # Run special filters after defaults.
+        for method in _filterhooks[methodName] + special_methods:
+            method()
+    else:
+        # Run special filters before defaults.
+        for method in special_methods + _filterhooks[methodName]:
+            method()

trunk/cherrypy/test/helper.py

@@ -193 +193 @@
-        cherrypy.config.reset()
-        setConfig(conf)
-
+
+
-        
-        suite = CPTestLoader.loadTestsFromName(testmod)
@@ -208 +209 @@
-def _test_main_thread():
-    cherrypy.server.wait()
-
+
+
-    try:
-        webtest.main()

trunk/cherrypy/test/test.py

@@ -316 +316 @@
-        'test_cache_filter',
-        'test_combinedfilters',
+        'test_config',
-        'test_core',
-        'test_decodingencoding_filter',