fancyopts.py
157 lines
| 4.6 KiB
| text/x-python
|
PythonLexer
/ mercurial / fancyopts.py
|
r8230 | # fancyopts.py - better command line parsing | ||
# | ||||
# Copyright 2005-2009 Matt Mackall <mpm@selenic.com> and others | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r8230 | |||
|
r25947 | from __future__ import absolute_import | ||
|
r20034 | import getopt | ||
|
r25947 | |||
from .i18n import _ | ||||
|
r26587 | from . import error | ||
|
r0 | |||
|
r29947 | # Set of flags to not apply boolean negation logic on | ||
nevernegate = set([ | ||||
# avoid --no-noninteractive | ||||
'noninteractive', | ||||
# These two flags are special because they cause hg to do one | ||||
# thing and then exit, and so aren't suitable for use in things | ||||
# like aliases anyway. | ||||
'help', | ||||
'version', | ||||
]) | ||||
|
r7772 | def gnugetopt(args, options, longoptions): | ||
"""Parse options mostly like getopt.gnu_getopt. | ||||
This is different from getopt.gnu_getopt in that an argument of - will | ||||
become an argument of - instead of vanishing completely. | ||||
""" | ||||
extraargs = [] | ||||
if '--' in args: | ||||
stopindex = args.index('--') | ||||
|
r10282 | extraargs = args[stopindex + 1:] | ||
|
r7772 | args = args[:stopindex] | ||
opts, parseargs = getopt.getopt(args, options, longoptions) | ||||
args = [] | ||||
while parseargs: | ||||
arg = parseargs.pop(0) | ||||
if arg and arg[0] == '-' and len(arg) > 1: | ||||
parseargs.insert(0, arg) | ||||
topts, newparseargs = getopt.getopt(parseargs, options, longoptions) | ||||
opts = opts + topts | ||||
parseargs = newparseargs | ||||
else: | ||||
args.append(arg) | ||||
args.extend(extraargs) | ||||
return opts, args | ||||
def fancyopts(args, options, state, gnu=False): | ||||
|
r5638 | """ | ||
read args, parse options, and store options in state | ||||
each option is a tuple of: | ||||
short option or '' | ||||
long option | ||||
default value | ||||
description | ||||
|
r11321 | option value label(optional) | ||
|
r5638 | |||
option types include: | ||||
boolean or none - option sets variable in state to true | ||||
string - parameter string is stored in state | ||||
list - parameter string is added to a list | ||||
integer - parameter strings is stored as int | ||||
function - call function with parameter | ||||
|
r0 | |||
|
r5638 | non-option args are returned | ||
""" | ||||
namelist = [] | ||||
shortlist = '' | ||||
argmap = {} | ||||
defmap = {} | ||||
|
r29947 | negations = {} | ||
alllong = set(o[1] for o in options) | ||||
|
r5638 | |||
|
r11321 | for option in options: | ||
if len(option) == 5: | ||||
short, name, default, comment, dummy = option | ||||
else: | ||||
short, name, default, comment = option | ||||
|
r5638 | # convert opts to getopt format | ||
oname = name | ||||
name = name.replace('-', '_') | ||||
argmap['-' + short] = argmap['--' + oname] = name | ||||
defmap[name] = default | ||||
# copy defaults to state | ||||
if isinstance(default, list): | ||||
state[name] = default[:] | ||||
|
r21794 | elif callable(default): | ||
|
r5638 | state[name] = None | ||
|
r5093 | else: | ||
|
r5638 | state[name] = default | ||
|
r0 | |||
|
r5638 | # does it take a parameter? | ||
if not (default is None or default is True or default is False): | ||||
|
r10282 | if short: | ||
short += ':' | ||||
if oname: | ||||
oname += '=' | ||||
|
r29947 | elif oname not in nevernegate: | ||
if oname.startswith('no-'): | ||||
insert = oname[3:] | ||||
else: | ||||
insert = 'no-' + oname | ||||
# backout (as a practical example) has both --commit and | ||||
# --no-commit options, so we don't want to allow the | ||||
# negations of those flags. | ||||
if insert not in alllong: | ||||
assert ('--' + oname) not in negations | ||||
negations['--' + insert] = '--' + oname | ||||
namelist.append(insert) | ||||
|
r5638 | if short: | ||
shortlist += short | ||||
if name: | ||||
namelist.append(oname) | ||||
# parse arguments | ||||
|
r7772 | if gnu: | ||
parse = gnugetopt | ||||
else: | ||||
parse = getopt.getopt | ||||
opts, args = parse(args, shortlist, namelist) | ||||
|
r0 | |||
|
r5638 | # transfer result to state | ||
for opt, val in opts: | ||||
|
r29947 | boolval = True | ||
negation = negations.get(opt, False) | ||||
if negation: | ||||
opt = negation | ||||
boolval = False | ||||
|
r5638 | name = argmap[opt] | ||
|
r25563 | obj = defmap[name] | ||
t = type(obj) | ||||
if callable(obj): | ||||
|
r5638 | state[name] = defmap[name](val) | ||
elif t is type(1): | ||||
|
r17712 | try: | ||
state[name] = int(val) | ||||
except ValueError: | ||||
|
r26587 | raise error.Abort(_('invalid value %r for option %s, ' | ||
|
r17712 | 'expected int') % (val, opt)) | ||
|
r5638 | elif t is type(''): | ||
state[name] = val | ||||
elif t is type([]): | ||||
state[name].append(val) | ||||
elif t is type(None) or t is type(False): | ||||
|
r29947 | state[name] = boolval | ||
|
r209 | |||
|
r5638 | # return unparsed args | ||
|
r0 | return args | ||