Changeset 5695

Timestamp:

11/17/08 14:00:03 (2 months ago)

Author:

carndt

Message:

turbogears.startup cleanup and adding some docstrings & source code comments. Make sure that request filters do not get added more than once

Files:

• branches/1.1/turbogears/startup.py (modified) (9 diffs)

branches/1.1/turbogears/startup.py

@@ -20 +20 @@
-import signal
-import time
+
+from os.path import abspath, exists
-
-import pkg_resources
@@ -114 +116 @@
-# module public functions
-def start_bonjour(package=None):
+    """Register the TurboGears server with the Bonjour framework.
+
+    Currently only Unix-like systems are supported where either the 'avahi'
+    daemon (Linux etc.) is available or the 'dns-sd' program (Mac OS X).
+
+    """
-    global DNS_SD_PID
-    if DNS_SD_PID:
@@ -137 +145 @@
-        # try registering with both or checking what service is running and use
-        # that.  Program availability on the filesystem was never enough...
-os.path.
+
-            DNS_SD_PID = os.spawnv(os.P_NOWAIT, cmd, [cmd]+args)
-            atexit.register(stop_bonjour)
@@ -143 +151 @@
-
-def stop_bonjour():
+    """Stop the bonjour publishing daemon if it is running."""
-    if not DNS_SD_PID:
-        return
@@ -153 +162 @@
-    """Handles TurboGears tasks when the CherryPy server starts.
-
+    This performs the following initialization tasks (in given order):
+
+    * Adds a static filter for TurboGears's static files (URL '/tg_static').
+    * Adds a static filter for TurboGears's JavaScript files (URL '/tg_js').
+    * Adds the decoding filter to the root URL ('/') if enabled in the
+      configuration.
+    * Loads the template engines and the base templates.
+    * Adds the CherryPy request filters to the root controller.
+    * Turns off CherryPy's logging filter when in development mode and turns on
+      stdlib logging.
+    * Registers the server with the Bonjour framework, if available.
+    * Calls 'turbogears.database.bind_metadata' when using SQLAlchemy.
+    * Loads all turbogears.extensions entry points and calls their
+      'start_extension' method.
+    * Calls the callables registered in 'turbogears.call_on_startup'.
+    * Starts the TurboGears scheduler.
-    This adds the "tg_js" configuration to make MochiKit accessible.
-    It also turns on stdlib logging when in development mode.
-
-    """
-    global webpath
+    conf = config.get
+    rfn = pkg_resources.resource_filename
+
+    # Add static filters
-    config.update({"/tg_static":
-            {
-            "static_filter.on": True,
-
-
-
+
+
-            }
-        })
-    config.update({"/tg_js" :
-            {
-
-
-
-
+
+
+
-            }
-        })
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-    view.load_engines()
-    view.loadBaseTemplates()
-
-
+
+
-
-    if getattr(cherrypy, 'root', None):
-        if not hasattr(cherrypy.root, '_cp_filters'):
-            cherrypy.root._cp_filters = []
-cherrypy.root._cp_filters.extend(
+extra_filters = 
-            VirtualPathFilter(webpath),
-            EndTransactionsFilter(),
-            NestedVariablesFilter(),
-            SafeMultipartFilter()
-
+
+
+
+
+
+
+
+
-
-    webpath = webpath.lstrip('/')
@@ -202 +237 @@
-        webpath += '/'
-
-
-
-
+
+
+
+
+
-            setuplog = logging.getLogger()
-            setuplog.setLevel(logging.DEBUG)
@@ -214 +251 @@
-            setuplog.addHandler(handler)
-
-ig.get
+
-        if logfile:
-            setuplog = logging.getLogger("turbogears.access")
@@ -224 +261 @@
-            setuplog.addHandler(handler)
-
-
-
+
+
+
-        start_bonjour(bonjoursetting)
-
-
+
+
-        database.bind_metadata()
-
@@ -247 +286 @@
-                    entrypoint, e)
-
+    # Call oall registered startup functions
-    for item in call_on_startup:
-        item()
-
-
+
+
-        scheduler._start_scheduler()
-        log.info("Scheduler started")