Fix normalization of settings using a custom dest

README.md

@@ -64,7 +64,7 @@ Hello world
 settngs.json at the end:
 ```json
 {
-  "example": {
+  "Example Group": {
     "hello": "world",
     "verbose": false
   },

settngs/__init__.py

@@ -107,6 +107,9 @@ class Setting:
         exclusive: bool = False,
     ):
         """
+        Attributes:
+        setting_name:     This is the name used to retrieve this Setting object from a `Config` Definitions dictionary.
+                          This only differs from dest when a custom dest is given
 
         Args:
             *names:       Passed directly to argparse
@@ -119,7 +122,8 @@ class Setting:
             required:     Passed directly to argparse
             help:         Passed directly to argparse
             metavar:      Passed directly to argparse, defaults to `dest` upper-cased
-            dest:         This is the name used to retrieve the value from a `Config` object as a dictionary
+            dest:         This is the name used to retrieve the value from a `Config` object as a dictionary.
+                          Default to `setting_name`.
             display_name: This is not used by settngs. This is a human-readable name to be used when generating a GUI.
                           Defaults to `dest`.
             cmdline:      If this setting can be set via the commandline
@@ -133,7 +137,7 @@ class Setting:
             raise ValueError('names must be specified')
         # We prefix the destination name used by argparse so that there are no conflicts
         # Argument names will still cause an exception if there is a conflict e.g. if '-f' is defined twice
-        self.internal_name, dest, self.flag = self.get_dest(group, names, dest)
+        self.internal_name, setting_name, dest, self.flag = self.get_dest(group, names, dest)
         args: Sequence[str] = names
 
         # We then also set the metavar so that '--config' in the group runtime shows as 'CONFIG' instead of 'RUNTIME_CONFIG'
@@ -155,6 +159,7 @@ class Setting:
         self.help = help
         self.metavar = metavar
         self.dest = dest
+        self.setting_name = setting_name
         self.cmdline = cmdline
         self.file = file
         self.argparse_args = args
@@ -228,28 +233,30 @@ class Setting:
             return None
         return 'Any'
 
-    def get_dest(self, prefix: str, names: Sequence[str], dest: str | None) -> tuple[str, str, bool]:
-        dest_name = None
+    def get_dest(self, prefix: str, names: Sequence[str], dest: str | None) -> tuple[str, str, str, bool]:
+        setting_name = None
         flag = False
 
         prefix = sanitize_name(prefix)
         for n in names:
             if n.startswith('--'):
                 flag = True
-                dest_name = sanitize_name(n)
+                setting_name = sanitize_name(n)
                 break
             if n.startswith('-'):
                 flag = True
 
-        if dest_name is None:
-            dest_name = names[0]
+        if setting_name is None:
+            setting_name = names[0]
         if dest:
             dest_name = dest
+        else:
+            dest_name = setting_name
         if not dest_name.isidentifier():
             raise Exception(f'Cannot use {dest_name} in a namespace')
 
         internal_name = f'{prefix}__{dest_name}'.lstrip('_')
-        return internal_name, dest_name, flag
+        return internal_name, setting_name, dest_name, flag
 
     def filter_argparse_kwargs(self) -> dict[str, Any]:
         return {k: v for k, v in self.argparse_kwargs.items() if v is not None}
@@ -441,13 +448,13 @@ def normalize_config(
                 value, is_default = get_option(options, setting)
                 if not is_default or default:
                     # User has set a custom value or has requested the default value
-                    group_options[setting_name] = value
-                elif setting_name in group_options:
+                    group_options[setting.dest] = value
+                elif setting.dest in group_options:
                     # default values have been requested to be removed
-                    del group_options[setting_name]
-            elif setting_name in group_options:
+                    del group_options[setting.dest]
+            elif setting.dest in group_options:
                 # Setting type (file or cmdline) has not been requested and should be removed for persistent groups
-                del group_options[setting_name]
+                del group_options[setting.dest]
         normalized[group_name] = group_options
 
     return Config(normalized, config.definitions)
@@ -708,7 +715,7 @@ class Manager:
         """Passes all arguments through to `Setting`, `group` and `exclusive` are already set"""
 
         setting = Setting(*args, **kwargs, group=self.current_group_name, exclusive=self.exclusive_group)
-        self.definitions[self.current_group_name].v[setting.dest] = setting
+        self.definitions[self.current_group_name].v[setting.setting_name] = setting
 
     def add_group(self, name: str, group: Callable[[Manager], None], exclusive_group: bool = False) -> None:
         """

testing/settngs.py

@@ -77,6 +77,7 @@ success = [
             'cmdline': True,
             'const': None,
             'default': None,
+            'setting_name': 'test_setting',  # dest is calculated by Setting and is not used by argparse
             'dest': 'test_setting',  # dest is calculated by Setting and is not used by argparse
             'display_name': 'test_setting',  # defaults to dest
             'exclusive': False,
@@ -84,7 +85,7 @@ success = [
             'flag': True,
             'group': 'tst',
             'help': None,
-            'internal_name': 'tst__test_setting',  # Should almost always be "{group}_{dest}"
+            'internal_name': 'tst__test_setting',  # Should almost always be "{group}__{dest}"
             'metavar': 'TEST_SETTING',  # Set manually so argparse doesn't use TST_TEST
             'nargs': None,
             'required': None,
@@ -118,6 +119,7 @@ success = [
             'cmdline': True,
             'const': None,
             'default': None,
+            'setting_name': 'test',  # setting_name is calculated by Setting and is not used by argparse
             'dest': 'testing',  # dest is calculated by Setting and is not used by argparse
             'display_name': 'testing',  # defaults to dest
             'exclusive': False,
@@ -125,7 +127,7 @@ success = [
             'flag': True,
             'group': 'tst',
             'help': None,
-            'internal_name': 'tst__testing',  # Should almost always be "{group}_{dest}"
+            'internal_name': 'tst__testing',  # Should almost always be "{group}__{dest}"
             'metavar': 'TESTING',  # Set manually so argparse doesn't use TST_TEST
             'nargs': None,
             'required': None,
@@ -158,6 +160,7 @@ success = [
             'cmdline': True,
             'const': None,
             'default': None,
+            'setting_name': 'test',  # dest is calculated by Setting and is not used by argparse
             'dest': 'test',  # dest is calculated by Setting and is not used by argparse
             'display_name': 'test',  # defaults to dest
             'exclusive': False,
@@ -165,7 +168,7 @@ success = [
             'flag': True,
             'group': 'tst',
             'help': None,
-            'internal_name': 'tst__test',  # Should almost always be "{group}_{dest}"
+            'internal_name': 'tst__test',  # Should almost always be "{group}__{dest}"
             'metavar': 'TEST',  # Set manually so argparse doesn't use TST_TEST
             'nargs': None,
             'required': None,
@@ -199,6 +202,7 @@ success = [
             'cmdline': True,
             'const': None,
             'default': None,
+            'setting_name': 'test',  # dest is calculated by Setting and is not used by argparse
             'dest': 'test',  # dest is calculated by Setting and is not used by argparse
             'display_name': 'test',  # defaults to dest
             'exclusive': False,
@@ -206,7 +210,7 @@ success = [
             'flag': True,
             'group': 'tst',
             'help': None,
-            'internal_name': 'tst__test',  # Should almost always be "{group}_{dest}"
+            'internal_name': 'tst__test',  # Should almost always be "{group}__{dest}"
             'metavar': None,  # store_true does not get a metavar
             'nargs': None,
             'required': None,
@@ -239,6 +243,7 @@ success = [
             'cmdline': True,
             'const': None,
             'default': None,
+            'setting_name': 'test',
             'dest': 'test',
             'display_name': 'test',  # defaults to dest
             'exclusive': False,
@@ -279,6 +284,7 @@ success = [
             'cmdline': True,
             'const': None,
             'default': None,
+            'setting_name': 'test',
             'dest': 'test',
             'display_name': 'test',  # defaults to dest
             'exclusive': False,
@@ -317,6 +323,7 @@ success = [
             'cmdline': True,
             'const': None,
             'default': None,
+            'setting_name': 'test',
             'dest': 'test',
             'display_name': 'test',  # defaults to dest
             'exclusive': False,

tests/settngs_test.py

@@ -18,7 +18,18 @@ from testing.settngs import failure
 from testing.settngs import success
 
 
-if sys.version_info < (3, 9):  # pragma: no cover
+if sys.version_info >= (3, 10):  # pragma: no cover
+    List = list
+    help_output = '''\
+usage: __main__.py [-h] [TEST ...]
+
+positional arguments:
+  TEST
+
+options:
+  -h, --help  show this help message and exit
+'''
+elif sys.version_info < (3, 9):  # pragma: no cover
     from typing import List
     help_output = '''\
 usage: __main__.py [-h] [TEST [TEST ...]]
@@ -42,17 +53,6 @@ optional arguments:
   -h, --help  show this help message and exit
 '''
 
-if sys.version_info >= (3, 10):  # pragma: no cover
-    help_output = '''\
-usage: __main__.py [-h] [TEST ...]
-
-positional arguments:
-  TEST
-
-options:
-  -h, --help  show this help message and exit
-'''
-
 
 @pytest.fixture
 def settngs_manager() -> Generator[settngs.Manager, None, None]:
@@ -210,6 +210,24 @@ class TestValues:
         assert non_defaults_normalized.values['tst'] == {'test': 'world'}
         assert non_defaults_normalized.values['tst_persistent'] == {'test': 'world'}
 
+    def test_normalize_dest(self, settngs_manager):
+        settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
+        settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test2', dest='test', default='hello'))
+        settngs_manager.add_persistent_group('tst_persistent', lambda parser: parser.add_setting('--test', default='hello'))
+
+        defaults = settngs_manager.defaults()
+        defaults_normalized = settngs_manager.normalize_config(defaults, file=True, default=False)
+        assert defaults_normalized.values['tst'] == {}
+        assert defaults_normalized.values['tst_persistent'] == {}
+
+        non_defaults = settngs_manager.defaults()
+        non_defaults.values['tst']['test'] = 'world'
+        non_defaults.values['tst_persistent']['test'] = 'world'
+        non_defaults_normalized = settngs_manager.normalize_config(non_defaults, file=True, default=False)
+
+        assert non_defaults_normalized.values['tst'] == {'test': 'world'}
+        assert non_defaults_normalized.values['tst_persistent'] == {'test': 'world'}
+
     def test_normalize(self, settngs_manager):
         settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
         settngs_manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
@@ -317,6 +335,23 @@ class TestNamespace:
         assert non_defaults_normalized.values.tst__test == 'world'
         assert non_defaults_normalized.values.tst_persistent__test == 'world'
 
+    def test_normalize_dest(self, settngs_manager):
+        settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
+        settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test2', dest='test', default='hello'))
+        settngs_manager.add_persistent_group('tst_persistent', lambda parser: parser.add_setting('--test', default='hello'))
+
+        defaults = settngs_manager.defaults()
+        defaults_normalized = settngs_manager.get_namespace(settngs_manager.normalize_config(defaults, file=True, default=False), file=True, default=False)
+        assert defaults_normalized.values.__dict__ == {}
+
+        non_defaults = settngs_manager.get_namespace(settngs_manager.defaults(), file=True, cmdline=True)
+        non_defaults.values.tst__test = 'world'
+        non_defaults.values.tst_persistent__test = 'world'
+        non_defaults_normalized = settngs_manager.get_namespace(settngs_manager.normalize_config(non_defaults, file=True, default=False), file=True, default=False)
+
+        assert non_defaults_normalized.values.tst__test == 'world'
+        assert non_defaults_normalized.values.tst_persistent__test == 'world'
+
     def test_normalize(self, settngs_manager):
         settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
         settngs_manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
@@ -333,7 +368,7 @@ class TestNamespace:
         assert normalized.persistent__hello == 'success'
         assert normalized.persistent__world == 'world'
 
-    def test_normalize_unknown(self, settngs_manager):
+    def test_normalize_unknown_group(self, settngs_manager):
         manager = settngs.Manager()
         manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
         manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))