Changeset 5286

Timestamp:

08/28/08 09:15:30 (4 months ago)

Author:

mramm

Message:

Adding docstrings and cleaning up configuration.py

Files:

• trunk/tg/configuration.py (modified) (14 diffs)

trunk/tg/configuration.py

@@ -43 +43 @@
-        return AttributeError
-
-Dict
+PylonsConfig
-    """Simple wrapper for the pylons config object that provides attribute 
-    style access to the pylons config dictionary.
@@ -100 +100 @@
-        return get_partial_dict('pylons', self.config_proxy.current_conf())
-
-
+
+
-
-class Bunch(dict):
@@ -130 +131 @@
-    that is NECESSARY for proper application function.  
-    Deployment specific configuration information should go in 
-
+
+
+
+
+
+
+
+
-    """
-    
-    def __init__(self):
+        """Creates some configuration defaults"""
+        
+        #Create a few bunches we know we'll use
+        self.paths = Bunch()
+        self.render_functions = Bunch()
+        
+        #Set individual defaults
-        self.stand_alone = True
-        self.default_renderer = 'genshi'
-        self.auth_backend = None
-        self.serve_static = True
-paths = Bunch()
-
+use_legacy_render = True
+
-    
-    def setup_paths(self):
@@ -154 +169 @@
-
-    def init_config(self, global_conf, app_conf):
-
+
+
+
+
+
+
+
+
-        pylons_config.init_app(global_conf, app_conf, 
-                        package=self.package.__name__,
@@ -192 +214 @@
-    
-    def setup_mako_renderer(self):
-# Create the Mako TemplateLookup, with the default auto-escaping
+"""Setup a renderer and loader for mako templates"""
-        from mako.lookup import TemplateLookup
-        from tg.render import render_mako
@@ -206 +228 @@
-        
-    def setup_genshi_renderer(self):
-# Create the Genshi TemplateLoader
+"""Setup a renderer and loader for Genshi templates"""
-        from genshi.template import TemplateLoader
-        from tg.render import render_genshi
@@ -221 +243 @@
-    
-    def setup_jinja_renderer(self):
-# Create the Jinja Environment
+"""Setup a renderer and loader for Jinja templates"""
-        from jinja import ChoiceLoader, Environment, FileSystemLoader
-        from tg.render import render_jinja
@@ -233 +255 @@
-    
-    def setup_default_renderer(self):
+        """Setup template defaults in the buffed plugin
+        
+        This is only used when use_legacy_renderer is set to True
+        
+        And it will not depricated in the next major turbogears 
+        release.
+        """
-        #This is specific to buffet, will not be needed later
-        config['buffet.template_engines'].pop()
@@ -240 +269 @@
-    
-    def setup_sqlalchemy(self):
-# Setup SQLAlchemy database engine
+"""Setup SQLAlchemy database engine"""
-        from sqlalchemy import engine_from_config
-        engine = engine_from_config(pylons_config, 'sqlalchemy.')
@@ -287 +316 @@
-
-    def add_error_middleware(self, global_conf, app):
-# Handle Python exceptions
+"""Adds middleware which handles errors and exceptions"""
-        app = ErrorHandler(app, global_conf, **config['pylons.errorware'])
-
@@ -299 +328 @@
-
-    def add_auth_middleware(self, app):
-# configure identity Middleware
+"""Configure authorization/authentication"""
-        from tg.ext.repoze.who.middleware import make_who_middleware
-
@@ -312 +341 @@
-    
-    def add_core_middleware(self, app):    
+        """Adds support for routes dispatch, sessions, and caching"""
-        app = RoutesMiddleware(app, config['routes.map'])
-        app = SessionMiddleware(app, config)
@@ -318 +348 @@
-    
-    def add_tosca_middleware(self, app):
+        """Configure the ToscaWidgets middleware"""
-        app = tw_middleware(app, {
-            'toscawidgets.framework.default_view': 
@@ -342 +373 @@
-
-    def add_tm_middleware(self, app):
+        """Sets up the transaction managment middleware
+        
+        To abort a transaction inside a TG2 app::
+        
+          import transaction
+          transaction.doom()
+        
+        By default http error responses also roll back transactions, 
+        but this behavior can be overridden by overiding 
+        base_config.commit_veto
+        """
-        from repoze.tm import make_tm
-        return make_tm(app, self.commit_veto)
-
-    def add_dbsession_remover_middleware(self, app):
+        """Sets up middleware that cleans up the sqlalchmy session
+        
+        The default behavior of TG2 is to clean up the session on 
+        every request.  Only overide this method if you know what you
+        are doing!
+        
+        """
-        def remover(environ, start_response):
-            try: