Pythonic-optparse

179 Downloads

  pythonic.optparse - Lua-based partial reimplementation of Python's
      optparse [2-3] command-line parsing module.

SYNOPSIS

  local Optparse = Apollo.GetPackage("Optparse-0.3").tPackage
  local opt = OptParse:OptionParser{usage="%prog [options] [...]",
                           version="foo 1.23", add_help_option=false}
  opt.add_option{"-h", "--help", action="store_true", dest="help",
                 help="give this help", default="default"}
  opt.add_option{
    "-f", "--force", dest="force", action="store_true",
    help="force overwrite of output file"}

  local options, args = opt.parse_args()

DESCRIPTION

  This library provides a command-line parsing[1] similar to Python optparse [2-3].

  Note: Python also supports getopt [4].

STATUS
 
  This module is fairly basic but could be expanded.
 
API

  See source code and also compare to Python's docs [2,3] for details because
  the following documentation is incomplete.
 
  opt = OptionParser {command=command, usage=usage, version=version,
    add_help_option=add_help_option, callback_write=callback_write}
 
    Create command line parser.

    callback_write: If provided, this function will be used for output instead of the command channel
    command: Name of the slash command
 
  opt.add_options{shortflag, longflag, action=action, metavar=metavar, dest=dest, help=help, default=default}
 
    Add command line option specification.  This may be called multiple times.
 
  opt.parse_args() --> options, args
 
    Perform argument parsing.
 
DEPENDENCIES

  None (other than Lua 5.1 or 5.2)
 
REFERENCES

  [1] http://lua-users.org/wiki/CommandLineParsing
  [2] http://docs.python.org/lib/optparse-defining-options.html
  [3] http://blog.doughellmann.com/2007/08/pymotw-optparse.html
  [4] http://docs.python.org/lib/module-getopt.html