Repository navigation
mutually exclusive group w/ all parameters argparse.SUPPRESS'd causes an assert #98666
Description
Activity
The usage formatting is known for being brittle, especially when working with the extra notation of mutually_exclusive_groups. This assert was intended to catch formatting errors that would cause problems if the usage has to be split onto several lines. Without getting into the details, I'm not surprised that a rarely used feature like SUPPRESS causes problems.
- added a commit that references this issue
on May 28, 2023 I cannot reproduce with the above reproducer, which I expanded to:
import argparse from argparse import SUPPRESS parser = argparse.ArgumentParser(prog='PROG') state_group = parser.add_mutually_exclusive_group() state_group.add_argument('--param1', nargs='?', const='default', metavar='NAME', help=SUPPRESS) state_group.add_argument('--param2', nargs='?', const='default', metavar='NAME', help=SUPPRESS) parser.parse_args(['--help'])
This is giving me the output:
usage: PROG [-h] optional arguments: -h, --help show this help message and exiton Python versions 3.6 to 3.13.
If you have a complete example of failing behavior (even on an old version of Python), please share it here.
I think this problem was fixed in #105039; I'll close the issue.
Bug report
will cause an assert in
assert ' '.join(opt_parts) == opt_usageof argparse.py
because the empty group [] is converted into two spaces
e.g.
[group1] [] [group 2]
gets converted to this by the
opt_usage = format(optionals, groups)code above the assert:[group1] [group 2]
and the two spaces don't match the single space of the assert
Your environment