Merge pull request #170 from Pennycook/custom-action-fixes

Fix several issues with custom argparse actions

Author: Pennycook

codebasin/config.py

@@ -110,7 +110,7 @@ def __call__(
             template = string.Template(self.format)
             split_values = [template.substitute(value=v) for v in split_values]
         if self.dest == "passes":
-            passes = getattr(namespace, self.dest)
+            passes = getattr(namespace, "_passes")
             passes[option_string] = split_values
         else:
             setattr(namespace, self.dest, split_values)
@@ -131,6 +131,8 @@ def __init__(
     ):
         self.pattern = kwargs.pop("pattern", None)
         self.format = kwargs.pop("format", None)
+        self.override = kwargs.pop("override", False)
+        self.flag_name = option_strings[0]
         super().__init__(option_strings, dest, nargs=nargs, **kwargs)
 
     def __call__(
@@ -147,13 +149,20 @@ def __call__(
             template = string.Template(self.format)
             matches = [template.substitute(value=v) for v in matches]
         if self.dest == "passes":
-            passes = getattr(namespace, self.dest)
-            if option_string not in passes:
-                passes[option_string] = []
-            passes[option_string].extend(matches)
+            passes = getattr(namespace, "_passes")
+            if self.flag_name not in passes:
+                passes[self.flag_name] = []
+            if self.override:
+                passes[self.flag_name] = matches
+                self.override = False
+            else:
+                passes[self.flag_name].extend(matches)
         else:
-            dest = getattr(namespace, self.dest)
-            dest.extend(matches)
+            if self.override:
+                setattr(namespace, self.dest, matches)
+            else:
+                dest = getattr(namespace, self.dest)
+                dest.extend(matches)
 
 
 @dataclass

tests/compilers/test_actions.py

@@ -30,7 +30,7 @@ def test_store_split_init(self):
     def test_store_split(self):
         """Check that argparse calls store_split correctly"""
         namespace = argparse.Namespace()
-        namespace.passes = {}
+        namespace._passes = {}
 
         parser = argparse.ArgumentParser()
         parser.add_argument("--foo", action=_StoreSplitAction, sep=",")
@@ -58,7 +58,7 @@ def test_store_split(self):
             args, _ = parser.parse_known_args(["--baz=1"], namespace)
 
         args, _ = parser.parse_known_args(["--qux=one,two"], namespace)
-        self.assertEqual(args.passes, {"--qux": ["one", "two"]})
+        self.assertEqual(args._passes, {"--qux": ["one", "two"]})
 
     def test_extend_match_init(self):
         """Check that extend_match recognizes custom arguments"""
@@ -78,7 +78,6 @@ def test_extend_match_init(self):
     def test_extend_match(self):
         """Check that argparse calls store_split correctly"""
         namespace = argparse.Namespace()
-        namespace.passes = {}
 
         parser = argparse.ArgumentParser()
         parser.add_argument(
@@ -100,6 +99,23 @@ def test_extend_match(self):
             action=_ExtendMatchAction,
             pattern=r"option_(\d+)",
             dest="passes",
+            default=["0"],
+            override=True,
+        )
+        parser.add_argument(
+            "--one",
+            "--two",
+            action=_ExtendMatchAction,
+            pattern=r"option_(\d+)",
+            dest="passes",
+        )
+        parser.add_argument(
+            "--default-override",
+            action=_ExtendMatchAction,
+            pattern=r"option_(\d+)",
+            default=["0"],
+            dest="override",
+            override=True,
         )
 
         args, _ = parser.parse_known_args(
@@ -117,11 +133,34 @@ def test_extend_match(self):
         with self.assertRaises(TypeError):
             args, _ = parser.parse_known_args(["--baz=1"], namespace)
 
+        # Check that the default values defined by flags always exists.
+        # Note that the caller must initialize the default.
+        namespace.override = ["0"]
+        namespace._passes = {"--qux": ["0"]}
+        args, _ = parser.parse_known_args(
+            [],
+            namespace,
+        )
+        self.assertEqual(args.override, ["0"])
+        self.assertEqual(args._passes, {"--qux": ["0"]})
+
+        # Check that the default pass is overridden by use of --qux.
+        # Note that the caller must initialize the default.
+        namespace.override = ["0"]
+        namespace._passes = {"--qux": ["0"]}
+        args, _ = parser.parse_known_args(
+            ["--qux=option_1,option_2", "--default-override=option_1"],
+            namespace,
+        )
+        self.assertEqual(args.override, ["1"])
+        self.assertEqual(args._passes, {"--qux": ["1", "2"]})
+
+        namespace._passes = {}
         args, _ = parser.parse_known_args(
-            ["--qux=option_1,option_2"],
+            ["--one=option_1", "--two=option_2"],
             namespace,
         )
-        self.assertEqual(args.passes, {"--qux": ["1", "2"]})
+        self.assertEqual(args._passes, {"--one": ["1", "2"]})
 
 
 if __name__ == "__main__":