From: Oleg Broytman <phd@phdru.name>
Date: Mon, 4 Apr 2016 19:52:08 +0000 (+0300)
Subject: Refactoring: move module-level initialization into functions
X-Git-Tag: 0.0.4~27
X-Git-Url: https://git.phdru.name/?a=commitdiff_plain;h=af6ee17b251b1ae074e1eca5d80c7a599ee88536;p=m_librarian.git

Refactoring: move module-level initialization into functions

Do not open a database at import time. This is necessary for further
development, especially tests.
---

diff --git a/m_librarian/config.py b/m_librarian/config.py
index c57406b..3609d34 100755
--- a/m_librarian/config.py
+++ b/m_librarian/config.py
@@ -1,32 +1,52 @@
 #! /usr/bin/env python
 
-__all__ = ['ml_conf']
+__all__ = ['get_config']
 
 import os
 from ConfigParser import SafeConfigParser
 
-config_dirs = []
-if 'XDG_CONFIG_HOME' in os.environ:
-    config_dirs.append(os.environ['XDG_CONFIG_HOME'])
-if 'XDG_CONFIG_DIRS' in os.environ:
-    config_dirs.extend(os.environ['XDG_CONFIG_DIRS'].split(':'))
-home_config = os.path.expanduser('~/.config')
-if home_config not in config_dirs:
-    config_dirs.append(home_config)
-
-for d in config_dirs:
-    ml_conf_file = os.path.join(d, 'm_librarian.conf')
-    if os.path.exists(ml_conf_file):
-        ml_conf = SafeConfigParser()
-        ml_conf.read(ml_conf_file)
-        break
-else:
-    ml_conf = ml_conf_file = None
+
+def _find_config_dirs_posix():
+    config_dirs = []
+    if 'XDG_CONFIG_HOME' in os.environ:
+        config_dirs.append(os.environ['XDG_CONFIG_HOME'])
+    if 'XDG_CONFIG_DIRS' in os.environ:
+        config_dirs.extend(os.environ['XDG_CONFIG_DIRS'].split(':'))
+    home_config = os.path.expanduser('~/.config')
+    if home_config not in config_dirs:
+        config_dirs.append(home_config)
+    return config_dirs
+
+
+def find_config_dirs():
+    if os.name == 'posix':
+        return _find_config_dirs_posix()
+    raise OSError("Unknow OS")
+
+
+def find_config_file(config_dirs=None):
+    if config_dirs is None:
+        config_dirs = find_config_dirs()
+    for d in config_dirs:
+        ml_conf_file = os.path.join(d, 'm_librarian.conf')
+        if os.path.exists(ml_conf_file):
+            return ml_conf_file
+    else:
+        raise IOError("Cannot find m_librarian.conf in %s" % config_dirs)
+
+
+def get_config(config_filename=None):
+    if config_filename is None:
+        config_filename = find_config_file()
+    ml_conf = SafeConfigParser()
+    ml_conf.read(config_filename)
+    return ml_conf
 
 
 def test():
+    config_dirs = find_config_dirs()
     print "Config dirs:", config_dirs
-    print "Config file:", ml_conf_file
+    print "Config file:", find_config_file(config_dirs)
 
 if __name__ == '__main__':
     test()
diff --git a/m_librarian/db.py b/m_librarian/db.py
index cd2f644..7ae3ed3 100755
--- a/m_librarian/db.py
+++ b/m_librarian/db.py
@@ -1,29 +1,36 @@
 #! /usr/bin/env python
 
 __all__ = ['Author', 'Book', 'Extension', 'Genre', 'Language',
-           'AuthorBook', 'BookGenre',
-           'init_db', 'insert_name', 'insert_author', 'update_counters',
+           'AuthorBook', 'BookGenre', 'open_db', 'init_db',
+           'insert_name', 'insert_author', 'update_counters',
            ]
 
 import os
 from sqlobject import SQLObject, StringCol, UnicodeCol, IntCol, BoolCol, \
     ForeignKey, DateCol, DatabaseIndex, RelatedJoin, \
     connectionForURI, sqlhub, SQLObjectNotFound, dberrors
-from .config import ml_conf
+from .config import get_config
 
-try:
-    db_uri = ml_conf.get('database', 'URI')
-except:
-    db_uri = None
 
-db_dirs = []
-if not db_uri:
+def _find_sqlite_db_dirs_posix():
+    db_dirs = []
     if 'XDG_CACHE_HOME' in os.environ:
         db_dirs.append(os.environ['XDG_CACHE_HOME'])
     home_cache = os.path.expanduser('~/.cache')
     if home_cache not in db_dirs:
         db_dirs.append(home_cache)
+    return db_dirs
 
