This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: argparse subparser usage message hides main parser usage
Type: enhancement Stage:
Components: Library (Lib) Versions: Python 3.3
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: Martin.d'Anjou, bethard, paul.j3
Priority: normal Keywords: patch

Created on 2014-01-21 16:46 by Martin.d'Anjou, last changed 2022-04-11 14:57 by admin.

Files
File name Uploaded Description Edit
issue20333.patch paul.j3, 2014-05-09 21:27 review
sample.py paul.j3, 2014-05-09 21:27
Messages (2)
msg208670 - (view) Author: Martin d'Anjou (Martin.d'Anjou) Date: 2014-01-21 16:46
Consider the following code:

#!/usr/bin/env python3
import argparse

# create the top-level parser
parser = argparse.ArgumentParser(prog='PROG')
parser.add_argument('--file', help='A filename', required=True)
subparsers = parser.add_subparsers(help='sub-command help')

# create the parser for the "a" command
parser_a = subparsers.add_parser('a', help='a help')
parser_a.add_argument('bar', type=int, help='bar help')

# create the parser for the "b" command
parser_b = subparsers.add_parser('b', help='b help')
parser_b.add_argument('--baz', choices='XYZ', help='baz help')

The help for subparser a is obtained with: parser.parse_args(["a","--help"])

usage: PROG a [-h] bar

positional arguments:
  bar         bar help

optional arguments:
  -h, --help  show this help message and exit

When the user follows the help, the user gets it wrong:
parser.parse_args(["a","10"])

usage: PROG [-h] --file FILE {a,b} ...
PROG: error: argument --file is required

The correct way to use the subparser is:
parser.parse_args(["--file","file","a","10"])

But the problem is that the original help message is not telling the user that this is the correct way. When asking for the "a" subparser help, the usage message should also reveal the main parser arguments. Continuing with the example, something like this should be appropriate:

usage: PROG [-h] --file FILE a [-h] bar

This is how the argparse Java port works.
msg218199 - (view) Author: paul j3 (paul.j3) * (Python triager) Date: 2014-05-09 21:27
When `add_subparsers` creates the `_prog_prefix` it uses a list of positionals.  That makes sense, since a subparser argument is positional, so the user needs to know where it fits in the broader scope of positionals.

But it intentionally skips the 'optionals'.  The problem in the example for this bug is that its 'optional' is 'required'.  A fix is to include all 'required optionals' along with positionals in the usage prefix.  

Attached is a partial patch that does this.  

I also question whether it makes sense to include 'mutually_exclusive_groups' in this usage formatting, since all actions in such a group must be non-required.  And such a group can include at most one positional (with ? or *).  A MXG is marked only if all of its actions are present in the usage list.

The programmer can also customize the subparsers usage with the 'prog' keyword of either the 'add_subparsers' or 'add_parser' commands.  I illustrate this in the attached 'sample.py' script.

'test_argparse.py' does not seem to test this issue much.  Atleast it isn't bothered by these tweaks.

Note that any arguments added to the main parser after the 'add_subparsers' command will not appear the subparser usage, since this is defined when the subparsers are created.
History
Date User Action Args
2022-04-11 14:57:57adminsetgithub: 64532
2014-05-09 21:27:37paul.j3setfiles: + sample.py
2014-05-09 21:27:13paul.j3setfiles: + issue20333.patch
keywords: + patch
messages: + msg218199
2014-01-21 17:38:33berker.peksagsetnosy: + bethard, paul.j3
2014-01-21 16:46:08Martin.d'Anjoucreate