Changeset 200

Timestamp:

08/24/08 09:05:11 (10 months ago)

Author:

rgrp

Message:

[shakespeare/misc][m]: fix up config registration, make associated changes to cli.py and move all tests to shakespeare/tests.

• config setup:
  • conf() in init was confusing, out of date, and was magically defaulting to 'development.ini'
  • added new register_config and refactor conf to just look the config up
• cli.py: refactored to take account of this adding new --config option to shakespeare-admin
• tests: move all tests into shakespeare/tests so that config is properly set up for them

Location:

trunk

Files:

• shakespeare.egg-info/paste_deploy_config.ini_tmpl (modified) (2 diffs)
• shakespeare/__init__.py (modified) (2 diffs)
• shakespeare/cli.py (modified) (11 diffs)
• shakespeare/index_test.py (deleted)
• shakespeare/tests/test_cache.py (moved) (moved from trunk/shakespeare/cache_test.py)
• shakespeare/tests/test_format.py (moved) (moved from trunk/shakespeare/format_test.py)
• shakespeare/tests/test_gutenberg.py (moved) (moved from trunk/shakespeare/gutenberg_test.py)
• shakespeare/tests/test_textutils.py (moved) (moved from trunk/shakespeare/textutils_test.py)

trunk/shakespeare.egg-info/paste_deploy_config.ini_tmpl

@@ -47 +47 @@
 set debug = false
 
-# using sqlite in memory leads to thread issues when using db ...
-# sqlobject.dburi = sqlite:///:memory:
-sqlobject.dburi = postgres://<username>:<password>@localhost/<your-dbname>
+# We use sqlalchemy to connect and work with databases.
+# This default config using sqlite.
+sqlalchemy.url = sqlite:///%(here)s/shkspr.db
+# This is for postgres (obviously change the values to those for your system)
+# sqlalchemy.url = postgres://<username>:<password>@localhost/<your-dbname>
 
 # Logging configuration
@@ -74 +76 @@
 format = %(asctime)s %(levelname)-5.5s [%(name)s] %(message)s
 
-
-[misc]
-# directory where we can store all local copies of texts
-cachedir = ./cache
-
-[db]
-# sqlobject database uri. see sqlobject documentation for details
-# uri = postgres://user:pass@host/dbname
-uri = sqlite:/:memory:
-
-[web]
-# directory where the templates used by web front end are kept
-template_dir = ./src/shakespeare/template
-
-[annotater]
-# url at which marginalia files (css/js etc) should be mounted
-marginalia_prefix = /marginalia

trunk/shakespeare/__init__.py

@@ -81 +81 @@
 Run::
 
-    $ shakespeare-admin db create
     $ shakespeare-admin db init
 
@@ -121 +120 @@
 __application_name__ = 'shakespeare'
 
-def conf():
+def register_config(config_path):
     import os
-    defaultPath = os.path.abspath('./development.ini')
-    envVarName = __application_name__.upper() + 'CONF'
-    confPath = os.environ.get(envVarName, defaultPath)
-    if not os.path.exists(confPath):
-        raise ValueError('No Configuration file exists at: %s' % confPath)
-
-    # register the config
+    # TODO: remove? 2008-08-24 not mentioned in docs any more
+    # envVarName = __application_name__.upper() + 'CONF'
+    # config_path = os.environ.get(envVarName, '')
+    config_path = os.path.abspath(config_path)
     import paste.deploy
+    pasteconf = paste.deploy.appconfig('config:' + config_path)
     import shakespeare.config.environment
-    pasteconf = paste.deploy.appconfig('config:' + confPath)
-
     shakespeare.config.environment.load_environment(pasteconf.global_conf,
         pasteconf.local_conf)
+
+
+# TODO: rename to get_config()
+def conf():
     from pylons import config
     conf = config
-
-    # import ConfigParser
-    # conf = ConfigParser.SafeConfigParser()
-    # conf.read(confPath)
-
     return conf
      

trunk/shakespeare/cli.py

@@ -10 +10 @@
     """
 
-    def __init__(self, verbose=False):
+    def __init__(self, config=None, verbose=False):
         # cmd.Cmd is not a new style class
         cmd.Cmd.__init__(self)
+        self.config = config
         self.verbose = verbose
 
@@ -19 +20 @@
             print msg
 
-    prompt = 'The Bard > '
-
-    def run_interactive(self, line=None):
-        """Run an interactive session.
-        """
-        print 'Welcome to shakespeare-admin interactive mode\n'
-        self.do_about()
-        print 'Type:  "?" or "help" for help on commands.\n'
-        while 1:
-            try:
-                self.cmdloop()
-                break
-            except KeyboardInterrupt:
-                raise
+    def _register_config(self):
+        import sys
+        if not self.config:
+            msg = 'No configuration file has been specified. See -h help for details'
+            print msg
+            sys.exit(1)
+        import shakespeare
+        shakespeare.register_config(self.config)
 
     def do_help(self, line=None):
@@ -59 +54 @@
 
     def do_db(self, line=None):
-        actions = [ 'create', 'clean', 'rebuild', 'init' ]
+        actions = [ 'create', 'clean', 'init' ]
         if line is None or line not in actions:
             self.help_db()
             return 1
+        self._register_config()
         import shakespeare.model
+        import shakespeare
         if line == 'init':
             import pkg_resources
@@ -69 +66 @@
             meta = pkg_resources.resource_stream(pkg, 'texts/metadata.txt')
             shakespeare.model.Material.load_from_metadata(meta)
-        else:
+        elif line == 'clean':
+            config = shakespeare.conf()
+            shakespeare.model.metadata.drop_all(bind=config['pylons.g'].sa_engine)
+        elif line == 'create':
             print 'To create db use paster: paster setup-app {config-file}'
+        else:
+            print self.help_db()
 
     def help_db(self, line=None):
@@ -79 +81 @@
     
     def do_gutenberg(self, line=None):
+        self._register_config()
         import shakespeare.gutenberg
         helper = shakespeare.gutenberg.Helper(verbose=True)
@@ -109 +112 @@
 
     def help_moby(self, line=None):
+        self._register_config()
         usage = \
 '''
@@ -115 +119 @@
 
     def _init_index(self):
+        self._register_config()
         import shakespeare.index
         self._index = shakespeare.index.all
@@ -185 +190 @@
 
     def do_search(self, line):
+        self._register_config()
         import shakespeare.search
         index = shakespeare.search.SearchIndex.default_index()
@@ -232 +238 @@
 
     def do_stats(self, line):
+        self._register_config()
         action, extra = self._parse_line(line)
 
@@ -277 +284 @@
 '''%prog [options] <command>
 
-Run about or help for details.'''
+For list of the commands available run:
+
+    $ shakespeare-admin help
+
+For more general information run the about or info commands.'''
     parser = optparse.OptionParser(usage)
     parser.add_option('-v', '--verbose', dest='verbose', help='Be verbose',
             action='store_true', default=False) 
+    parser.add_option('-c', '--config', dest='config',
+        help='Path to config file', default=None)
     options, args = parser.parse_args()
     
@@ -287 +300 @@
         return 1
     else:
-        cmd = ShakespeareAdmin(verbose=options.verbose)
+        cmd = ShakespeareAdmin(verbose=options.verbose, config=options.config)
         args = ' '.join(args)
         args = args.replace('-','_')