+
+def find_sqlite_db_dirs():
+    if os.name == 'posix':
+        return _find_sqlite_db_dirs_posix()
+    raise OSError("Unknow OS")
+
+
+def find_sqlite_dburi(db_dirs=None):
+    if db_dirs is None:
+        db_dirs = find_sqlite_db_dirs()
     for d in db_dirs:
         db_file = os.path.join(d, 'm_librarian.sqlite')
         if os.path.exists(db_file):
@@ -39,29 +46,37 @@ if not db_uri:
             pass
         db_file = os.path.join(db_dir, 'm_librarian.sqlite')
 
-    db_uri = 'sqlite://%s' % db_file.replace(os.sep, '/')
+    return 'sqlite://%s' % db_file.replace(os.sep, '/')
 
 
-sqlhub.processConnection = connection = connectionForURI(db_uri)
+def open_db(db_uri=None):
+    if db_uri is None:
+        try:
+            db_uri = get_config().get('database', 'URI')
+        except:
+            db_uri = find_sqlite_dburi()
+
+    sqlhub.processConnection = connection = connectionForURI(db_uri)
 
-if connection.dbName == 'sqlite':
-    def lower(s):
-        return s.lower()
+    if connection.dbName == 'sqlite':
+        def lower(s):
+            return s.lower()
 
-    sqlite = connection.module
+        sqlite = connection.module
 
-    class MLConnection(sqlite.Connection):
-        def __init__(self, *args, **kwargs):
-            super(MLConnection, self).__init__(*args, **kwargs)
-            self.create_function('lower', 1, lower)
+        class MLConnection(sqlite.Connection):
+            def __init__(self, *args, **kwargs):
+                super(MLConnection, self).__init__(*args, **kwargs)
+                self.create_function('lower', 1, lower)
 
-    connection._connOptions['factory'] = MLConnection
+        # This hack must be done at the very beginning, before the first query
+        connection._connOptions['factory'] = MLConnection
 
-    # Speedup SQLite connection
-    connection.query("PRAGMA synchronous=OFF")
-    connection.query("PRAGMA count_changes=OFF")
-    connection.query("PRAGMA journal_mode=MEMORY")
-    connection.query("PRAGMA temp_store=MEMORY")
+        # Speedup SQLite connection
+        connection.query("PRAGMA synchronous=OFF")
+        connection.query("PRAGMA count_changes=OFF")
+        connection.query("PRAGMA journal_mode=MEMORY")
+        connection.query("PRAGMA temp_store=MEMORY")
 
 
 class Author(SQLObject):
@@ -193,9 +208,9 @@ def update_counters():
 
 
 def test():
+    db_dirs = find_sqlite_db_dirs()
     print "DB dirs:", db_dirs
-    if db_uri:
-        print "DB URI:", db_uri
+    print "DB URI:", find_sqlite_dburi()
 
 if __name__ == '__main__':
     test()
diff --git a/scripts/ml-import.py b/scripts/ml-import.py
index 73dc1a1..530e4a0 100755
--- a/scripts/ml-import.py
+++ b/scripts/ml-import.py
@@ -1,13 +1,14 @@
 #! /usr/bin/env python
 
 import sys
-from m_librarian.db import init_db, update_counters
+from m_librarian.db import open_db, init_db, update_counters
 from m_librarian.glst import import_glst
 from m_librarian.inp import import_inpx
 
 if __name__ == '__main__':
     if len(sys.argv) < 2:
         sys.exit("Usage: %s file.inpx..." % sys.argv[0])
+    open_db()
     init_db()
     import_glst()
     for inpx in sys.argv[1:]:
diff --git a/scripts/ml-initdb.py b/scripts/ml-initdb.py
index 0211187..4445fc6 100755
--- a/scripts/ml-initdb.py
+++ b/scripts/ml-initdb.py
@@ -1,9 +1,10 @@
 #! /usr/bin/env python
 
-from m_librarian.db import init_db
+from m_librarian.db import open_db, init_db
 from m_librarian.glst import import_glst
 
 if __name__ == '__main__':
+    open_db()
     init_db()
     old, new = import_glst()
     if old:
diff --git a/scripts/ml-search.py b/scripts/ml-search.py
index 231bdc4..8598edb 100755
--- a/scripts/ml-search.py
+++ b/scripts/ml-search.py
@@ -3,6 +3,7 @@
 import argparse
 import sys
 from m_lib.defenc import default_encoding
+from m_librarian.db import open_db
 from m_librarian.search import search_authors, search_books, \
     search_extensions, search_genres, search_languages
 from m_librarian.translations import translations
@@ -66,4 +67,5 @@ if __name__ == '__main__':
         case_sensitive = False
     else:
         case_sensitive = None  # guess case sensitivity
+    open_db()
     args.func(case_sensitive, args)