modified how configs are handled.

Author: dimitri-yatsenko

datajoint/__init__.py

@@ -47,23 +47,25 @@ class DataJointError(Exception):
 from .settings import Config, LOCALCONFIG, GLOBALCONFIG, logger, log_levels
 config = Config()
 
-
-if os.getenv('DJ_HOST') is not None and os.getenv('DJ_USER') is not None:  # pragma: no cover
-    print("Loading local settings from environment variables")
-    config['database.host'] = os.getenv('DJ_HOST')
-    config['database.user'] = os.getenv('DJ_USER')
-    config['database.password'] = os.getenv('DJ_PASS')
-elif os.path.exists(LOCALCONFIG):  # pragma: no cover
-    local_config_file = os.path.expanduser(LOCALCONFIG)
-    print("Loading local settings from {0:s}".format(local_config_file))
-    logger.log(logging.INFO, "Loading local settings from {0:s}".format(local_config_file))
-    config.load(local_config_file)
-elif os.path.exists(os.path.expanduser('~/') + GLOBALCONFIG):  # pragma: no cover
-    local_config_file = os.path.expanduser('~/') + GLOBALCONFIG
+config_files = (os.path.expanduser(n) for n in (LOCALCONFIG, '~/' + GLOBALCONFIG))
+try:
+    local_config_file = next(n for n in config_files if os.path.exists(n))
+except StopIteration:
+    local_config_file = None
+else:
     print("Loading local settings from {0:s}".format(local_config_file))
     logger.log(logging.INFO, "Loading local settings from {0:s}".format(local_config_file))
     config.load(local_config_file)
-else:
+
+# override login credentials with environment variables
+mapping = {k: v for k, v in zip(
+    ('database.host', 'database.user', 'database.password'),
+    map(os.getenv, ('DJ_HOST', 'DJ_USER', 'DJ_PASS')))
+           if v is not None}
+config.update(mapping)
+
+# create local config file if neither local nor global file exists
+if not mapping and local_config_file is None:
     print("""Cannot find configuration settings. Using default configuration. To change that, either
     * modify the local copy of %s that datajoint just saved for you
     * put a file named %s with the same configuration format in your home

datajoint/connection.py

@@ -17,7 +17,7 @@
 logger = logging.getLogger(__name__)
 
 
-def conn(host=None, user=None, passwd=None, init_fun=None, reset=False):
+def conn(host=None, user=None, password=None, init_fun=None, reset=False):
     """
     Returns a persistent connection object to be shared by multiple modules.
     If the connection is not yet established or reset=True, a new connection is set up.
@@ -27,18 +27,20 @@ def conn(host=None, user=None, passwd=None, init_fun=None, reset=False):
 
     :param host: hostname
     :param user: mysql user
-    :param passwd: mysql password
+    :param password: mysql password
     :param init_fun: initialization function
-    :param reset: whether the connection should be reseted or not
+    :param reset: whether the connection should be reset or not
     """
     if not hasattr(conn, 'connection') or reset:
         host = host if host is not None else config['database.host']
         user = user if user is not None else config['database.user']
-        passwd = passwd if passwd is not None else config['database.password']
-        if passwd is None:  # pragma: no cover
-            passwd = getpass(prompt="Please enter database password: ")
+        password = password if password is not None else config['database.password']
+        if user is None:  # pragma: no cover
+            user = input("Please enter DataJoint username: ")
+        if password is None:  # pragma: no cover
+            password = getpass(prompt="Please enter DataJoint password: ")
         init_fun = init_fun if init_fun is not None else config['connection.init_function']
-        conn.connection = Connection(host, user, passwd, init_fun)
+        conn.connection = Connection(host, user, password, init_fun)
     return conn.connection
 
 
@@ -51,17 +53,17 @@ class Connection:
 
     :param host: host name
     :param user: user name
-    :param passwd: password
-    :param init_fun: initialization function
+    :param password: password
+    :param init_fun: connection initialization function (SQL)
     """
 
-    def __init__(self, host, user, passwd, init_fun=None):
+    def __init__(self, host, user, password, init_fun=None):
         if ':' in host:
             host, port = host.split(':')
             port = int(port)
         else:
             port = config['database.port']
-        self.conn_info = dict(host=host, port=port, user=user, passwd=passwd)
+        self.conn_info = dict(host=host, port=port, user=user, passwd=password)
         self.init_fun = init_fun
         print("Connecting {user}@{host}:{port}".format(**self.conn_info))
         self._conn = None

datajoint/settings.py

@@ -38,16 +38,12 @@
 default = OrderedDict({
     'database.host': 'localhost',
     'database.password': None,
-    'database.user': 'datajoint',
+    'database.user': None,
     'database.port': 3306,
-    'database.reconnect': False,
-    #
     'connection.init_function': None,
-    #
+    'database.reconnect': False,
     'loglevel': 'INFO',
-    #
     'safemode': True,
-    #
     'display.limit': 7,
     'display.width': 14
 })
@@ -97,7 +93,6 @@ def __iter__(self):
     def __len__(self):
         return len(self.instance._conf)
 
-
     @contextmanager
     def __call__(self, **kwargs):
         """
@@ -106,17 +101,15 @@ def __call__(self, **kwargs):
         double underscore '__'. The context manager yields the changed config object.
 
         Example:
-
         >>> import datajoint as dj
-        >>> with dj.config(safe__mode=False) as cfg:
+        >>> with dj.config(safemode=False, database__host="localhost") as cfg:
         >>>     # do dangerous stuff here
-
         """
 
         try:
             backup = self.instance
             self.instance = Config.__Config(self.instance._conf)
-            new = {k.replace('__','.'):v for k,v in kwargs.items()}
+            new = {k.replace('__', '.'): v for k, v in kwargs.items()}
             self.instance._conf.update(new)
             yield self
         except:
@@ -125,15 +118,13 @@ def __call__(self, **kwargs):
         else:
             self.instance = backup
 
-
     class __Config:
         """
         Stores datajoint settings. Behaves like a dictionary, but applies validator functions
         when certain keys are set.
 
         The default parameters are stored in datajoint.settings.default . If a local config file
         exists, the settings specified in this file override the default settings.
-
         """
 
         def __init__(self, *args, **kwargs):
@@ -165,8 +156,7 @@ def save(self, filename=None):
         def load(self, filename):
             """
             Updates the setting from config file in JSON format.
-
-            :param filename=None: filename of the local JSON settings file. If None, the local config file is used.
+            :param filename: filename of the local JSON settings file. If None, the local config file is used.
             """
             if filename is None:
                 filename = LOCALCONFIG

requirements.txt

@@ -3,4 +3,4 @@ scipy
 pymysql
 pyparsing
 networkx
-matplotlib
+matplotlib

tests/__init__.py

@@ -22,7 +22,7 @@
 CONN_INFO = dict(
     host=environ.get('DJ_TEST_HOST', 'localhost'),
     user=environ.get('DJ_TEST_USER', 'datajoint'),
-    passwd=environ.get('DJ_TEST_PASSWORD', 'datajoint'))
+    password=environ.get('DJ_TEST_PASSWORD', 'datajoint'))
 
 # Prefix for all databases used during testing
 PREFIX = environ.get('DJ_TEST_DB_PREFIX', 'djtest')