Set ENV_LOAD_ALL=False by default

README.rst

@@ -90,9 +90,7 @@ ENV_LOAD_ALL
   Whether or not to load all environment variables for the configuration object.
   When :code:`False` only settings predefined on the configuration object are loaded, all others are ignored.
   When :code:`True` all environment variables defined in :code:`os.environ` will get loaded into your configuration object.
-  (default :code:`True`)
-
-  Note: Future versions will have default of :code:`False`.
+  (default :code:`False`)
 
 
 Setting configuration values

flask_env.py

@@ -13,7 +13,7 @@ class MetaFlaskEnv(type):
 
         # Get our internal settings
         prefix = dict.get('ENV_PREFIX', '')
-        load_all = dict.get('ENV_LOAD_ALL', True)
+        load_all = dict.get('ENV_LOAD_ALL', False)
 
         # Override default configuration from environment variables
         for key, value in os.environ.items():

test_flask_env.py

@@ -1,3 +1,4 @@
+import contextlib
 import os
 import unittest
 
@@ -5,6 +6,20 @@ from flask_env import MetaFlaskEnv
 
 
 class TestFlaskEnv(unittest.TestCase):
+    @contextlib.contextmanager
+    def with_env(self, **kwargs):
+        """Context manager to set temporary environment variables and then remove when done"""
+        # Set environment variables
+        os.environ.update(kwargs)
+
+        # Yield to caller
+        yield
+
+        # Delete set variables
+        for key in kwargs.keys():
+            if key in os.environ:
+                del os.environ[key]
+
     def _get_test_configuration(self, env_prefix='', env_load_all=False, **kwargs):
         """Helper to define a new configuration class using our MetaFlaskEnv"""
         return MetaFlaskEnv('TestConfiguration', (object, ), dict(
@@ -16,13 +31,15 @@ class TestFlaskEnv(unittest.TestCase):
     def test_default_env_load_all(self):
         """A test to ensure that we load all environment variables by default"""
         # Configure an environment variable not defined on the configuration class
-        os.environ['TEST_SETTING'] = 'true'
-
-        # Create our configuration object
-        TestConfiguration = MetaFlaskEnv('TestConfiguration', (object, ), dict())
-
-        # Assert that we loaded all environment variables
-        self.assertTrue(TestConfiguration.TEST_SETTING)
+        with self.with_env(TEST_SETTING='true', DEFAULT_SETTING='set_by_env'):
+            # Create our configuration object
+            TestConfiguration = MetaFlaskEnv('TestConfiguration', (object, ), dict(
+                DEFAULT_SETTING='set_in_class',
+            ))
+
+        # Assert that we only loaded defined settings from environment
+        self.assertFalse(hasattr(TestConfiguration, 'TEST_SETTING'))
+        self.assertEqual(TestConfiguration.DEFAULT_SETTING, 'set_by_env')
 
 
     def test_default_settings(self):
@@ -32,83 +49,79 @@ class TestFlaskEnv(unittest.TestCase):
 
     def test_override_from_env(self):
         """A test to ensure that an environment variable will override the default setting"""
-        # DEV: We have to set the environment variable first, since they get loaded into the class on definition
-        os.environ['DEFAULT_SETTING'] = 'set_by_env'
-
-        TestConfiguration = self._get_test_configuration(DEFAULT_SETTING='default_value')
-        self.assertEqual(TestConfiguration.DEFAULT_SETTING, 'set_by_env')
+        with self.with_env(DEFAULT_SETTING='set_by_env'):
+            TestConfiguration = self._get_test_configuration(DEFAULT_SETTING='default_value')
+            self.assertEqual(TestConfiguration.DEFAULT_SETTING, 'set_by_env')
 
     def test_only_set_on_env(self):
         """A test to ensure that a setting only defined by an environment variable is still available"""
-        # DEV: We have to set the environment variable first, since they get loaded into the class on definition
-        os.environ['NEW_SETTING'] = 'set_by_env'
-
-        # When configured to load all environment variables
-        TestConfiguration = self._get_test_configuration(env_load_all=True)
-        self.assertEqual(TestConfiguration.NEW_SETTING, 'set_by_env')
+        with self.with_env(NEW_SETTING='set_by_env'):
+            # When configured to load all environment variables
+            TestConfiguration = self._get_test_configuration(env_load_all=True)
+            self.assertEqual(TestConfiguration.NEW_SETTING, 'set_by_env')
 
-        # When configured to not load all environment variables
-        TestConfiguration = self._get_test_configuration(env_load_all=False)
-        self.assertFalse(hasattr(TestConfiguration, 'NEW_SETTING'))
+            # When configured to not load all environment variables
+            TestConfiguration = self._get_test_configuration(env_load_all=False)
+            self.assertFalse(hasattr(TestConfiguration, 'NEW_SETTING'))
 
     def test_env_prefix(self):
         """A test to ensure that the ENV_PREFIX setting functions as needed"""
-        # DEV: We have to set the environment variable first, since they get loaded into the class on definition
-        os.environ['TEST_DEFAULT_SETTING'] = 'set_by_env'
-
-        TestConfiguration = self._get_test_configuration(env_prefix='TEST_', DEFAULT_SETTING='default_value')
-        self.assertEqual(TestConfiguration.DEFAULT_SETTING, 'set_by_env')
+        with self.with_env(TEST_DEFAULT_SETTING='set_by_env'):
+            TestConfiguration = self._get_test_configuration(env_prefix='TEST_', DEFAULT_SETTING='default_value')
+            self.assertEqual(TestConfiguration.DEFAULT_SETTING, 'set_by_env')
 
     def test_env_prefix_non_matching(self):
         """A test to ensure that the ENV_PREFIX setting does not allow non-matching settings in"""
-        # DEV: We have to set the environment variable first, since they get loaded into the class on definition
-        os.environ['DEFAULT_SETTING'] = 'set_by_env'
-
-        TestConfiguration = self._get_test_configuration(env_prefix='MYAPP_', DEFAULT_SETTING='default_value')
-        self.assertEqual(TestConfiguration.DEFAULT_SETTING, 'default_value')
+        with self.with_env(DEFAULT_SETTING='set_by_env'):
+            TestConfiguration = self._get_test_configuration(env_prefix='MYAPP_', DEFAULT_SETTING='default_value')
+            self.assertEqual(TestConfiguration.DEFAULT_SETTING, 'default_value')
 
     def test_parsing_boolean(self):
         """A test to ensure that we properly parse booleans"""
         # DEV: We have to set the environment variable first, since they get loaded into the class on definition
-        os.environ['IS_TRUE'] = 'true'
-        os.environ['IS_NOT_TRUE'] = 'true-ish'
-        os.environ['IS_FALSE'] = 'FALSE'
-        os.environ['IS_WACKY_FALSE'] = 'FaLSe'
-
-        # DEV: Set `env_load_all=True` to keep from having to make default values for each variable
-        TestConfiguration = self._get_test_configuration(env_load_all=True)
-        self.assertEqual(TestConfiguration.IS_TRUE, True)
-        self.assertEqual(TestConfiguration.IS_NOT_TRUE, 'true-ish')
-        self.assertEqual(TestConfiguration.IS_FALSE, False)
-        self.assertEqual(TestConfiguration.IS_WACKY_FALSE, False)
+        env = dict(
+            IS_TRUE='true',
+            IS_NOT_TRUE='true-ish',
+            IS_FALSE='FALSE',
+            IS_WACKY_FALSE='FaLSe',
+        )
+        with self.with_env(**env):
+            # DEV: Set `env_load_all=True` to keep from having to make default values for each variable
+            TestConfiguration = self._get_test_configuration(env_load_all=True)
+            self.assertEqual(TestConfiguration.IS_TRUE, True)
+            self.assertEqual(TestConfiguration.IS_NOT_TRUE, 'true-ish')
+            self.assertEqual(TestConfiguration.IS_FALSE, False)
+            self.assertEqual(TestConfiguration.IS_WACKY_FALSE, False)
 
     def test_parsing_float(self):
         """A test to ensure that we properly parse floats"""
-        # DEV: We have to set the environment variable first, since they get loaded into the class on definition
-        os.environ['IS_FLOAT'] = '12.5'
-        os.environ['TRAILING_DOT'] = '12.'
-        os.environ['LEADING_DOT'] = '.12'
-        os.environ['IS_NOT_FLOAT'] = 'This is 6.5'
-
-        # DEV: Set `env_load_all=True` to keep from having to make default values for each variable
-        TestConfiguration = self._get_test_configuration(env_load_all=True)
-        self.assertEqual(TestConfiguration.IS_FLOAT, 12.5)
-        self.assertEqual(TestConfiguration.TRAILING_DOT, 12.0)
-        self.assertEqual(TestConfiguration.LEADING_DOT, 0.12)
-        self.assertEqual(TestConfiguration.IS_NOT_FLOAT, 'This is 6.5')
+        env = dict(
+            IS_FLOAT='12.5',
+            TRAILING_DOT='12.',
+            LEADING_DOT='.12',
+            IS_NOT_FLOAT='This is 6.5',
+        )
+        with self.with_env(**env):
+            # DEV: Set `env_load_all=True` to keep from having to make default values for each variable
+            TestConfiguration = self._get_test_configuration(env_load_all=True)
+            self.assertEqual(TestConfiguration.IS_FLOAT, 12.5)
+            self.assertEqual(TestConfiguration.TRAILING_DOT, 12.0)
+            self.assertEqual(TestConfiguration.LEADING_DOT, 0.12)
+            self.assertEqual(TestConfiguration.IS_NOT_FLOAT, 'This is 6.5')
 
     def test_parsing_int(self):
         """A test to ensure that we properly parse integers"""
-        # DEV: We have to set the environment variable first, since they get loaded into the class on definition
-        os.environ['IS_INT'] = '12'
-        os.environ['IS_ZERO'] = '0'
-        os.environ['IS_NOT_INT'] = '12fa'
-
-        # DEV: Set `env_load_all=True` to keep from having to make default values for each variable
-        TestConfiguration = self._get_test_configuration(env_load_all=True)
-        self.assertEqual(TestConfiguration.IS_INT, 12)
-        self.assertEqual(TestConfiguration.IS_ZERO, 0)
-        self.assertEqual(TestConfiguration.IS_NOT_INT, '12fa')
+        env = dict(
+            IS_INT='12',
+            IS_ZERO='0',
+            IS_NOT_INT='12fa',
+        )
+        with self.with_env(**env):
+            # DEV: Set `env_load_all=True` to keep from having to make default values for each variable
+            TestConfiguration = self._get_test_configuration(env_load_all=True)
+            self.assertEqual(TestConfiguration.IS_INT, 12)
+            self.assertEqual(TestConfiguration.IS_ZERO, 0)
+            self.assertEqual(TestConfiguration.IS_NOT_INT, '12fa')
 
 
 if __name__ == '__main__':