Changeset 5756

Timestamp:

11/24/08 03:05:45 (2 months ago)

Author:

carndt

Message:

Implement #2013 (add database bootstrap command to quickstart templates)

Files:

• branches/1.1/turbogears/qstemplates/quickstart/+package+/commands.py_tmpl (modified) (4 diffs)
• branches/1.1/turbogears/qstemplates/quickstart/+package+/model.py_tmpl (modified) (4 diffs)
• branches/1.1/turbogears/qstemplates/quickstart/setup.py_tmpl (modified) (1 diff)

branches/1.1/turbogears/qstemplates/quickstart/+package+/commands.py_tmpl

@@ -1 +1 @@
-# -*- coding: utf-8 -*-
-
+
+
-
-import sys
+import optparse
+
-from os import getcwd
-from os.path import dirname, exists, join
@@ -37 +40 @@
-import turbogears
-
+from ${package}.release import version
+
+
-cherrypy.lowercase_api = True
-
@@ -44 +50 @@
-
-
-start(
-Start the CherryPy application server."""
+_read_config(args
+Read deployment configuration file.
-
+    First looks on the command line for a desired config file, if it's not on
+    the command line, then looks for 'setup.py' in the parent of the directory
+    where this module is located.
+
+    If 'setup.py' is there, assumes that the application is started from
+    the project directory and should run in development mode and so loads the
+    configuration from a file called 'dev.cfg' in the current directory.
+
+    If 'setup.py' is not there, the project is probably installed and the code
+    looks first for a file called 'prod.cfg' in the current directory and, if
+    this isn't found either, for a default config file called 'default.cfg'
+    packaged in the egg.
+
+    """
-    setupdir = dirname(dirname(__file__))
-    curdir = getcwd()
-
-
-
-
-
-
-
-
-
-
+
+
-    elif exists(join(setupdir, "setup.py")):
-        configfile = join(setupdir, "dev.cfg")
@@ -66 +79 @@
-        try:
-            configfile = pkg_resources.resource_filename(
-roject
+ackage
-                "config/default.cfg")
-        except pkg_resources.DistributionNotFound:
-a configuration file
+default configuration
-
-    turbogears.update_config(configfile=configfile,
-        modulename="${package}.config")
-
+def bootstrap():
+    """Example function for loading bootstrap data into the database
+
+    You can adapt this to your needs to e.g. accept more options or to
+    run more functions for bootstrapping other parts of your application.
+    By default this runs the function '${package}.model.bootstrap_model', which
+    creates all database tables and optionally adds a user.
+
+    The following line in your project's 'setup.py' file takes care of
+    installing a command line script when you install your application via
+    easy_install which will run this function:
+
+        'bootstrap-${package} = ${package}.commands:bootstrap',
+
+    """
+
+    optparser = optparse.OptionParser(usage="%prog [options] [config-file]",
+        description="Load bootstrap data into the database defined in "
+        "config-file.", version="${project} %s" % version)
+    optparser.add_option('-C', '--clean', dest="clean", action="store_true",
+        help="Purge all data in the database before loading the bootrap data.")
+    optparser.add_option('-u', '--user', dest="user", metavar="USERNAME",
+        help="Create a default user USERNAME (prompts for password).")
+    options, args = optparser.parse_args()
+    if options.user:
+        options.user = options.user.decode(sys.getfilesystemencoding())
+    _read_config(args)
+    from ${package}.model import bootstrap_model
+    bootstrap_model(options.clean, options.user)
+
+def start():
+    """Start the CherryPy application server."""
+
+    _read_config(sys.argv[1:])
-    from ${package}.controllers import Root
-
-    turbogears.start_server(Root())

branches/1.1/turbogears/qstemplates/quickstart/+package+/model.py_tmpl

@@ +1 @@
+import sys
+
-#if $identity != 'none'
-from datetime import datetime
-#end if
-
+import pkg_resources
-#if $sqlobject == 'True'
-import pkg_resources
-pkg_resources.require("$sqlobjectversion")
-#elif $sqlalchemy == 'True'
-import pkg_resources
-pkg_resources.require("$sqlalchemyversion")
-#if $elixir == 'True'
@@ -19 +20 @@
-# (see http://www.sqlobject.org/SQLObject.html#declaring-the-class)
-from sqlobject import SQLObject, SQLObjectNotFound, RelatedJoin
+from sqlobject.inheritance import InheritableSQLObject
-# import some datatypes for table columns from SQLObject
-# (see http://www.sqlobject.org/SQLObject.html#column-types for more)
@@ -32 +34 @@
-# (see http://www.sqlalchemy.org/docs/04/types.html for more)
-from elixir import String, Unicode, Integer, DateTime
+from turbogears.database import get_engine, metadata, session
-#else
-
+get_engine, 
-# import some basic SQLAlchemy classes for declaring the data model
-# (see http://www.sqlalchemy.org/docs/04/ormtutorial.html)
@@ -467 +470 @@
-#end if
-#end if
+
+# functions for populating the database
+
+def bootstrap_model(clean=False, user=None):
+    """Create all database tables and fill them with default data.
+
+    This function is run by the 'bootstrap' function from the commands module.
+    By default is calls two functions to create all database tables for your
+    model and optionally create a user.
+
+    You can add more functions as you like to add more boostrap data to the
+    database or enhance the functions below.
+
+    If 'clean' is True, all tables defined by you model will dropped before
+    creating them again. If 'user' is not None, 'create_user' will be called
+    with the given username.
+
+    """
+    create_tables(clean)
+    if user:
+        create_default_user(user)
+
+def create_tables(drop_all=False):
+    """Create all tables defined in the model in the database.
+
+    Optionally drop existing tables before creating them.
+
+    """
+#if $identity == 'sqlobject'
+    ## XXX: This is duplicated from testutil.DBTestSO and should be factored
+    ## out to a reusable function (maybe into turbogears.database?).
+    from turbogears.util import get_model
+    from inspect import isclass
+
+    model = get_model()
+    if not model:
+        from ${package}.commands import ConfigurationError
+        raise ConfigurationError(
+            "Unable to create database tables without a model")
+
+    try:
+        so_classes = [model.__dict__[x] for x in model.soClasses]
+    except AttributeError:
+        so_classes = model.__dict__.values()
+
+    if drop_all:
+        print "Dropping all database tables defined in model."
+        for item in reversed(so_classes):
+            if isclass(item) and issubclass(item, SQLObject) and \
+                    item is not SQLObject and item is not InheritableSQLObject:
+                item.dropTable(ifExists=True, cascade=True)
+
+    # list of constraints we will collect
+    constraints = list()
+
+    for item in so_classes:
+        if isclass(item) and issubclass(item, SQLObject) and \
+                item is not SQLObject and item is not InheritableSQLObject:
+            # create table without applying constraints, collect
+            # all the constaints for later creation.
+            # see http://sqlobject.org/FAQ.html#mutually-referencing-tables
+            # for more info
+            collected_constraints = item.createTable(ifNotExists=True,
+                applyConstraints=False)
+
+            if collected_constraints:
+                constraints.extend(collected_constraints)
+
+    # now that all tables are created, add the constaints we collected
+    for postponed_constraint in constraints:
+        # item is the last processed item and we borrow its connection
+        item._connection.query(postponed_constraint)
+#elif $identity == 'sqlalchemy'
+    get_engine()
+    if drop_all:
+        print "Dropping all database tables defined in model."
+        metadata.drop_all()
+    metadata.create_all()
+#end if
+
+    print "All database tables defined in model created."
+
+def create_default_user(user_name):
+    """Create a default user."""
+    from getpass import getpass
+
+    try:
+        u = User.by_user_name(user_name)
+    except:
+        u = None
+    if u:
+        print "User '%s' already exists in database." % user_name
+        return
+    while True:
+        try:
+            password = getpass("Enter password for user '%s': "
+                % user_name).strip()
+            password2 = getpass("Confirm password: ").strip()
+            if password != password2:
+                print "Passwords do not match."
+            else:
+                password = password.decode(sys.getfilesystemencoding())
+                break
+        except (EOFError, KeyboardInterrupt):
+            print "User creation cancelled."
+            return
+#if $identity == 'sqlobject'
+    hub.begin()
+#end if
+    u = User(user_name=user_name, display_name=u"Default User",
+        email_address=u"%s@nowhere.xyz" % user_name, password=password)
+#if $identity == 'sqlobject'
+    hub.commit()
+#end if
+#if $identity == 'sqlalchemy'
+    session.save(u)
+    session.flush()
+#end if
+    print "User '%s' created." % user_name

branches/1.1/turbogears/qstemplates/quickstart/setup.py_tmpl

@@ -78 +78 @@
-        'console_scripts': [
-            'start-${package} = ${package}.commands:start',
+            # See the ${package}.commands.bootstrap function for details
+            'bootstrap-${package} = ${package}.commands:bootstrap',
-        ],
-    },