Switch default config file parsing behavior to shlex.

- The parameter to `parse_args` is now `legacy_config_parsing`.
- All existing test cases already pass with the default `shlex`.

Author: sykloid

tap/tap.py

@@ -385,12 +385,13 @@ def _log_all(self, repo_path: Optional[str] = None) -> Dict[str, Any]:
     def parse_args(self: TapType,
                    args: Optional[Sequence[str]] = None,
                    known_only: bool = False,
-                   parse_config_files_with_shlex = False) -> TapType:
+                   legacy_config_parsing = False) -> TapType:
         """Parses arguments, sets attributes of self equal to the parsed arguments, and processes arguments.
 
         :param args: List of strings to parse. The default is taken from `sys.argv`.
         :param known_only: If true, ignores extra arguments and only parses known arguments.
         Unparsed arguments are saved to self.extra_args.
+        :legacy_config_parsing: If true, config files are parsed using `str.split` instead of `shlex.split`.
         :return: self, which is a Tap instance containing all of the parsed args.
         """
         # Prevent double parsing
@@ -399,10 +400,10 @@ def parse_args(self: TapType,
 
         # Collect arguments from all of the configs
 
-        if parse_config_files_with_shlex:
-            splitter = lambda arg_string: split(arg_string, comments=True)
-        else:
+        if legacy_config_parsing:
             splitter = lambda arg_string: arg_string.split()
+        else:
+            splitter = lambda arg_string: split(arg_string, comments=True)
 
         config_args = [arg for args_from_config in self.args_from_configs for arg in splitter(args_from_config)]
 

tests/test_load_config_files.py

@@ -146,7 +146,7 @@ class ShlexConfigTap(Tap):
             with open(fname, 'w') as f:
                 f.write('--a 21 # Important arg value\n\n# Multi-word quoted string\n--b "two three four"')
 
-            args = ShlexConfigTap(config_files=[fname]).parse_args(parse_config_files_with_shlex=True)
+            args = ShlexConfigTap(config_files=[fname]).parse_args()
 
         self.assertEqual(args.a, 21)
         self.assertEqual(args.b, 'two three four')