getopt.py 7.31 KB
Newer Older
1
"""Parser for command line options.
2 3 4 5 6 7

This module helps scripts to parse the command line arguments in
sys.argv.  It supports the same conventions as the Unix getopt()
function (including the special meanings of arguments of the form `-'
and `--').  Long options similar to those supported by GNU software
may be used as well via an optional third argument.  This module
8
provides two functions and an exception:
9 10

getopt() -- Parse command line options
11
gnu_getopt() -- Like getopt(), but allow option and non-option arguments
Tim Peters's avatar
Tim Peters committed
12
to be intermixed.
13 14
GetoptError -- exception (class) raised with 'opt' attribute, which is the
option involved with the exception.
15 16 17
"""

# Long option support added by Lars Wirzenius <liw@iki.fi>.
18
#
19 20
# Gerrit Holl <gerrit@nl.linux.org> moved the string-based exceptions
# to class-based exceptions.
21
#
22
# Peter Åstrand <astrand@lysator.liu.se> added gnu_getopt().
23 24 25 26 27 28 29 30 31 32
#
# TODO for gnu_getopt():
#
# - GNU getopt_long_only mechanism
# - allow the caller to specify ordering
# - RETURN_IN_ORDER option
# - GNU extension with '-' as first character of option string
# - optional arguments, specified by double colons
# - a option string with a W followed by semicolon should
#   treat "-W foo" as "--foo"
33

34
__all__ = ["GetoptError","error","getopt","gnu_getopt"]
Skip Montanaro's avatar
Skip Montanaro committed
35

36
import os
37 38 39 40 41
try:
    from gettext import gettext as _
except ImportError:
    # Bootstrapping Python: gettext's dependencies not built yet
    def _(s): return s
42

43 44 45
class GetoptError(Exception):
    opt = ''
    msg = ''
46
    def __init__(self, msg, opt=''):
47 48 49
        self.msg = msg
        self.opt = opt
        Exception.__init__(self, msg, opt)
50 51 52 53 54

    def __str__(self):
        return self.msg

error = GetoptError # backward compatibility
Guido van Rossum's avatar
Guido van Rossum committed
55

56
def getopt(args, shortopts, longopts = []):
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
    """getopt(args, options[, long_options]) -> opts, args

    Parses command line options and parameter list.  args is the
    argument list to be parsed, without the leading reference to the
    running program.  Typically, this means "sys.argv[1:]".  shortopts
    is the string of option letters that the script wants to
    recognize, with options that require an argument followed by a
    colon (i.e., the same format that Unix getopt() uses).  If
    specified, longopts is a list of strings with the names of the
    long options which should be supported.  The leading '--'
    characters should not be included in the option name.  Options
    which require an argument should be followed by an equal sign
    ('=').

    The return value consists of two elements: the first is a list of
    (option, value) pairs; the second is the list of program arguments
    left after the option list was stripped (this is a trailing slice
    of the first argument).  Each option-and-value pair returned has
    the option as its first element, prefixed with a hyphen (e.g.,
    '-x'), and the option argument as its second element, or an empty
    string if the option has no argument.  The options occur in the
    list in the same order in which they were found, thus allowing
    multiple occurrences.  Long and short options may be mixed.

    """

    opts = []
    if type(longopts) == type(""):
        longopts = [longopts]
    else:
        longopts = list(longopts)
Tim Peters's avatar
Tim Peters committed
88
    while args and args[0].startswith('-') and args[0] != '-':
89 90 91
        if args[0] == '--':
            args = args[1:]
            break
Fred Drake's avatar
Fred Drake committed
92
        if args[0].startswith('--'):
93
            opts, args = do_longs(opts, args[0][2:], longopts, args[1:])
94
        else:
95
            opts, args = do_shorts(opts, args[0][1:], shortopts, args[1:])
96

97
    return opts, args
98

99 100 101 102 103 104 105 106 107 108 109 110
def gnu_getopt(args, shortopts, longopts = []):
    """getopt(args, options[, long_options]) -> opts, args

    This function works like getopt(), except that GNU style scanning
    mode is used by default. This means that option and non-option
    arguments may be intermixed. The getopt() function stops
    processing options as soon as a non-option argument is
    encountered.

    If the first character of the option string is `+', or if the
    environment variable POSIXLY_CORRECT is set, then option
    processing stops as soon as a non-option argument is encountered.
Tim Peters's avatar
Tim Peters committed
111

112 113 114 115
    """

    opts = []
    prog_args = []
