argparse option argument with `nargs=argparse.REMAINDER` is misplaced in usage line
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
Bug report
When using an optional argument with nargs=argparse.REMAINDER, the argument appears within the list of optional arguments and before any positional arguments. I expected it to be placed last in usage line, which would better match the behavior since it consumes any following parameters. Not sure it is really bug...
The following scripts shows the issue:
#!/usr/bin/env python
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('foo')
parser.add_argument('--extra', nargs=argparse.REMAINDER)
parser.add_argument('--option')
args = parser.parse_args()
[--extra ...] is not at all last in the usage line:
$ ./test.py -h
usage: test.py [-h] [--extra ...] [--option OPTION] foo
positional arguments:
foo
options:
-h, --help show this help message and exit
--extra ...
--option OPTION
Your environment
- archlinux/amd64
- Tested on python 3.10.4 and also on 3.7.7 and 3.8.7.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Run the minimal argparse script from the report and inspect how ArgumentParser formats its usage line for add_argument calls using nargs=argparse.REMAINDER. Confirm the current ordering and identify the relevant argparse usage-formatting tests or entry point. Done means the remainder option appears after positional arguments in usage output without disturbing other option ordering.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100