How to use top-level arguments with subparsers in argparse

Question

In Python's argparse, how do you implement top-level arguments while still using commands implemented as subparsers?

I'm trying to implement a --version argument to show the program's version number, but argparse is giving me error: too few arguments because I'm not specifying a sub-command for one of the subparsers.

My code:

import argparse
parser = argparse.ArgumentParser()
parser.add_argument(
    '-v', '--version',
    help='Show version.',
    action='store_true',
    default=False
)
subparsers = parser.add_subparsers(
    dest="command",
)
list_parser = subparsers.add_parser('list')
parser.parse_args(['--version'])

the output:

usage: myscript.py [-h] [-v] {list} ...
myscript.py: error: too few arguments

chepner · Accepted Answer · 2015-04-29 14:26:15Z

4

If you only need version to work, you can do this:

import argparse

parser = argparse.ArgumentParser()
parser.add_argument(
    '-v', '--version',
    action='version',
    version='%(prog)s 1.0',
)

Subparsers won't bother any more; the special version action is processed and exits the script before the parser looks for subcommands.

edited Apr 29, 2015 at 14:26

chepner

538k77 gold badges594 silver badges746 bronze badges

answered Apr 29, 2015 at 14:24

ljk321

16.8k7 gold badges52 silver badges60 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

hpaulj · Accepted Answer · 2015-04-29 22:11:52Z

2

The subparsers is a kind of positional argument. So normally that's required (just as though you'd specified add_argument('foo')).

skyline's suggestion works because action='version' is an action class that exits after displaying its information, just like the default -h.

There is bug/feature in the latest argparse that makes subparsers optional. Depending on how that is resolved, it may be possible in the future to give the add_subparsers command a required=False parameter. But the intended design is that subparsers will be required, unless a flagged argument (like '-h') short circuits the parsing.

answered Apr 29, 2015 at 22:11

hpaulj

233k14 gold badges260 silver badges392 bronze badges

Collectives™ on Stack Overflow

How to use top-level arguments with subparsers in argparse

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related