116
    if isinstance(longopts, str):
117 118 119 120 121 122 123
        longopts = [longopts]
    else:
        longopts = list(longopts)

    # Allow options after non-option arguments?
    if shortopts.startswith('+'):
        shortopts = shortopts[1:]
124
        all_options_first = True
125
    elif os.environ.get("POSIXLY_CORRECT"):
126
        all_options_first = True
127
    else:
128
        all_options_first = False
129 130 131 132 133 134 135 136

    while args:
        if args[0] == '--':
            prog_args += args[1:]
            break

        if args[0][:2] == '--':
            opts, args = do_longs(opts, args[0][2:], longopts, args[1:])
137
        elif args[0][:1] == '-' and args[0] != '-':
138 139 140 141 142 143 144 145 146 147 148
            opts, args = do_shorts(opts, args[0][1:], shortopts, args[1:])
        else:
            if all_options_first:
                prog_args += args
                break
            else:
                prog_args.append(args[0])
                args = args[1:]

    return opts, prog_args

149
def do_longs(opts, opt, longopts, args):
150
    try:
151
        i = opt.index('=')
152
    except ValueError:
153
        optarg = None
Tim Peters's avatar
Tim Peters committed
154 155
    else:
        opt, optarg = opt[:i], opt[i+1:]
156 157 158

    has_arg, opt = long_has_args(opt, longopts)
    if has_arg:
159 160
        if optarg is None:
            if not args:
161
                raise GetoptError(_('option --%s requires argument') % opt, opt)
162
            optarg, args = args[0], args[1:]
163
    elif optarg is not None:
164
        raise GetoptError(_('option --%s must not have an argument') % opt, opt)
165 166
    opts.append(('--' + opt, optarg or ''))
    return opts, args
167 168 169 170 171

# Return:
#   has_arg?
#   full option name
def long_has_args(opt, longopts):
172 173
    possibilities = [o for o in longopts if o.startswith(opt)]
    if not possibilities:
174
        raise GetoptError(_('option --%s not recognized') % opt, opt)
Tim Peters's avatar
Tim Peters committed
175 176
    # Is there an exact match?
    if opt in possibilities:
177
        return False, opt
Tim Peters's avatar
Tim Peters committed
178
    elif opt + '=' in possibilities:
179
        return True, opt
Tim Peters's avatar
Tim Peters committed
180 181 182 183
    # No exact match, so better be unique.
    if len(possibilities) > 1:
        # XXX since possibilities contains all valid continuations, might be
        # nice to work them into the error msg
184
        raise GetoptError(_('option --%s not a unique prefix') % opt, opt)
Tim Peters's avatar
Tim Peters committed
185 186 187 188 189 190
    assert len(possibilities) == 1
    unique_match = possibilities[0]
    has_arg = unique_match.endswith('=')
    if has_arg:
        unique_match = unique_match[:-1]
    return has_arg, unique_match
191

192
def do_shorts(opts, optstring, shortopts, args):
193
    while optstring != '':
194 195 196 197
        opt, optstring = optstring[0], optstring[1:]
        if short_has_arg(opt, shortopts):
            if optstring == '':
                if not args:
198
                    raise GetoptError(_('option -%s requires argument') % opt,
Fred Drake's avatar
Fred Drake committed
199
                                      opt)
200 201 202 203
                optstring, args = args[0], args[1:]
            optarg, optstring = optstring, ''
        else:
            optarg = ''
204 205
        opts.append(('-' + opt, optarg))
    return opts, args
206 207

def short_has_arg(opt, shortopts):
208
    for i in range(len(shortopts)):
209
        if opt == shortopts[i] != ':':
Fred Drake's avatar
Fred Drake committed
210
            return shortopts.startswith(':', i+1)
211
    raise GetoptError(_('option -%s not recognized') % opt, opt)
212 213

if __name__ == '__main__':
214
    import sys
215
    print(getopt(sys.argv[1:], "a:b", ["alpha=", "beta"]))