8000 gh-96310: Fix a traceback in argparse when all options in a mutually exclusive group are suppressed by dmach · Pull Request #96311 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-96310: Fix a traceback in argparse when all options in a mutually exclusive group are suppressed #96311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 21, 2024
Merged

gh-96310: Fix a traceback in argparse when all options in a mutually exclusive group are suppressed #96311

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
616c5fe
gh-96310: Fix a traceback in argparse when all options in a mutually …
dmach Aug 26, 2022
fa702d0
Merge branch 'main' into fix-argparse-subparser_all_mutually_exclusiv…
serhiy-storchaka Feb 21, 2024
3b9b636
Polishing.
serhiy-storchaka Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
gh-96310: Fix a traceback in argparse when all options in a mutually … 
…exclusive group are suppressed

Reproducer depends on terminal size - the traceback occurs when there's
an option long enough so the usage line doesn't fit the terminal width.
Option order is also important for reproducibility.

Excluding empty groups (with all options suppressed) from inserts
fixes the problem.
  • Loading branch information
@dmach
dmach committed Aug 26, 2022
commit 616c5fee9630886daf79d649a0db8f55c4e8384d
2 changes: 2 additions & 0 deletions Lib/argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,8 @@ def _format_actions_usage(self, actions, groups):
else:
end = start + len(group._group_actions)
if actions[start:end] == group._group_actions:
if all((action.help is SUPPRESS for action in group._group_actions)):
continue
for action in group._group_actions:
group_actions.add(action)
if not group.required:
Expand Down
19 changes: 19 additions & 0 deletions Lib/test/test_argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2695,6 +2695,25 @@ def test_help(self):
'''
self.assertEqual(parser.format_help(), textwrap.dedent(expected))

def test_help_subparser_all_mutually_exclusive_group_members_suppressed(self):
self.maxDiff = None
parser = ErrorRaisingArgumentParser(prog='PROG')
commands = parser.add_subparsers(title="commands", dest="command")
cmd_foo = commands.add_parser("foo")
group = cmd_foo.add_mutually_exclusive_group()
group.add_argument('--verbose', action='store_true', help=argparse.SUPPRESS)
group.add_argument('--quiet', action='store_true', help=argparse.SUPPRESS)
cmd_foo.add_argument("--longlonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglong")
expected = '''\
usage: PROG foo [-h]
[--longlonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglong LONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONG]

options:
-h, --help show this help message and exit
--longlonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglonglong LONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONGLONG
'''
self.assertEqual(cmd_foo.format_help(), textwrap.dedent(expected))

def test_empty_group(self):
# See issue 26952
parser = argparse.ArgumentParser()
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2022-08-26-15-50-53.gh-issue-96310.0NssDh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix a traceback in argparse when all options in a mutually exclusive group
are suppressed.
0