better locating of settings.py

Addresses pyeve#137.
Addresses pyeve#209.
Addresses pyeve#713.
Addresses pyeve#918.
Closes pyeve#820.

Author: mklappir

.gitignore

@@ -51,6 +51,9 @@ Include
 Lib
 Scripts
 
+#pyenv
+.python-version
+
 #OSX
 .Python
 .DS_Store
@@ -60,3 +63,5 @@ _build
 
 # PyCharm
 .idea
+
+.cache

AUTHORS

@@ -88,6 +88,7 @@ Patches and Contributions
 - Marc Abramowitz
 - Marcus Cobden
 - Marica Odagaki
+- Mario Kralj
 - Massimo Scamarcia
 - Mateusz Łoskot
 - Matt Creenan

docs/config.rst

@@ -3,13 +3,22 @@
 Configuration
 =============
 Generally Eve configuration is best done with configuration files. The
-configuration files themselves are actual Python files.
+configuration files themselves are actual Python files. However, Eve will
+give precedence to dictionary-based settings first, then it will try to
+locate a file passed in :envvar:`EVE_SETTINGS` environmental variable (if
+set) and finally it will try to locate `settings.py` or a file with filename
+passed to `settings` flag in constructor.
 
-Configuration with Files
+Configuration With Files
 ------------------------
-On startup, Eve will look for a `settings.py` file in the application folder.
-You can choose an alternative filename/path. Just pass it as an argument when
-you instantiate the application.
+On startup, if `settings` flag is omitted in constructor, Eve will try to locate
+file named `settings.py`, first in the application folder and then in one of the
+application's subfolders. You can choose an alternative filename/path, just pass
+it as an argument when you instantiate the application. If the file path is
+relative, Eve will try to locate it recursively in one of the folders in your
+`sys.path`, therefore you have to be sure that your application root is appended
+to it. This is useful, for example, in testing environments, when settings file
+is not necessarily located in the root of your application.
 
 .. code-block:: python
 
@@ -18,21 +27,24 @@ you instantiate the application.
     app = Eve(settings='my_settings.py')
     app.run()
 
-Configuration with a Dictionary
+Configuration With a Dictionary
 -------------------------------
-Alternatively, you can choose to provide a settings dictionary:
+Alternatively, you can choose to provide a settings dictionary. Unlike
+configuring Eve with the settings file, dictionary-based approach will only
+update Eve's default settings with your own values, rather than overwriting
+all the settings.
 
 .. code-block:: python
 
+    from eve import Eve
+
     my_settings = {
         'MONGO_HOST': 'localhost',
         'MONGO_PORT': 27017,
         'MONGO_DBNAME': 'the_db_name',
         'DOMAIN': {'contacts': {}}
     }
 
-    from eve import Eve
-
     app = Eve(settings=my_settings)
     app.run()
 

eve/flaskapp.py

@@ -9,6 +9,7 @@
     :copyright: (c) 2017 by Nicola Iarocci.
     :license: BSD, see LICENSE for more details.
 """
+import fnmatch
 import os
 import sys
 
@@ -227,21 +228,34 @@ def load_config(self):
             if os.path.isabs(self.settings):
                 pyfile = self.settings
             else:
-                abspath = os.path.abspath(os.path.dirname(sys.argv[0]))
-                pyfile = os.path.join(abspath, self.settings)
+                def find_settings_file(file_name):
+                    # check if we can locate the file from sys.argv[0]
+                    abspath = os.path.abspath(os.path.dirname(sys.argv[0]))
+                    settings_file = os.path.join(abspath, file_name)
+                    if os.path.isfile(settings_file):
+                        return settings_file
+                    else:
+                        # try to find settings.py in one of the
+                        # paths in sys.path
+                        for p in sys.path:
+                            for root, dirs, files in os.walk(p):
+                                for f in fnmatch.filter(files, file_name):
+                                    if os.path.isfile(os.path.join(root, f)):
+                                        return os.path.join(root, file_name)
+
+                # try to load file from environment variable or settings.py
+                pyfile = find_settings_file(
+                    os.environ.get('EVE_SETTINGS') or self.settings
+                )
+
+            if not pyfile:
+                raise IOError('Could not load settings.')
+
             try:
                 self.config.from_pyfile(pyfile)
-            except IOError:
-                # assume envvar is going to be used exclusively
-                pass
             except:
                 raise
 
-        # overwrite settings with custom environment variable
-        envvar = 'EVE_SETTINGS'
-        if os.environ.get(envvar):
-            self.config.from_envvar(envvar)
-
         # flask-pymongo compatibility
         self.config['MONGO_CONNECT'] = self.config['MONGO_OPTIONS'].get(
             'connect', True

eve/tests/config.py

@@ -95,6 +95,13 @@ def test_settings_as_dict(self):
         # did not reset other defaults
         self.assertEqual(self.app.config['MONGO_WRITE_CONCERN'], {'w': 1})
 
+    def test_existing_env_config(self):
+        env = os.environ
+        os.environ = {'EVE_SETTINGS': 'test_settings_env.py'}
+        self.app = Eve()
+        self.assertTrue('env_domain' in self.app.config['DOMAIN'])
+        os.environ = env
+
     def test_unexisting_env_config(self):
         env = os.environ
         try:

eve/tests/test_settings_env.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+# this is just a helper file which we are going
+# to try to load with environmental variable in
+# test_existing_env_config() test case
+
+DOMAIN = {'env_domain': {}}