added fix_default for ChoiceMap custom input; added doc entry for strict_default

Author: dskrypa

bin/argparse_to_command.py

@@ -74,6 +74,9 @@ Common parameters that are supported when initializing most Parameters:
   values.  By default, no transformation is performed, and values will be strings.  If not specified, but a type
   annotation is detected, then that annotation will be used as if it was provided here.  When both are present, this
   argument takes precedence.
+:strict_default: Whether default values should be processed as if provided via CLI (this happens when
+  ``strict_default=False``, the default), or used as-is (``strict_default=True``).  Only applies to :doc:`inputs`
+  that have a :meth:`~.InputType.fix_default` method.
 
 
 Options

bin/build_docs.py

@@ -147,6 +147,12 @@ def __call__(self, value: str) -> T:
 
         return self._case_insensitive_map_choice(value)
 
+    def fix_default(self, value: Any) -> T:
+        if value in self.choices.values():
+            return value
+        else:
+            return self(value)
+
 
 class EnumChoices(_ChoicesBase[EnumT]):
     """

bin/tag.py

@@ -145,6 +145,8 @@ def get_default(self, command: CommandObj | None = None, missing_default=_NotSet
         return self.default
 
     def finalize_default(self, value):
+        if self.param.strict_default:
+            return value
         if (type_func := self.param.type) and isinstance(type_func, InputType):
             return type_func.fix_default(value)
         return value

docs/_src/parameters.rst

@@ -94,9 +94,6 @@ class ParserTest(TestCase):
     def assert_dict_equal(self, d1, d2, msg: str = None):
         self.assertIsInstance(d1, dict, 'First argument is not a dictionary')
         self.assertIsInstance(d2, dict, 'Second argument is not a dictionary')
-        self._assert_dict_equal(d1, d2, msg)
-
-    def _assert_dict_equal(self, d1, d2, msg: str = None):
         if d1 != d2:
             self.fail(self._formatMessage(msg, f'{d1} != {d2}\n{format_dict_diff(d1, d2)}'))
 
@@ -105,7 +102,9 @@ def assert_raises_contains_str(self, expected_exc: Type[BaseException], expected
 
     def assert_parse_results(self, cmd_cls: CommandCls, argv: Argv, expected: Expected, msg: str = None) -> Command:
         cmd = cmd_cls.parse(argv)
-        self._assert_dict_equal(expected, cmd.ctx.get_parsed(cmd, exclude=EXCLUDE_ACTIONS), msg)
+        parsed = cmd.ctx.get_parsed(cmd, exclude=EXCLUDE_ACTIONS)
+        if expected != parsed:
+            self.fail(msg or f'Expected results ({expected}) != {parsed=}\n{format_dict_diff(expected, parsed)}')
         return cmd
 
     def assert_parse_results_cases(self, cmd_cls: CommandCls, cases: Iterable[Case], msg: str = None):

lib/cli_command_parser/inputs/choices.py

@@ -201,6 +201,27 @@ class Foo(Command):
         self.assert_parse_results_cases(Foo, success_cases)
         self.assert_parse_fails_cases(Foo, fail_cases, UsageError)
 
+    def test_choice_map_default_fixed(self):
+        class Foo(Command):
+            bar = Option('-b', default='a', type=ChoiceMap({'a': 'ABC', 'x': 'XYZ'}))
+
+        success_cases = [([], {'bar': 'ABC'}), (['-b', 'a'], {'bar': 'ABC'}), (['-b', 'x'], {'bar': 'XYZ'})]
+        self.assert_parse_results_cases(Foo, success_cases)
+
+    def test_choice_map_default_in_values(self):
+        class Foo(Command):
+            bar = Option('-b', default='ABC', type=ChoiceMap({'a': 'ABC', 'x': 'XYZ'}))
+
+        success_cases = [([], {'bar': 'ABC'}), (['-b', 'a'], {'bar': 'ABC'}), (['-b', 'x'], {'bar': 'XYZ'})]
+        self.assert_parse_results_cases(Foo, success_cases)
+
+    def test_choice_map_default_not_fixed(self):
+        class Foo(Command):
+            bar = Option('-b', default='a', type=ChoiceMap({'a': 'ABC', 'x': 'XYZ'}), strict_default=True)
+
+        success_cases = [([], {'bar': 'a'}), (['-b', 'a'], {'bar': 'ABC'}), (['-b', 'x'], {'bar': 'XYZ'})]
+        self.assert_parse_results_cases(Foo, success_cases)
+
 
 if __name__ == '__main__':
     # import logging