X-Git-Url: http://git.veekun.com/zzz-pokedex.git/blobdiff_plain/97bea32b7f588a65731e421b6338b45d2fe6dc72..1136f6cf582e59265f6ce096b269c7403c918296:/pokedex/__init__.py diff --git a/pokedex/__init__.py b/pokedex/__init__.py index 499d8d2..393979c 100644 --- a/pokedex/__init__.py +++ b/pokedex/__init__.py @@ -1,10 +1,13 @@ # encoding: utf8 from optparse import OptionParser +import os import sys -from .db import connect, metadata +import pokedex.db import pokedex.db.load +import pokedex.db.tables import pokedex.lookup +from pokedex import defaults def main(): if len(sys.argv) <= 1: @@ -26,39 +29,194 @@ def main(): command_help() -def command_dump(*args): +def get_parser(verbose=True): + """Returns an OptionParser prepopulated with the global options. + + `verbose` is whether or not the options should be verbose by default. + """ parser = OptionParser() parser.add_option('-e', '--engine', dest='engine_uri', default=None) + parser.add_option('-i', '--index', dest='index_dir', default=None) + parser.add_option('-q', '--quiet', dest='verbose', default=verbose, action='store_false') + parser.add_option('-v', '--verbose', dest='verbose', default=verbose, action='store_true') + return parser + +def get_session(options): + """Given a parsed options object, connects to the database and returns a + session. + """ + + engine_uri = options.engine_uri + got_from = 'command line' + + if engine_uri is None: + engine_uri, got_from = defaults.get_default_db_uri_with_origin() + + session = pokedex.db.connect(engine_uri) + + if options.verbose: + print "Connected to database {engine} (from {got_from})" \ + .format(engine=session.bind.url, got_from=got_from) + + return session + +def get_lookup(options, session=None, recreate=False): + """Given a parsed options object, opens the whoosh index and returns a + PokedexLookup object. + """ + + if recreate and not session: + raise ValueError("get_lookup() needs an explicit session to regen the index") + + index_dir = options.index_dir + got_from = 'command line' + + if index_dir is None: + index_dir, got_from = defaults.get_default_index_dir_with_origin() + + if options.verbose: + print "Opened lookup index {index_dir} (from {got_from})" \ + .format(index_dir=index_dir, got_from=got_from) + + lookup = pokedex.lookup.PokedexLookup(index_dir, session=session) + + if recreate: + lookup.rebuild_index() + + return lookup + +def get_csv_directory(options): + """Prints and returns the csv directory we're about to use.""" + + if not options.verbose: + return + + csvdir = options.directory + got_from = 'command line' + + if csvdir is None: + csvdir, got_from = defaults.get_default_csv_dir_with_origin() + + print "Using CSV directory {csvdir} (from {got_from})" \ + .format(csvdir=csvdir, got_from=got_from) + + return csvdir + + +### Plumbing commands + +def command_dump(*args): + parser = get_parser(verbose=True) parser.add_option('-d', '--directory', dest='directory', default=None) - parser.add_option('-q', '--quiet', dest='verbose', default=True, action='store_false') - options, _ = parser.parse_args(list(args)) + options, tables = parser.parse_args(list(args)) + + session = get_session(options) + get_csv_directory(options) - session = connect(options.engine_uri) pokedex.db.load.dump(session, directory=options.directory, + tables=tables, verbose=options.verbose) def command_load(*args): - parser = OptionParser() - parser.add_option('-e', '--engine', dest='engine_uri', default=None) + parser = get_parser(verbose=True) parser.add_option('-d', '--directory', dest='directory', default=None) parser.add_option('-D', '--drop-tables', dest='drop_tables', default=False, action='store_true') - parser.add_option('-q', '--quiet', dest='verbose', default=True, action='store_false') - options, _ = parser.parse_args(list(args)) + options, tables = parser.parse_args(list(args)) + + if not options.engine_uri: + print "WARNING: You're reloading the default database, but not the lookup index. They" + print " might get out of sync, and pokedex commands may not work correctly!" + print "To fix this, run `pokedex reindex` when this command finishes. Or, just use" + print "`pokedex setup` to do both at once." + print - session = connect(options.engine_uri) + session = get_session(options) + get_csv_directory(options) pokedex.db.load.load(session, directory=options.directory, drop_tables=options.drop_tables, + tables=tables, verbose=options.verbose) +def command_reindex(*args): + parser = get_parser(verbose=True) + options, _ = parser.parse_args(list(args)) + + session = get_session(options) + lookup = get_lookup(options, session=session, recreate=True) + + print "Recreated lookup index." + + def command_setup(*args): - session = connect() - pokedex.db.load.load(session, verbose=False, drop_tables=True) - pokedex.lookup.PokedexLookup(session=session, recreate=True) + parser = get_parser(verbose=False) + options, _ = parser.parse_args(list(args)) + + options.directory = None + + session = get_session(options) + get_csv_directory(options) + pokedex.db.load.load(session, directory=None, drop_tables=True, + verbose=options.verbose) + + lookup = get_lookup(options, session=session, recreate=True) + + print "Recreated lookup index." + + +def command_status(*args): + parser = get_parser(verbose=True) + options, _ = parser.parse_args(list(args)) + options.verbose = True + options.directory = None + + # Database, and a lame check for whether it's been inited at least once + session = get_session(options) + print " - OK! Connected successfully." + + if pokedex.db.tables.Pokemon.__table__.exists(session.bind): + print " - OK! Database seems to contain some data." + else: + print " - WARNING: Database appears to be empty." + + # CSV; simple checks that the dir exists + csvdir = get_csv_directory(options) + if not os.path.exists(csvdir): + print " - ERROR: No such directory!" + elif not os.path.isdir(csvdir): + print " - ERROR: Not a directory!" + else: + print " - OK! Directory exists." + + if os.access(csvdir, os.R_OK): + print " - OK! Can read from directory." + else: + print " - ERROR: Can't read from directory!" + + if os.access(csvdir, os.W_OK): + print " - OK! Can write to directory." + else: + print " - WARNING: Can't write to directory! " \ + "`dump` will not work. You may need to sudo." + + # Index; the PokedexLookup constructor covers most tests and will + # cheerfully bomb if they fail + lookup = get_lookup(options, recreate=False) + print " - OK! Opened successfully." -def command_lookup(name): - results = pokedex.lookup.PokedexLookup().lookup(name) +### User-facing commands + +def command_lookup(*args): + parser = get_parser(verbose=False) + options, words = parser.parse_args(list(args)) + + name = u' '.join(words) + + session = get_session(options) + lookup = get_lookup(options, session=session, recreate=False) + + results = lookup.lookup(name) if not results: print "No matches." elif results[0].exact: @@ -83,6 +241,7 @@ def command_help(): print u"""pokedex -- a command-line Pokédex interface usage: pokedex {command} [options...] Run `pokedex setup` first, or nothing will work! +See http://bugs.veekun.com/projects/pokedex/wiki/CLI for more documentation. Commands: help Displays this message. @@ -91,19 +250,33 @@ Commands: System commands: load Load Pokédex data into a database from CSV files. dump Dump Pokédex data from a database into CSV files. - setup Loads Pokédex data into the right place and creates a - lookup index in the right place. No options or output. - This will blow away the default database and index! + reindex Rebuilds the lookup index from the database. + setup Combines load and reindex. + status No effect, but prints which engine, index, and csv + directory would be used for other commands. -Options: - -d|--directory By default, load and dump will use the CSV files in the +Global options: + -e|--engine=URI By default, all commands try to use a SQLite database + in the pokedex install directory. Use this option (or + a POKEDEX_DB_ENGINE environment variable) to specify an + alternate database. + -i|--index=DIR By default, all commands try to put the lookup index in + the pokedex install directory. Use this option (or a + POKEDEX_INDEX_DIR environment variable) to specify an + alternate loction. + -q|--quiet Don't print system output. This is the default for + non-system commands and setup. + -v|--verbose Print system output. This is the default for system + commands, except setup. + +System options: + -d|--directory=DIR By default, load and dump will use the CSV files in the pokedex install directory. Use this option to specify a different directory. -D|--drop-tables With load, drop all tables before loading data. - -e|--engine=URI By default, all commands try to use a SQLite database - in the pokedex install directory. Use this option to - specify an alternate database. - -q|--quiet Turn off any unnecessary status output from dump/load. + + Additionally, load and dump accept a list of table names (possibly with + wildcards) and/or csv fileames as an argument list. """.encode(sys.getdefaultencoding(), 'replace') sys.exit(0)