Merge branch 'schema-sanity'
[zzz-pokedex.git] / pokedex / db / load.py
index 2b14883..e6b3287 100644 (file)
 """CSV to database or vice versa."""
 import csv
-import pkg_resources
+import fnmatch
+import os.path
 import sys
 
 from sqlalchemy.orm.attributes import instrumentation_registry
+import sqlalchemy.sql.util
 import sqlalchemy.types
 
 from pokedex.db import metadata
 import pokedex.db.tables as tables
+from pokedex.defaults import get_default_csv_dir
 
 
+def _get_table_names(metadata, patterns):
+    """Returns a list of table names from the given metadata.  If `patterns`
+    exists, only tables matching one of the patterns will be returned.
+    """
+    if patterns:
+        table_names = set()
+        for pattern in patterns:
+            if '.' in pattern or '/' in pattern:
+                # If it looks like a filename, pull out just the table name
+                _, filename = os.path.split(pattern)
+                table_name, _ = os.path.splitext(filename)
+                pattern = table_name
+
+            table_names.update(fnmatch.filter(metadata.tables.keys(), pattern))
+    else:
+        table_names = metadata.tables.keys()
+
+    return list(table_names)
+
 def _get_verbose_prints(verbose):
-    """If `verbose` is true, returns two functions: one for printing a starting
-    message, and the other for printing a success or failure message when
-    finished.
+    """If `verbose` is true, returns three functions: one for printing a
+    starting message, one for printing an interim status update, and one for
+    printing a success or failure message when finished.
 
-    If `verbose` is false, returns two no-op functions.
+    If `verbose` is false, returns no-op functions.
     """
 
-    if verbose:
-        import sys
-        def print_start(thing):
-            # Truncate to 66 characters, leaving 10 characters for a success
-            # or failure message
-            truncated_thing = thing[0:66]
+    if not verbose:
+        # Return dummies
+        def dummy(*args, **kwargs):
+            pass
+
+        return dummy, dummy, dummy
+
+    ### Okay, verbose == True; print stuff
 
-            # Also, space-pad to keep the cursor in a known column
-            num_spaces = 66 - len(truncated_thing)
+    def print_start(thing):
+        # Truncate to 66 characters, leaving 10 characters for a success
+        # or failure message
+        truncated_thing = thing[0:66]
 
-            print "%s...%s" % (truncated_thing, ' ' * num_spaces),
+        # Also, space-pad to keep the cursor in a known column
+        num_spaces = 66 - len(truncated_thing)
+
+        print "%s...%s" % (truncated_thing, ' ' * num_spaces),
+        sys.stdout.flush()
+
+    if sys.stdout.isatty():
+        # stdout is a terminal; stupid backspace tricks are OK.
+        # Don't use print, because it always adds magical spaces, which
+        # makes backspace accounting harder
+
+        backspaces = [0]
+        def print_status(msg):
+            # Overwrite any status text with spaces before printing
+            sys.stdout.write('\b' * backspaces[0])
+            sys.stdout.write(' ' * backspaces[0])
+            sys.stdout.write('\b' * backspaces[0])
+            sys.stdout.write(msg)
             sys.stdout.flush()
+            backspaces[0] = len(msg)
 
         def print_done(msg='ok'):
-            print msg
+            # Overwrite any status text with spaces before printing
+            sys.stdout.write('\b' * backspaces[0])
+            sys.stdout.write(' ' * backspaces[0])
+            sys.stdout.write('\b' * backspaces[0])
+            sys.stdout.write(msg + "\n")
             sys.stdout.flush()
+            backspaces[0] = 0
 
-        return print_start, print_done
+    else:
+        # stdout is a file (or something); don't bother with status at all
+        def print_status(msg):
+            pass
 
-    # Not verbose; return dummies
-    def dummy(*args, **kwargs):
-        pass
+        def print_done(msg='ok'):
+            print msg
 
-    return dummy, dummy
+    return print_start, print_status, print_done
 
 
-def load(session, directory=None, drop_tables=False, verbose=False):
+def load(session, tables=[], directory=None, drop_tables=False, verbose=False, safe=True):
     """Load data from CSV files into the given database session.
 
     Tables are created automatically.
@@ -52,6 +103,9 @@ def load(session, directory=None, drop_tables=False, verbose=False):
     `session`
         SQLAlchemy session to use.
 
