optional python arguments without dashes but with additional parameters?

Question

what I'd like to do in Python is accept arguments of the following format:

script.py START | STOP | STATUS | MOVEABS <x> <y> | MOVEREL <x> <y>

So in other words,

I don't want to deal with hyphens;
I have multiple possibilities, ONE of which is required;
Each is mutually exclusive;
Some of the commands (E.G. moveabs and moverel) have additional required arguments, but these args and should not be present with any other argument.

Can this be done in python and would I use argparse or something else? Thanks.

Yes. It is all documented here: docs.python.org/dev/library/argparse.html — Constantinius
– Constantinius, Commented Apr 25, 2014 at 23:37
possible duplicate of How to make python argparse mutually exclusive group arguments without prefix? — Constantinius
– Constantinius, Commented Apr 25, 2014 at 23:39
My answer elaborates on the subparser use in the accepted answer in Canstantinius's 'duplicate'. — hpaulj
– hpaulj, Commented Apr 26, 2014 at 6:41

IsaacS · Accepted Answer · 2018-07-25 05:00:15Z

9

add_parser with subparsers would do the trick

import argparse
parser = argparse.ArgumentParser(prog='script.py')
sp = parser.add_subparsers(dest='cmd')
for cmd in ['START', 'STOP', 'STATUS']:
    sp.add_parser(cmd)
for cmd in ['MOVEABS', 'MOVEREL']:
    spp = sp.add_parser(cmd)
    spp.add_argument('x', type=float)
    spp.add_argument('y', type=float)
parser.print_help()
args = parser.parse_args()
print(args)

producing the likes of:

2137:~/mypy$ python2.7 stack23304740.py MOVEREL -h
usage: script.py [-h] {START,STOP,STATUS,MOVEABS,MOVEREL} ...

positional arguments:
  {START,STOP,STATUS,MOVEABS,MOVEREL}

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

usage: script.py MOVEREL [-h] x y

positional arguments:
  x
  y

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

and

2146:~/mypy$ python2.7 stack23304740.py MOVEREL 1.0 2.0
...
Namespace(cmd='MOVEREL', x=1.0, y=2.0)

and

2147:~/mypy$ python2.7 stack23304740.py START
...
Namespace(cmd='START')

The MOVEREL arguments could be named <x> and <y>, but then you'd have to access them via args['<y>'] instead of args.y. metavar='<x>' could be used to change the display but not the Namespace name.

You could also use spp.add_argument('point', nargs=2, type=float). Unfortunately there's a bug that keeps us from using a metavar in this nargs=2 case, http://bugs.python.org/issue14074.

edited Jul 25, 2018 at 5:00

IsaacS

3,6316 gold badges42 silver badges69 bronze badges

answered Apr 26, 2014 at 4:38

hpaulj

233k14 gold badges260 silver badges392 bronze badges

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

2 Comments

majorgear Aug 31 at 3:55

How to you inspect the arguments in the Python script? eg if args.start: start() elif args.stop: stop() ?

hpaulj Aug 31 at 14:30

sys.argv is a list of the arguments. You can examine and parse that directly.

Jan Vlcinsky · Accepted Answer · 2014-04-25 23:59:01Z

5

Using docopt you can do this quite easily.

Install `docopt` first:

$ pip install docopt

Write the `script.py`:

"""
Usage:
    script.py (start | stop | status | moveabs <x> <y> | moverel <x> <y>)
"""
from docopt import docopt

if __name__ == "__main__":
    args = docopt(__doc__)
    print args

and run it:

first showing basic help:

$ python script.py
Usage:
    script.py (start | stop | status | moveabs <x> <y> | moverel <x> <y>)

then try subcommands:

start

$ python script.py start
{'<x>': None,
 '<y>': None,
 'moveabs': False,
 'moverel': False,
 'start': True,
 'status': False,
 'stop': False}

stop

$ python script.py stop
{'<x>': None,
 '<y>': None,
 'moveabs': False,
 'moverel': False,
 'start': False,
 'status': False,
 'stop': True}

moveabs

$ python script.py moveabs 11 22
{'<x>': '11',
 '<y>': '22',
 'moveabs': True,
 'moverel': False,
 'start': False,
 'status': False,
 'stop': False}

moverel

$ python script.py moverel 11 22
{'<x>': '11',
 '<y>': '22',
 'moveabs': False,
 'moverel': True,
 'start': False,
 'status': False,
 'stop': False}

edited Apr 25, 2014 at 23:59

answered Apr 25, 2014 at 23:53

Jan Vlcinsky

44.4k12 gold badges106 silver badges103 bronze badges

1 Comment

Eric O. Lebigot Over a year ago

The argparse solution does not produce unnecessary data fields, so I find it cleaner and more robust.

Collectives™ on Stack Overflow

optional python arguments without dashes but with additional parameters?

2 Answers 2

2 Comments

Install `docopt` first:

Write the `script.py`:

and run it:

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Install docopt first:

Write the script.py:

and run it:

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related

Install `docopt` first:

Write the `script.py`: