getopt
index
/usr/lib/python2.2/getopt.py

Parser for command line options.
 
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
provides a single function and an exception:
 
getopt() -- Parse command line options
GetoptError -- exception (class) raised with 'opt' attribute, which is the
option involved with the exception.

 
Classes
            
exceptions.Exception
GetoptError
GetoptError
 
class GetoptError(exceptions.Exception)
       
   Methods defined here:
__init__(self, msg, opt)
__str__(self)

Data and non-method functions defined here:
__doc__ = None
__module__ = 'getopt'
msg = ''
opt = ''

Methods inherited from exceptions.Exception:
__getitem__(...)
 
error = class GetoptError(exceptions.Exception)
       
   Methods defined here:
__init__(self, msg, opt)
__str__(self)

Data and non-method functions defined here:
__doc__ = None
__module__ = 'getopt'
msg = ''
opt = ''

Methods inherited from exceptions.Exception:
__getitem__(...)
 
Functions
            
do_longs(opts, opt, longopts, args)
do_shorts(opts, optstring, shortopts, args)
getopt(args, shortopts, longopts=[])
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.
long_has_args(opt, longopts)
# Return:
#   has_arg?
#   full option name
short_has_arg(opt, shortopts)
 
Data
             __all__ = ['GetoptError', 'error', 'getopt']
__file__ = '/usr/lib/python2.2/getopt.pyc'
__name__ = 'getopt'