Add option to remember not saving config option

also add some preliminary config tests (todo setup/teardown)

Author: mueslo

pythonbits/config.py

@@ -13,24 +13,31 @@
 CONFIG_DIR = appdirs.user_config_dir(appname.lower())
 CONFIG_PATH = path.join(CONFIG_DIR, CONFIG_NAME)
 CONFIG_VERSION = 1
+DEFAULT = object()
 
 if not path.exists(CONFIG_DIR):
     makedirs(CONFIG_DIR, 0o700)
 
 
+class ConfidentialOption(Exception):
+    pass
+
+
+class UnregisteredOption(Exception):
+    pass
+
+
 class Config():
     registry = {}
 
     def __init__(self, config_path=None):
         self.config_path = config_path or CONFIG_PATH
-        self._config = configparser.ConfigParser()
+        self._config = configparser.ConfigParser(allow_no_value=True)
 
     def register(self, section, option, query, ask=False, getpass=False):
         self.registry[(section, option)] = {
             'query': query, 'ask': ask, 'getpass': getpass}
 
-        # todo: ask to remember choice if save is declined
-
     def _write(self):
         with open(self.config_path, 'w') as configfile:
             self._config.write(configfile)
@@ -42,33 +49,49 @@ def set(self, section, option, value):
         self._config.set(section, option, value)
         self._write()
 
-    def get(self, section, option, default='dontguessthis'):
+    def get(self, section, option, default=DEFAULT):
         self._config.read(self.config_path)
+
         try:
-            return self._config.get(section, option)
-        except (configparser.NoSectionError, configparser.NoOptionError):
+            value = self._config.get(section, option)
+            if value is None:
+                raise ConfidentialOption
+            return value
+        except (configparser.NoSectionError, configparser.NoOptionError,
+                ConfidentialOption) as e:
+            # if getter default is set, return it instead
+            if default is not DEFAULT:
+                return default
 
+            # get registered config option
             try:
                 reg_option = self.registry[(section, option)]
             except KeyError:
-                if default != 'dontguessthis':  # dirty hack
-                    return default
-                else:
-                    raise
+                raise UnregisteredOption((section, option))
 
+            # get value from user query
             if reg_option['getpass']:
                 value = getpass.getpass(reg_option['query'] + ": ")
             else:
                 value = input(reg_option['query'] + ": ").strip()
 
-            if (reg_option['ask'] and
-                input(
-                    'Would you like to save this value in {}? [Y/n] '.format(
-                        self.config_path)).lower() == 'n'):
+            # user does not want to be prompted to save this option
+            if isinstance(e, ConfidentialOption):
                 return value
 
-            self.set(section, option, value)
+            # user has choice ('ask') to save option value
+            if reg_option['ask']:
+                c = input('Would you like to save this value in {}? '
+                          'nr = no, and remember choice\n'
+                          '[Y/n/nr]'.format(self.config_path)).lower()
 
+                if c == 'n':
+                    return value
+                elif c == 'nr':
+                    self.set(section, option, None)
+                    return value
+
+            self.set(section, option, value)
             return value
 
 

tests/__init__.py

@@ -0,0 +1,7 @@
+import os
+from unittest import mock
+import pythonbits.config as config
+
+dir_path = os.path.dirname(os.path.realpath(__file__))
+config.config = config.Config(dir_path + '/pythonbits.cfg')
+config.config._write = mock.MagicMock()

tests/pythonbits.cfg

@@ -1,2 +1,12 @@
+[General]
+version = 1
+
 [Tracker]
-domain = mydomain.net
+domain = mydomain.net
+
+[Foo]
+bar = baz
+bar2
+ham
+spam
+spam2 = spam2_value

tests/test_config.py

