remove unused TBContext.db_module field (#2574)

Author: nfelt

tensorboard/backend/application.py

@@ -121,28 +121,27 @@ def standard_tensorboard_wsgi(flags, plugin_loaders, assets_zip_provider):
   loading_multiplexer = multiplexer
   reload_interval = flags.reload_interval
   db_uri = flags.db
+  db_connection_provider = None
   # For DB import mode, create a DB file if we weren't given one.
   if flags.db_import and not flags.db:
     tmpdir = tempfile.mkdtemp(prefix='tbimport')
     atexit.register(shutil.rmtree, tmpdir)
     db_uri = 'sqlite:%s/tmp.sqlite' % tmpdir
-  db_module, db_connection_provider = get_database_info(db_uri)
   if flags.db_import:
     # DB import mode.
-    if db_module != sqlite3:
-      raise base_plugin.FlagsError('--db_import is only compatible with sqlite DBs')
     logger.info('Importing logdir into DB at %s', db_uri)
+    db_connection_provider = create_sqlite_connection_provider(db_uri)
     loading_multiplexer = db_import_multiplexer.DbImportMultiplexer(
         db_connection_provider=db_connection_provider,
         purge_orphaned_data=flags.purge_orphaned_data,
         max_reload_threads=flags.max_reload_threads)
   elif flags.db:
     # DB read-only mode, never load event logs.
     reload_interval = -1
+    db_connection_provider = create_sqlite_connection_provider(db_uri)
   plugin_name_to_instance = {}
   context = base_plugin.TBContext(
       data_provider=data_provider,
-      db_module=db_module,
       db_connection_provider=db_connection_provider,
       db_uri=db_uri,
       flags=flags,
@@ -492,28 +491,6 @@ def _reload():
     raise ValueError('unrecognized reload_task: %s' % reload_task)
 
 
-def get_database_info(db_uri):
-  """Returns TBContext fields relating to SQL database.
-
-  Args:
-    db_uri: A string URI expressing the DB file, e.g. "sqlite:~/tb.db".
-
-  Returns:
-    A tuple with the db_module and db_connection_provider TBContext fields. If
-    db_uri was empty, then (None, None) is returned.
-
-  Raises:
-    ValueError: If db_uri scheme is not supported.
-  """
-  if not db_uri:
-    return None, None
-  scheme = urlparse.urlparse(db_uri).scheme
-  if scheme == 'sqlite':
-    return sqlite3, create_sqlite_connection_provider(db_uri)
-  else:
-    raise ValueError('Only sqlite DB URIs are supported now: ' + db_uri)
-
-
 def create_sqlite_connection_provider(db_uri):
   """Returns function that returns SQLite Connection objects.
 
@@ -529,7 +506,7 @@ def create_sqlite_connection_provider(db_uri):
   """
   uri = urlparse.urlparse(db_uri)
   if uri.scheme != 'sqlite':
-    raise ValueError('Scheme is not sqlite: ' + db_uri)
+    raise ValueError('Only sqlite DB URIs are supported: ' + db_uri)
   if uri.netloc:
     raise ValueError('Can not connect to SQLite over network: ' + db_uri)
   if uri.path == ':memory:':

tensorboard/backend/application_test.py

@@ -692,22 +692,24 @@ class DbTest(tb_test.TestCase):
 
   def testSqliteDb(self):
     db_uri = 'sqlite:' + os.path.join(self.get_temp_dir(), 'db')
-    db_module, db_connection_provider = application.get_database_info(db_uri)
-    self.assertTrue(hasattr(db_module, 'Date'))
+    db_connection_provider = application.create_sqlite_connection_provider(
+        db_uri)
     with contextlib.closing(db_connection_provider()) as conn:
       with conn:
         with contextlib.closing(conn.cursor()) as c:
           c.execute('create table peeps (name text)')
           c.execute('insert into peeps (name) values (?)', ('justine',))
-    _, db_connection_provider = application.get_database_info(db_uri)
+    db_connection_provider = application.create_sqlite_connection_provider(
+        db_uri)
     with contextlib.closing(db_connection_provider()) as conn:
       with contextlib.closing(conn.cursor()) as c:
         c.execute('select name from peeps')
         self.assertEqual(('justine',), c.fetchone())
 
   def testTransactionRollback(self):
     db_uri = 'sqlite:' + os.path.join(self.get_temp_dir(), 'db')
-    _, db_connection_provider = application.get_database_info(db_uri)
+    db_connection_provider = application.create_sqlite_connection_provider(
+        db_uri)
     with contextlib.closing(db_connection_provider()) as conn:
       with conn:
         with contextlib.closing(conn.cursor()) as c:
@@ -727,7 +729,8 @@ def testTransactionRollback_doesntDoAnythingIfIsolationLevelIsNone(self):
     # NOTE: This is a terrible idea. Don't do this.
     db_uri = ('sqlite:' + os.path.join(self.get_temp_dir(), 'db') +
               '?isolation_level=null')
-    _, db_connection_provider = application.get_database_info(db_uri)
+    db_connection_provider = application.create_sqlite_connection_provider(
+        db_uri)
     with contextlib.closing(db_connection_provider()) as conn:
       with conn:
         with contextlib.closing(conn.cursor()) as c:

tensorboard/plugins/base_plugin.py

@@ -153,7 +153,6 @@ def __init__(
       assets_zip_provider=None,
       data_provider=None,
       db_connection_provider=None,
-      db_module=None,
       db_uri=None,
       flags=None,
       logdir=None,
@@ -181,9 +180,6 @@ def __init__(
           function is cheap. The returned connection must only be used by a
           single thread. Things like connection pooling are considered
           implementation details of the provider.
-      db_module: A PEP-249 DB Module, e.g. sqlite3. This is useful for accessing
-          things like date time constructors. This value will be None if we are
-          not in SQL mode and multiplexer should be used instead.
       db_uri: The string db URI TensorBoard was started with. If this is set,
           the logdir should be None.
       flags: An object of the runtime flags provided to TensorBoard to their
@@ -203,7 +199,6 @@ def __init__(
     self.assets_zip_provider = assets_zip_provider
     self.data_provider = data_provider
     self.db_connection_provider = db_connection_provider
-    self.db_module = db_module
     self.db_uri = db_uri
     self.flags = flags
     self.logdir = logdir

tensorboard/plugins/core/core_plugin_test.py

@@ -311,11 +311,10 @@ def _start_logdir_based_server(self, temp_dir):
     self.logdir_based_server = werkzeug_test.Client(app, wrappers.BaseResponse)
 
   def _start_db_based_server(self):
-    db_module, db_connection_provider = application.get_database_info(
+    db_connection_provider = application.create_sqlite_connection_provider(
         self.db_uri)
     context = base_plugin.TBContext(
         assets_zip_provider=get_test_assets_zip_provider(),
-        db_module=db_module,
         db_connection_provider=db_connection_provider,
         db_uri=self.db_uri,
         window_title='title foo')

tensorboard/plugins/scalar/scalars_plugin_test.py

@@ -79,10 +79,9 @@ def load_runs(self, run_names):
   def set_up_db(self):
     self.db_path = os.path.join(self.get_temp_dir(), 'db.db')
     self.db_uri = 'sqlite:' + self.db_path
-    db_module, db_connection_provider = application.get_database_info(
+    db_connection_provider = application.create_sqlite_connection_provider(
         self.db_uri)
     context = base_plugin.TBContext(
-        db_module=db_module,
         db_connection_provider=db_connection_provider,
         db_uri=self.db_uri)
     self.core_plugin = core_plugin.CorePlugin(context)