+    `tables`
+        List of tables to load.  If omitted, all tables are loaded.
+
     `directory`
         Directory the CSV files reside in.  Defaults to the `pokedex` data
         directory.
@@ -61,38 +115,56 @@ def load(session, directory=None, drop_tables=False, verbose=False):
 
     `verbose`
         If set to True, status messages will be printed to stdout.
+
+    `safe`
+        If set to False, load can be faster, but can corrupt the database if
+        it crashes or is interrupted.
     """
 
     # First take care of verbosity
-    print_start, print_done = _get_verbose_prints(verbose)
+    print_start, print_status, print_done = _get_verbose_prints(verbose)
 
 
-    if not directory:
-        directory = pkg_resources.resource_filename('pokedex', 'data/csv')
+    if directory is None:
+        directory = get_default_csv_dir()
+
+    table_names = _get_table_names(metadata, tables)
+    table_objs = [metadata.tables[name] for name in table_names]
+    table_objs = sqlalchemy.sql.util.sort_tables(table_objs)
+
+    # SQLite speed tweaks
+    if not safe and session.connection().dialect.name == 'sqlite':
+        session.connection().execute("PRAGMA synchronous=OFF")
+        session.connection().execute("PRAGMA journal_mode=OFF")
 
     # Drop all tables if requested
     if drop_tables:
         print_start('Dropping tables')
-        metadata.drop_all()
+        for table in reversed(table_objs):
+            table.drop(checkfirst=True)
         print_done()
 
-    metadata.create_all()
+    for table in table_objs:
+        table.create()
     connection = session.connection()
 
     # Okay, run through the tables and actually load the data now
-    for table_obj in metadata.sorted_tables:
+    for table_obj in table_objs:
         table_name = table_obj.name
         insert_stmt = table_obj.insert()
 
         print_start(table_name)
 
         try:
-            csvfile = open("%s/%s.csv" % (directory, table_name), 'rb')
+            csvpath = "%s/%s.csv" % (directory, table_name)
+            csvfile = open(csvpath, 'rb')
         except IOError:
             # File doesn't exist; don't load anything!
             print_done('missing?')
             continue
 
+        csvsize = os.stat(csvpath).st_size
+
         reader = csv.reader(csvfile, lineterminator='\n')
         column_names = [unicode(column) for column in reader.next()]
 
@@ -115,6 +187,9 @@ def load(session, directory=None, drop_tables=False, verbose=False):
             session.commit()
             new_rows[:] = []
 
+            progress = "%d%%" % (100 * csvfile.tell() // csvsize)
+            print_status(progress)
+
         for csvs in reader:
             row_data = {}
 
@@ -163,7 +238,7 @@ def load(session, directory=None, drop_tables=False, verbose=False):
 
             # Remembering some zillion rows in the session consumes a lot of
             # RAM.  Let's not do that.  Commit every 1000 rows
-            if len(new_rows) > 1000:
+            if len(new_rows) >= 1000:
                 insert_and_commit()
 
         insert_and_commit()
@@ -184,15 +259,22 @@ def load(session, directory=None, drop_tables=False, verbose=False):
 
         print_done()
 
+    # SQLite check
+    if session.connection().dialect.name == 'sqlite':
+        session.connection().execute("PRAGMA integrity_check")
+
 
 
-def dump(session, directory=None, verbose=False):
+def dump(session, tables=[], directory=None, verbose=False):
     """Dumps the contents of a database to a set of CSV files.  Probably not
     useful to anyone besides a developer.
 
     `session`
         SQLAlchemy session to use.
 
+    `tables`
+        List of tables to dump.  If omitted, all tables are dumped.
+
     `directory`
         Directory the CSV files should be put in.  Defaults to the `pokedex`
         data directory.
@@ -202,13 +284,17 @@ def dump(session, directory=None, verbose=False):
     """
 
     # First take care of verbosity
-    print_start, print_done = _get_verbose_prints(verbose)
+    print_start, print_status, print_done = _get_verbose_prints(verbose)
 
 
     if not directory:
-        directory = pkg_resources.resource_filename('pokedex', 'data/csv')
+        directory = get_default_csv_dir()
+
+    table_names = _get_table_names(metadata, tables)
+    table_names.sort()
+
 
-    for table_name in sorted(metadata.tables.keys()):
+    for table_name in table_names:
         print_start(table_name)
         table = metadata.tables[table_name]