8000 gh-81691: Fix handling of multiple "--" (double dashes) in argparse (… · python/cpython@aae1267 · GitHub
[go: up one dir, main page]
Skip to content

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit aae1267

Browse files
serhiy-storchakaserhiy-storchaka
authored
gh-81691: Fix handling of multiple "--" (double dashes) in argparse (GH-124233)
Only the first one has now been removed, all subsequent ones are now taken literally.
1 parent 7a2d77c commit aae1267

File tree

3 files changed

+67
-8
lines changed

3 files changed

+67
-8
lines changed

‎Lib/argparse.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2070,6 +2070,11 @@ def consume_positionals(start_index):
20702070
# and add the Positional and its args to the list
20712071
for action, arg_count in zip(positionals, arg_counts):
20722072
args = arg_strings[start_index: start_index + arg_count]
2073+
# Strip out the first '--' if it is not in PARSER or REMAINDER arg.
2074+
if (action.nargs not in [PARSER, REMAINDER]
2075+
and arg_strings_pattern.find('-', start_index,
2076+
start_index + arg_count) >= 0):
2077+
args.remove('--')
20732078
start_index += arg_count
20742079
if args and action.deprecated and action.dest not in warned:
20752080
self._warning(_("argument '%(argument_name)s' is deprecated") %
@@ -2470,13 +2475,6 @@ def parse_known_intermixed_args(self, args=None, namespace=None):
24702475
# Value conversion methods
24712476
# ========================
24722477
def _get_values(self, action, arg_strings):
2473-
# for everything but PARSER, REMAINDER args, strip out first '--'
2474-
if not action.option_strings and action.nargs not in [PARSER, REMAINDER]:
2475-
try:
2476-
arg_strings.remove('--')
2477-
except ValueError:
2478-
pass
2479-
24802478
# optional argument produces a default when not present
24812479
if not arg_strings and action.nargs == OPTIONAL:
24822480
if action.option_strings:

‎Lib/test/test_argparse.py

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5721,7 +5721,30 @@ def test_zero_or_more_optional(self):
57215721
self.assertEqual(NS(x=[]), args)
57225722

57235723
def test_double_dash(self):
5724-
parser = argparse.ArgumentParser()
5724+
parser = argparse.ArgumentParser(exit_on_error=False)
5725+
parser.add_argument('-f', '--foo')
5726+
parser.add_argument('bar', nargs='*')
5727+
5728+
args = parser.parse_args(['--foo=--'])
5729+
self.assertEqual(NS(foo='--', bar=[]), args)
5730+
self.assertRaisesRegex(argparse.ArgumentError,
5731+
'argument -f/--foo: expected one argument',
5732+
parser.parse_args, ['--foo', '--'])
5733+
args = parser.parse_args(['-f--'])
5734+
self.assertEqual(NS(foo='--', bar=[]), args)
5735+
self.assertRaisesRegex(argparse.ArgumentError,
5736+
'argument -f/--foo: expected one argument',
5737+
parser.parse_args, ['-f', '--'])
5738+
args = parser.parse_args(['--foo', 'a', '--', 'b', 'c'])
5739+
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
5740+
args = parser.parse_args(['a', 'b', '--foo', 'c'])
5741+
self.assertEqual(NS(foo='c', bar=['a', 'b']), args)
5742+
args = parser.parse_args(['a', '--', 'b', '--foo', 'c'])
5743+
self.assertEqual(NS(foo=None, bar=['a', 'b', '--foo', 'c']), args)
5744+
args = parser.parse_args(['a', '--', 'b', '--', 'c', '--foo', 'd'])
5745+
self.assertEqual(NS(foo=None, bar=['a', 'b', '--', 'c', '--foo', 'd']), args)
5746+
5747+
parser = argparse.ArgumentParser(exit_on_error=False)
57255748
parser.add_argument('-f', '--foo', nargs='*')
57265749
parser.add_argument('bar', nargs='*')
57275750

@@ -5735,6 +5758,41 @@ def test_double_dash(self):
57355758
self.assertEqual(NS(foo=[], bar=[]), args)
57365759
args = parser.parse_args(['--foo', 'a', 'b', '--', 'c', 'd'])
57375760
self.assertEqual(NS(foo=['a', 'b'], bar=['c', 'd']), args)
5761+
args = parser.parse_args(['a', 'b', '--foo', 'c', 'd'])
5762+
self.assertEqual(NS(foo=['c', 'd'], bar=['a', 'b']), args)
5763+
args = parser.parse_args(['a', '--', 'b', '--foo', 'c', 'd'])
5764+
self.assertEqual(NS(foo=None, bar=['a', 'b', '--foo', 'c', 'd']), args)
5765+
args, argv = parser.parse_known_args(['a', 'b', '--foo', 'c', '--', 'd'])
5766+
self.assertEqual(NS(foo=['c'], bar=['a', 'b']), args)
5767+
self.assertEqual(argv, ['--', 'd'])
5768+
5769+
parser = argparse.ArgumentParser(exit_on_error=False)
5770+
parser.add_argument('foo')
5771+
parser.add_argument('bar', nargs='*')
5772+
5773+
args = parser.parse_args(['--', 'a', 'b', 'c'])
5774+
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
5775+
args = parser.parse_args(['a', '--', 'b', 'c'])
5776+
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
5777+
args = parser.parse_args(['a', 'b', '--', 'c'])
5778+
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
5779+
args = parser.parse_args(['a', '--', 'b', '--', 'c'])
5780+
self.assertEqual(NS(foo='a', bar=['b', '--', 'c']), args)
5781+
args = parser.parse_args(['--', '--', 'a', '--', 'b', 'c'])
5782+
self.assertEqual(NS(foo='--', bar=['a', '--', 'b', 'c']), args)
5783+
5784+
parser = argparse.ArgumentParser(exit_on_error=False)
5785+
parser.add_argument('foo')
5786+
parser.add_argument('bar', nargs=argparse.REMAINDER)
5787+
5788+
args = parser.parse_args(['--', 'a', 'b', 'c'])
5789+
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
5790+
args = parser.parse_args(['a', '--', 'b', 'c'])
5791+
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
5792+
args = parser.parse_args(['a', 'b', '--', 'c'])
5793+
self.assertEqual(NS(foo='a', bar=['b', '--', 'c']), args)
5794+
args = parser.parse_args(['a', '--', 'b', '--', 'c'])
5795+
self.assertEqual(NS(foo='a', bar=['b', '--', 'c']), args)
57385796

57395797

57405798
# ===========================

‎Misc/NEWS.d/next/Library/2024-09-19-10-36-18.gh-issue-81691.Hyhp_U.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Fix handling of multiple ``"--"`` (double dashes) in :mod:`argparse`. Only
2+
the first one has now been removed, all subsequent ones are now taken
3+
literally.

0 commit comments

Comments
 (0)
0