@@ -0,0 +1,75 @@
+import pytest
+from unittest import mock
+
+import pythonbits.config as config
+c = config.config
+
+c.register('Foo', 'bar', 'bar?')
+c.register('Foo', 'bar2', 'bar2?')
+c.register('Foo', 'bar3', 'bar3?', ask=True)
+c.register('Foo', 'bar4', 'bar4?', ask=True)
+c.register('Foo', 'ham', 'ham?')
+c.register('Foo', 'eggs', 'eggs?')
+
+
+def test_get():
+    # todo: atomic tests with fresh config file
+
+    # registered option, present in config file
+    assert c.get('Foo', 'bar') == 'baz'
+    assert c.get('Foo', 'bar', 'bar_default') == 'baz'
+    with mock.patch('builtins.input', lambda q: 'some_input'):
+        assert c.get('Foo', 'ham') == 'some_input'
+
+    # registered option, present in config file, but empty
+    assert c.get('Foo', 'bar2', 'bar2_default') == 'bar2_default'
+    with mock.patch('builtins.input', lambda q: 'bar2_input'):
+        assert c.get('Foo', 'bar2') == 'bar2_input'
+    # assert c.get('Foo', 'bar2') == 'bar2_input' # see todo: non-mocked _write
+
+    # registered option, not present in config file, ask=True
+    assert c.get('Foo', 'bar3', 'bar3_default') == 'bar3_default'
+    with mock.patch('builtins.input', side_effect=['bar3_input', 'y']) as m:
+        assert c.get('Foo', 'bar3') == 'bar3_input'
+        with pytest.raises(StopIteration):  # make sure all consumed
+            next(m.side_effect)
+    assert c.get('Foo', 'bar3') == 'bar3_input'
+
+    # lifecycle test: registered option, not present, ask=True
+    assert c.get('Foo', 'bar4', 'bar4_default') == 'bar4_default'
+    with mock.patch('builtins.input', side_effect=['bar4_input', 'n']) as m:
+        assert c.get('Foo', 'bar4') == 'bar4_input'
+        with pytest.raises(StopIteration):  # make sure all consumed
+            next(m.side_effect)
+    assert c.get('Foo', 'bar4', 'bar4_default2') == 'bar4_default2'
+    with mock.patch('builtins.input', side_effect=['bar4_input2', 'nr']) as m:
+        assert c.get('Foo', 'bar4') == 'bar4_input2'
+        with pytest.raises(StopIteration):  # make sure all consumed
+            next(m.side_effect)
+    assert c.get('Foo', 'bar4', 'bar4_default3') == 'bar4_default3'
+    with mock.patch('builtins.input', side_effect=['bar4_input3']) as m:
+        assert c.get('Foo', 'bar4') == 'bar4_input3'
+        with pytest.raises(StopIteration):  # make sure all consumed
+            next(m.side_effect)
+
+    # unregistered option, present in config file, but empty
+    assert c.get('Foo', 'spam', 'spam_default') == 'spam_default'
+    with pytest.raises(config.UnregisteredOption):
+        c.get('Foo', 'spam')
+
+    # unregistered option, present in config file
+    assert c.get('Foo', 'spam2') == 'spam2_value'
+    assert c.get('Foo', 'spam2', 'spam2_default') == 'spam2_value'
+
+    # unregistered option, not present in config file
+    assert c.get('Foo', 'spam3', 'spam3_default') == 'spam3_default'
+    with pytest.raises(config.UnregisteredOption):
+        c.get('Foo', 'spam3')
+
+    # registered option, not present in config file
+    assert c.get('Foo', 'eggs', default='default_input') == 'default_input'
+
+    with mock.patch('builtins.input', lambda q: 'more_input'):
+        assert c.get('Foo', 'eggs') == 'more_input'
+
+    assert c.get('Foo', 'eggs') == 'more_input'

tests/test_dummy.py

@@ -1,11 +1,4 @@
 # -*- coding: utf-8 -*-
-import os
-import pythonbits.config as config
-
-dir_path = os.path.dirname(os.path.realpath(__file__))
-config.config.config_path = dir_path + '/pythonbits.cfg'
-print(config.config.config_path)
-
 import pythonbits.submission as submission  # noqa: E402
 import pythonbits.bb as bb  # noqa: E402
 import pytest  # noqa: E402