_scons_optparse.py
上传用户:market2
上传日期:2018-11-18
资源大小:18786k
文件大小:60k
源码类别:

外挂编程

开发平台:

Windows_Unix

  1. """optparse - a powerful, extensible, and easy-to-use option parser.
  2. By Greg Ward <gward@python.net>
  3. Originally distributed as Optik; see http://optik.sourceforge.net/ .
  4. If you have problems with this module, please do not file bugs,
  5. patches, or feature requests with Python; instead, use Optik's
  6. SourceForge project page:
  7.   http://sourceforge.net/projects/optik
  8. For support, use the optik-users@lists.sourceforge.net mailing list
  9. (http://lists.sourceforge.net/lists/listinfo/optik-users).
  10. """
  11. # Python developers: please do not make changes to this file, since
  12. # it is automatically generated from the Optik source code.
  13. __version__ = "1.5.3"
  14. __all__ = ['Option',
  15.            'SUPPRESS_HELP',
  16.            'SUPPRESS_USAGE',
  17.            'Values',
  18.            'OptionContainer',
  19.            'OptionGroup',
  20.            'OptionParser',
  21.            'HelpFormatter',
  22.            'IndentedHelpFormatter',
  23.            'TitledHelpFormatter',
  24.            'OptParseError',
  25.            'OptionError',
  26.            'OptionConflictError',
  27.            'OptionValueError',
  28.            'BadOptionError']
  29. __copyright__ = """
  30. Copyright (c) 2001-2006 Gregory P. Ward.  All rights reserved.
  31. Copyright (c) 2002-2006 Python Software Foundation.  All rights reserved.
  32. Redistribution and use in source and binary forms, with or without
  33. modification, are permitted provided that the following conditions are
  34. met:
  35.   * Redistributions of source code must retain the above copyright
  36.     notice, this list of conditions and the following disclaimer.
  37.   * Redistributions in binary form must reproduce the above copyright
  38.     notice, this list of conditions and the following disclaimer in the
  39.     documentation and/or other materials provided with the distribution.
  40.   * Neither the name of the author nor the names of its
  41.     contributors may be used to endorse or promote products derived from
  42.     this software without specific prior written permission.
  43. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  44. IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  45. TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  46. PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
  47. CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  48. EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  49. PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  50. PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  51. LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  52. NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  53. SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54. """
  55. import string
  56. import sys, os
  57. import types
  58. import textwrap
  59. def _repr(self):
  60.     return "<%s at 0x%x: %s>" % (self.__class__.__name__, id(self), self)
  61. try:
  62.     sys.getdefaultencoding
  63. except AttributeError:
  64.     def fake_getdefaultencoding():
  65.         return None
  66.     sys.getdefaultencoding = fake_getdefaultencoding
  67. try:
  68.     ''.encode
  69. except AttributeError:
  70.     def encode_wrapper(s, encoding, replacement):
  71.         return s
  72. else:
  73.     def encode_wrapper(s, encoding, replacement):
  74.         return s.encode(encoding, replacement)
  75. # This file was generated from:
  76. #   Id: option_parser.py 527 2006-07-23 15:21:30Z greg
  77. #   Id: option.py 522 2006-06-11 16:22:03Z gward
  78. #   Id: help.py 527 2006-07-23 15:21:30Z greg
  79. #   Id: errors.py 509 2006-04-20 00:58:24Z gward
  80. try:
  81.     from gettext import gettext
  82. except ImportError:
  83.     def gettext(message):
  84.         return message
  85. _ = gettext
  86. class OptParseError (Exception):
  87.     def __init__(self, msg):
  88.         self.msg = msg
  89.     def __str__(self):
  90.         return self.msg
  91. class OptionError (OptParseError):
  92.     """
  93.     Raised if an Option instance is created with invalid or
  94.     inconsistent arguments.
  95.     """
  96.     def __init__(self, msg, option):
  97.         self.msg = msg
  98.         self.option_id = str(option)
  99.     def __str__(self):
  100.         if self.option_id:
  101.             return "option %s: %s" % (self.option_id, self.msg)
  102.         else:
  103.             return self.msg
  104. class OptionConflictError (OptionError):
  105.     """
  106.     Raised if conflicting options are added to an OptionParser.
  107.     """
  108. class OptionValueError (OptParseError):
  109.     """
  110.     Raised if an invalid option value is encountered on the command
  111.     line.
  112.     """
  113. class BadOptionError (OptParseError):
  114.     """
  115.     Raised if an invalid option is seen on the command line.
  116.     """
  117.     def __init__(self, opt_str):
  118.         self.opt_str = opt_str
  119.     def __str__(self):
  120.         return _("no such option: %s") % self.opt_str
  121. class AmbiguousOptionError (BadOptionError):
  122.     """
  123.     Raised if an ambiguous option is seen on the command line.
  124.     """
  125.     def __init__(self, opt_str, possibilities):
  126.         BadOptionError.__init__(self, opt_str)
  127.         self.possibilities = possibilities
  128.     def __str__(self):
  129.         return (_("ambiguous option: %s (%s?)")
  130.                 % (self.opt_str, string.join(self.possibilities, ", ")))
  131. class HelpFormatter:
  132.     """
  133.     Abstract base class for formatting option help.  OptionParser
  134.     instances should use one of the HelpFormatter subclasses for
  135.     formatting help; by default IndentedHelpFormatter is used.
  136.     Instance attributes:
  137.       parser : OptionParser
  138.         the controlling OptionParser instance
  139.       indent_increment : int
  140.         the number of columns to indent per nesting level
  141.       max_help_position : int
  142.         the maximum starting column for option help text
  143.       help_position : int
  144.         the calculated starting column for option help text;
  145.         initially the same as the maximum
  146.       width : int
  147.         total number of columns for output (pass None to constructor for
  148.         this value to be taken from the $COLUMNS environment variable)
  149.       level : int
  150.         current indentation level
  151.       current_indent : int
  152.         current indentation level (in columns)
  153.       help_width : int
  154.         number of columns available for option help text (calculated)
  155.       default_tag : str
  156.         text to replace with each option's default value, "%default"
  157.         by default.  Set to false value to disable default value expansion.
  158.       option_strings : { Option : str }
  159.         maps Option instances to the snippet of help text explaining
  160.         the syntax of that option, e.g. "-h, --help" or
  161.         "-fFILE, --file=FILE"
  162.       _short_opt_fmt : str
  163.         format string controlling how short options with values are
  164.         printed in help text.  Must be either "%s%s" ("-fFILE") or
  165.         "%s %s" ("-f FILE"), because those are the two syntaxes that
  166.         Optik supports.
  167.       _long_opt_fmt : str
  168.         similar but for long options; must be either "%s %s" ("--file FILE")
  169.         or "%s=%s" ("--file=FILE").
  170.     """
  171.     NO_DEFAULT_VALUE = "none"
  172.     def __init__(self,
  173.                  indent_increment,
  174.                  max_help_position,
  175.                  width,
  176.                  short_first):
  177.         self.parser = None
  178.         self.indent_increment = indent_increment
  179.         self.help_position = self.max_help_position = max_help_position
  180.         if width is None:
  181.             try:
  182.                 width = int(os.environ['COLUMNS'])
  183.             except (KeyError, ValueError):
  184.                 width = 80
  185.             width = width - 2
  186.         self.width = width
  187.         self.current_indent = 0
  188.         self.level = 0
  189.         self.help_width = None          # computed later
  190.         self.short_first = short_first
  191.         self.default_tag = "%default"
  192.         self.option_strings = {}
  193.         self._short_opt_fmt = "%s %s"
  194.         self._long_opt_fmt = "%s=%s"
  195.     def set_parser(self, parser):
  196.         self.parser = parser
  197.     def set_short_opt_delimiter(self, delim):
  198.         if delim not in ("", " "):
  199.             raise ValueError(
  200.                 "invalid metavar delimiter for short options: %r" % delim)
  201.         self._short_opt_fmt = "%s" + delim + "%s"
  202.     def set_long_opt_delimiter(self, delim):
  203.         if delim not in ("=", " "):
  204.             raise ValueError(
  205.                 "invalid metavar delimiter for long options: %r" % delim)
  206.         self._long_opt_fmt = "%s" + delim + "%s"
  207.     def indent(self):
  208.         self.current_indent = self.current_indent + self.indent_increment
  209.         self.level = self.level + 1
  210.     def dedent(self):
  211.         self.current_indent = self.current_indent - self.indent_increment
  212.         assert self.current_indent >= 0, "Indent decreased below 0."
  213.         self.level = self.level - 1
  214.     def format_usage(self, usage):
  215.         raise NotImplementedError, "subclasses must implement"
  216.     def format_heading(self, heading):
  217.         raise NotImplementedError, "subclasses must implement"
  218.     def _format_text(self, text):
  219.         """
  220.         Format a paragraph of free-form text for inclusion in the
  221.         help output at the current indentation level.
  222.         """
  223.         text_width = self.width - self.current_indent
  224.         indent = " "*self.current_indent
  225.         return textwrap.fill(text,
  226.                              text_width,
  227.                              initial_indent=indent,
  228.                              subsequent_indent=indent)
  229.     def format_description(self, description):
  230.         if description:
  231.             return self._format_text(description) + "n"
  232.         else:
  233.             return ""
  234.     def format_epilog(self, epilog):
  235.         if epilog:
  236.             return "n" + self._format_text(epilog) + "n"
  237.         else:
  238.             return ""
  239.     def expand_default(self, option):
  240.         if self.parser is None or not self.default_tag:
  241.             return option.help
  242.         default_value = self.parser.defaults.get(option.dest)
  243.         if default_value is NO_DEFAULT or default_value is None:
  244.             default_value = self.NO_DEFAULT_VALUE
  245.         return string.replace(option.help, self.default_tag, str(default_value))
  246.     def format_option(self, option):
  247.         # The help for each option consists of two parts:
  248.         #   * the opt strings and metavars
  249.         #     eg. ("-x", or "-fFILENAME, --file=FILENAME")
  250.         #   * the user-supplied help string
  251.         #     eg. ("turn on expert mode", "read data from FILENAME")
  252.         #
  253.         # If possible, we write both of these on the same line:
  254.         #   -x      turn on expert mode
  255.         #
  256.         # But if the opt string list is too long, we put the help
  257.         # string on a second line, indented to the same column it would
  258.         # start in if it fit on the first line.
  259.         #   -fFILENAME, --file=FILENAME
  260.         #           read data from FILENAME
  261.         result = []
  262.         opts = self.option_strings[option]
  263.         opt_width = self.help_position - self.current_indent - 2
  264.         if len(opts) > opt_width:
  265.             opts = "%*s%sn" % (self.current_indent, "", opts)
  266.             indent_first = self.help_position
  267.         else:                       # start help on same line as opts
  268.             opts = "%*s%-*s  " % (self.current_indent, "", opt_width, opts)
  269.             indent_first = 0
  270.         result.append(opts)
  271.         if option.help:
  272.             help_text = self.expand_default(option)
  273.             help_lines = textwrap.wrap(help_text, self.help_width)
  274.             result.append("%*s%sn" % (indent_first, "", help_lines[0]))
  275.             for line in help_lines[1:]:
  276.                 result.append("%*s%sn" % (self.help_position, "", line))
  277.         elif opts[-1] != "n":
  278.             result.append("n")
  279.         return string.join(result, "")
  280.     def store_option_strings(self, parser):
  281.         self.indent()
  282.         max_len = 0
  283.         for opt in parser.option_list:
  284.             strings = self.format_option_strings(opt)
  285.             self.option_strings[opt] = strings
  286.             max_len = max(max_len, len(strings) + self.current_indent)
  287.         self.indent()
  288.         for group in parser.option_groups:
  289.             for opt in group.option_list:
  290.                 strings = self.format_option_strings(opt)
  291.                 self.option_strings[opt] = strings
  292.                 max_len = max(max_len, len(strings) + self.current_indent)
  293.         self.dedent()
  294.         self.dedent()
  295.         self.help_position = min(max_len + 2, self.max_help_position)
  296.         self.help_width = self.width - self.help_position
  297.     def format_option_strings(self, option):
  298.         """Return a comma-separated list of option strings & metavariables."""
  299.         if option.takes_value():
  300.             metavar = option.metavar or string.upper(option.dest)
  301.             short_opts = []
  302.             for sopt in option._short_opts:
  303.                 short_opts.append(self._short_opt_fmt % (sopt, metavar))
  304.             long_opts = []
  305.             for lopt in option._long_opts:
  306.                 long_opts.append(self._long_opt_fmt % (lopt, metavar))
  307.         else:
  308.             short_opts = option._short_opts
  309.             long_opts = option._long_opts
  310.         if self.short_first:
  311.             opts = short_opts + long_opts
  312.         else:
  313.             opts = long_opts + short_opts
  314.         return string.join(opts, ", ")
  315. class IndentedHelpFormatter (HelpFormatter):
  316.     """Format help with indented section bodies.
  317.     """
  318.     def __init__(self,
  319.                  indent_increment=2,
  320.                  max_help_position=24,
  321.                  width=None,
  322.                  short_first=1):
  323.         HelpFormatter.__init__(
  324.             self, indent_increment, max_help_position, width, short_first)
  325.     def format_usage(self, usage):
  326.         return _("Usage: %sn") % usage
  327.     def format_heading(self, heading):
  328.         return "%*s%s:n" % (self.current_indent, "", heading)
  329. class TitledHelpFormatter (HelpFormatter):
  330.     """Format help with underlined section headers.
  331.     """
  332.     def __init__(self,
  333.                  indent_increment=0,
  334.                  max_help_position=24,
  335.                  width=None,
  336.                  short_first=0):
  337.         HelpFormatter.__init__ (
  338.             self, indent_increment, max_help_position, width, short_first)
  339.     def format_usage(self, usage):
  340.         return "%s  %sn" % (self.format_heading(_("Usage")), usage)
  341.     def format_heading(self, heading):
  342.         return "%sn%sn" % (heading, "=-"[self.level] * len(heading))
  343. def _parse_num(val, type):
  344.     if string.lower(val[:2]) == "0x":         # hexadecimal
  345.         radix = 16
  346.     elif string.lower(val[:2]) == "0b":       # binary
  347.         radix = 2
  348.         val = val[2:] or "0"            # have to remove "0b" prefix
  349.     elif val[:1] == "0":                # octal
  350.         radix = 8
  351.     else:                               # decimal
  352.         radix = 10
  353.     return type(val, radix)
  354. def _parse_int(val):
  355.     return _parse_num(val, int)
  356. def _parse_long(val):
  357.     return _parse_num(val, long)
  358. try:
  359.     int('0', 10)
  360. except TypeError:
  361.     # Python 1.5.2 doesn't allow a radix value to be passed to int().
  362.     _parse_int = int
  363. try:
  364.     long('0', 10)
  365. except TypeError:
  366.     # Python 1.5.2 doesn't allow a radix value to be passed to long().
  367.     _parse_long = long
  368. _builtin_cvt = { "int" : (_parse_int, _("integer")),
  369.                  "long" : (_parse_long, _("long integer")),
  370.                  "float" : (float, _("floating-point")),
  371.                  "complex" : (complex, _("complex")) }
  372. def check_builtin(option, opt, value):
  373.     (cvt, what) = _builtin_cvt[option.type]
  374.     try:
  375.         return cvt(value)
  376.     except ValueError:
  377.         raise OptionValueError(
  378.             _("option %s: invalid %s value: %r") % (opt, what, value))
  379. def check_choice(option, opt, value):
  380.     if value in option.choices:
  381.         return value
  382.     else:
  383.         choices = string.join(map(repr, option.choices), ", ")
  384.         raise OptionValueError(
  385.             _("option %s: invalid choice: %r (choose from %s)")
  386.             % (opt, value, choices))
  387. # Not supplying a default is different from a default of None,
  388. # so we need an explicit "not supplied" value.
  389. NO_DEFAULT = ("NO", "DEFAULT")
  390. class Option:
  391.     """
  392.     Instance attributes:
  393.       _short_opts : [string]
  394.       _long_opts : [string]
  395.       action : string
  396.       type : string
  397.       dest : string
  398.       default : any
  399.       nargs : int
  400.       const : any
  401.       choices : [string]
  402.       callback : function
  403.       callback_args : (any*)
  404.       callback_kwargs : { string : any }
  405.       help : string
  406.       metavar : string
  407.     """
  408.     # The list of instance attributes that may be set through
  409.     # keyword args to the constructor.
  410.     ATTRS = ['action',
  411.              'type',
  412.              'dest',
  413.              'default',
  414.              'nargs',
  415.              'const',
  416.              'choices',
  417.              'callback',
  418.              'callback_args',
  419.              'callback_kwargs',
  420.              'help',
  421.              'metavar']
  422.     # The set of actions allowed by option parsers.  Explicitly listed
  423.     # here so the constructor can validate its arguments.
  424.     ACTIONS = ("store",
  425.                "store_const",
  426.                "store_true",
  427.                "store_false",
  428.                "append",
  429.                "append_const",
  430.                "count",
  431.                "callback",
  432.                "help",
  433.                "version")
  434.     # The set of actions that involve storing a value somewhere;
  435.     # also listed just for constructor argument validation.  (If
  436.     # the action is one of these, there must be a destination.)
  437.     STORE_ACTIONS = ("store",
  438.                      "store_const",
  439.                      "store_true",
  440.                      "store_false",
  441.                      "append",
  442.                      "append_const",
  443.                      "count")
  444.     # The set of actions for which it makes sense to supply a value
  445.     # type, ie. which may consume an argument from the command line.
  446.     TYPED_ACTIONS = ("store",
  447.                      "append",
  448.                      "callback")
  449.     # The set of actions which *require* a value type, ie. that
  450.     # always consume an argument from the command line.
  451.     ALWAYS_TYPED_ACTIONS = ("store",
  452.                             "append")
  453.     # The set of actions which take a 'const' attribute.
  454.     CONST_ACTIONS = ("store_const",
  455.                      "append_const")
  456.     # The set of known types for option parsers.  Again, listed here for
  457.     # constructor argument validation.
  458.     TYPES = ("string", "int", "long", "float", "complex", "choice")
  459.     # Dictionary of argument checking functions, which convert and
  460.     # validate option arguments according to the option type.
  461.     #
  462.     # Signature of checking functions is:
  463.     #   check(option : Option, opt : string, value : string) -> any
  464.     # where
  465.     #   option is the Option instance calling the checker
  466.     #   opt is the actual option seen on the command-line
  467.     #     (eg. "-a", "--file")
  468.     #   value is the option argument seen on the command-line
  469.     #
  470.     # The return value should be in the appropriate Python type
  471.     # for option.type -- eg. an integer if option.type == "int".
  472.     #
  473.     # If no checker is defined for a type, arguments will be
  474.     # unchecked and remain strings.
  475.     TYPE_CHECKER = { "int"    : check_builtin,
  476.                      "long"   : check_builtin,
  477.                      "float"  : check_builtin,
  478.                      "complex": check_builtin,
  479.                      "choice" : check_choice,
  480.                    }
  481.     # CHECK_METHODS is a list of unbound method objects; they are called
  482.     # by the constructor, in order, after all attributes are
  483.     # initialized.  The list is created and filled in later, after all
  484.     # the methods are actually defined.  (I just put it here because I
  485.     # like to define and document all class attributes in the same
  486.     # place.)  Subclasses that add another _check_*() method should
  487.     # define their own CHECK_METHODS list that adds their check method
  488.     # to those from this class.
  489.     CHECK_METHODS = None
  490.     # -- Constructor/initialization methods ----------------------------
  491.     def __init__(self, *opts, **attrs):
  492.         # Set _short_opts, _long_opts attrs from 'opts' tuple.
  493.         # Have to be set now, in case no option strings are supplied.
  494.         self._short_opts = []
  495.         self._long_opts = []
  496.         opts = self._check_opt_strings(opts)
  497.         self._set_opt_strings(opts)
  498.         # Set all other attrs (action, type, etc.) from 'attrs' dict
  499.         self._set_attrs(attrs)
  500.         # Check all the attributes we just set.  There are lots of
  501.         # complicated interdependencies, but luckily they can be farmed
  502.         # out to the _check_*() methods listed in CHECK_METHODS -- which
  503.         # could be handy for subclasses!  The one thing these all share
  504.         # is that they raise OptionError if they discover a problem.
  505.         for checker in self.CHECK_METHODS:
  506.             checker(self)
  507.     def _check_opt_strings(self, opts):
  508.         # Filter out None because early versions of Optik had exactly
  509.         # one short option and one long option, either of which
  510.         # could be None.
  511.         opts = filter(None, opts)
  512.         if not opts:
  513.             raise TypeError("at least one option string must be supplied")
  514.         return opts
  515.     def _set_opt_strings(self, opts):
  516.         for opt in opts:
  517.             if len(opt) < 2:
  518.                 raise OptionError(
  519.                     "invalid option string %r: "
  520.                     "must be at least two characters long" % opt, self)
  521.             elif len(opt) == 2:
  522.                 if not (opt[0] == "-" and opt[1] != "-"):
  523.                     raise OptionError(
  524.                         "invalid short option string %r: "
  525.                         "must be of the form -x, (x any non-dash char)" % opt,
  526.                         self)
  527.                 self._short_opts.append(opt)
  528.             else:
  529.                 if not (opt[0:2] == "--" and opt[2] != "-"):
  530.                     raise OptionError(
  531.                         "invalid long option string %r: "
  532.                         "must start with --, followed by non-dash" % opt,
  533.                         self)
  534.                 self._long_opts.append(opt)
  535.     def _set_attrs(self, attrs):
  536.         for attr in self.ATTRS:
  537.             if attrs.has_key(attr):
  538.                 setattr(self, attr, attrs[attr])
  539.                 del attrs[attr]
  540.             else:
  541.                 if attr == 'default':
  542.                     setattr(self, attr, NO_DEFAULT)
  543.                 else:
  544.                     setattr(self, attr, None)
  545.         if attrs:
  546.             attrs = attrs.keys()
  547.             attrs.sort()
  548.             raise OptionError(
  549.                 "invalid keyword arguments: %s" % string.join(attrs, ", "),
  550.                 self)
  551.     # -- Constructor validation methods --------------------------------
  552.     def _check_action(self):
  553.         if self.action is None:
  554.             self.action = "store"
  555.         elif self.action not in self.ACTIONS:
  556.             raise OptionError("invalid action: %r" % self.action, self)
  557.     def _check_type(self):
  558.         if self.type is None:
  559.             if self.action in self.ALWAYS_TYPED_ACTIONS:
  560.                 if self.choices is not None:
  561.                     # The "choices" attribute implies "choice" type.
  562.                     self.type = "choice"
  563.                 else:
  564.                     # No type given?  "string" is the most sensible default.
  565.                     self.type = "string"
  566.         else:
  567.             # Allow type objects or builtin type conversion functions
  568.             # (int, str, etc.) as an alternative to their names.  (The
  569.             # complicated check of __builtin__ is only necessary for
  570.             # Python 2.1 and earlier, and is short-circuited by the
  571.             # first check on modern Pythons.)
  572.             import __builtin__
  573.             if ( type(self.type) is types.TypeType or
  574.                  (hasattr(self.type, "__name__") and
  575.                   getattr(__builtin__, self.type.__name__, None) is self.type) ):
  576.                 self.type = self.type.__name__
  577.             if self.type == "str":
  578.                 self.type = "string"
  579.             if self.type not in self.TYPES:
  580.                 raise OptionError("invalid option type: %r" % self.type, self)
  581.             if self.action not in self.TYPED_ACTIONS:
  582.                 raise OptionError(
  583.                     "must not supply a type for action %r" % self.action, self)
  584.     def _check_choice(self):
  585.         if self.type == "choice":
  586.             if self.choices is None:
  587.                 raise OptionError(
  588.                     "must supply a list of choices for type 'choice'", self)
  589.             elif type(self.choices) not in (types.TupleType, types.ListType):
  590.                 raise OptionError(
  591.                     "choices must be a list of strings ('%s' supplied)"
  592.                     % string.split(str(type(self.choices)), "'")[1], self)
  593.         elif self.choices is not None:
  594.             raise OptionError(
  595.                 "must not supply choices for type %r" % self.type, self)
  596.     def _check_dest(self):
  597.         # No destination given, and we need one for this action.  The
  598.         # self.type check is for callbacks that take a value.
  599.         takes_value = (self.action in self.STORE_ACTIONS or
  600.                        self.type is not None)
  601.         if self.dest is None and takes_value:
  602.             # Glean a destination from the first long option string,
  603.             # or from the first short option string if no long options.
  604.             if self._long_opts:
  605.                 # eg. "--foo-bar" -> "foo_bar"
  606.                 self.dest = string.replace(self._long_opts[0][2:], '-', '_')
  607.             else:
  608.                 self.dest = self._short_opts[0][1]
  609.     def _check_const(self):
  610.         if self.action not in self.CONST_ACTIONS and self.const is not None:
  611.             raise OptionError(
  612.                 "'const' must not be supplied for action %r" % self.action,
  613.                 self)
  614.     def _check_nargs(self):
  615.         if self.action in self.TYPED_ACTIONS:
  616.             if self.nargs is None:
  617.                 self.nargs = 1
  618.         elif self.nargs is not None:
  619.             raise OptionError(
  620.                 "'nargs' must not be supplied for action %r" % self.action,
  621.                 self)
  622.     def _check_callback(self):
  623.         if self.action == "callback":
  624.             if not callable(self.callback):
  625.                 raise OptionError(
  626.                     "callback not callable: %r" % self.callback, self)
  627.             if (self.callback_args is not None and
  628.                 type(self.callback_args) is not types.TupleType):
  629.                 raise OptionError(
  630.                     "callback_args, if supplied, must be a tuple: not %r"
  631.                     % self.callback_args, self)
  632.             if (self.callback_kwargs is not None and
  633.                 type(self.callback_kwargs) is not types.DictType):
  634.                 raise OptionError(
  635.                     "callback_kwargs, if supplied, must be a dict: not %r"
  636.                     % self.callback_kwargs, self)
  637.         else:
  638.             if self.callback is not None:
  639.                 raise OptionError(
  640.                     "callback supplied (%r) for non-callback option"
  641.                     % self.callback, self)
  642.             if self.callback_args is not None:
  643.                 raise OptionError(
  644.                     "callback_args supplied for non-callback option", self)
  645.             if self.callback_kwargs is not None:
  646.                 raise OptionError(
  647.                     "callback_kwargs supplied for non-callback option", self)
  648.     CHECK_METHODS = [_check_action,
  649.                      _check_type,
  650.                      _check_choice,
  651.                      _check_dest,
  652.                      _check_const,
  653.                      _check_nargs,
  654.                      _check_callback]
  655.     # -- Miscellaneous methods -----------------------------------------
  656.     def __str__(self):
  657.         return string.join(self._short_opts + self._long_opts, "/")
  658.     __repr__ = _repr
  659.     def takes_value(self):
  660.         return self.type is not None
  661.     def get_opt_string(self):
  662.         if self._long_opts:
  663.             return self._long_opts[0]
  664.         else:
  665.             return self._short_opts[0]
  666.     # -- Processing methods --------------------------------------------
  667.     def check_value(self, opt, value):
  668.         checker = self.TYPE_CHECKER.get(self.type)
  669.         if checker is None:
  670.             return value
  671.         else:
  672.             return checker(self, opt, value)
  673.     def convert_value(self, opt, value):
  674.         if value is not None:
  675.             if self.nargs == 1:
  676.                 return self.check_value(opt, value)
  677.             else:
  678.                 return tuple(map(lambda v, o=opt, s=self: s.check_value(o, v), value))
  679.     def process(self, opt, value, values, parser):
  680.         # First, convert the value(s) to the right type.  Howl if any
  681.         # value(s) are bogus.
  682.         value = self.convert_value(opt, value)
  683.         # And then take whatever action is expected of us.
  684.         # This is a separate method to make life easier for
  685.         # subclasses to add new actions.
  686.         return self.take_action(
  687.             self.action, self.dest, opt, value, values, parser)
  688.     def take_action(self, action, dest, opt, value, values, parser):
  689.         if action == "store":
  690.             setattr(values, dest, value)
  691.         elif action == "store_const":
  692.             setattr(values, dest, self.const)
  693.         elif action == "store_true":
  694.             setattr(values, dest, True)
  695.         elif action == "store_false":
  696.             setattr(values, dest, False)
  697.         elif action == "append":
  698.             values.ensure_value(dest, []).append(value)
  699.         elif action == "append_const":
  700.             values.ensure_value(dest, []).append(self.const)
  701.         elif action == "count":
  702.             setattr(values, dest, values.ensure_value(dest, 0) + 1)
  703.         elif action == "callback":
  704.             args = self.callback_args or ()
  705.             kwargs = self.callback_kwargs or {}
  706.             apply(self.callback, (self, opt, value, parser,) + args, kwargs)
  707.         elif action == "help":
  708.             parser.print_help()
  709.             parser.exit()
  710.         elif action == "version":
  711.             parser.print_version()
  712.             parser.exit()
  713.         else:
  714.             raise RuntimeError, "unknown action %r" % self.action
  715.         return 1
  716. # class Option
  717. SUPPRESS_HELP = "SUPPRESS"+"HELP"
  718. SUPPRESS_USAGE = "SUPPRESS"+"USAGE"
  719. # For compatibility with Python 2.2
  720. try:
  721.     True, False
  722. except NameError:
  723.     (True, False) = (1, 0)
  724. try:
  725.     types.UnicodeType
  726. except AttributeError:
  727.     def isbasestring(x):
  728.         return isinstance(x, types.StringType)
  729. else:
  730.     def isbasestring(x):
  731.         return isinstance(x, types.StringType) or isinstance(x, types.UnicodeType)
  732. class Values:
  733.     def __init__(self, defaults=None):
  734.         if defaults:
  735.             for (attr, val) in defaults.items():
  736.                 setattr(self, attr, val)
  737.     def __str__(self):
  738.         return str(self.__dict__)
  739.     __repr__ = _repr
  740.     def __cmp__(self, other):
  741.         if isinstance(other, Values):
  742.             return cmp(self.__dict__, other.__dict__)
  743.         elif isinstance(other, types.DictType):
  744.             return cmp(self.__dict__, other)
  745.         else:
  746.             return -1
  747.     def _update_careful(self, dict):
  748.         """
  749.         Update the option values from an arbitrary dictionary, but only
  750.         use keys from dict that already have a corresponding attribute
  751.         in self.  Any keys in dict without a corresponding attribute
  752.         are silently ignored.
  753.         """
  754.         for attr in dir(self):
  755.             if dict.has_key(attr):
  756.                 dval = dict[attr]
  757.                 if dval is not None:
  758.                     setattr(self, attr, dval)
  759.     def _update_loose(self, dict):
  760.         """
  761.         Update the option values from an arbitrary dictionary,
  762.         using all keys from the dictionary regardless of whether
  763.         they have a corresponding attribute in self or not.
  764.         """
  765.         self.__dict__.update(dict)
  766.     def _update(self, dict, mode):
  767.         if mode == "careful":
  768.             self._update_careful(dict)
  769.         elif mode == "loose":
  770.             self._update_loose(dict)
  771.         else:
  772.             raise ValueError, "invalid update mode: %r" % mode
  773.     def read_module(self, modname, mode="careful"):
  774.         __import__(modname)
  775.         mod = sys.modules[modname]
  776.         self._update(vars(mod), mode)
  777.     def read_file(self, filename, mode="careful"):
  778.         vars = {}
  779.         execfile(filename, vars)
  780.         self._update(vars, mode)
  781.     def ensure_value(self, attr, value):
  782.         if not hasattr(self, attr) or getattr(self, attr) is None:
  783.             setattr(self, attr, value)
  784.         return getattr(self, attr)
  785. class OptionContainer:
  786.     """
  787.     Abstract base class.
  788.     Class attributes:
  789.       standard_option_list : [Option]
  790.         list of standard options that will be accepted by all instances
  791.         of this parser class (intended to be overridden by subclasses).
  792.     Instance attributes:
  793.       option_list : [Option]
  794.         the list of Option objects contained by this OptionContainer
  795.       _short_opt : { string : Option }
  796.         dictionary mapping short option strings, eg. "-f" or "-X",
  797.         to the Option instances that implement them.  If an Option
  798.         has multiple short option strings, it will appears in this
  799.         dictionary multiple times. [1]
  800.       _long_opt : { string : Option }
  801.         dictionary mapping long option strings, eg. "--file" or
  802.         "--exclude", to the Option instances that implement them.
  803.         Again, a given Option can occur multiple times in this
  804.         dictionary. [1]
  805.       defaults : { string : any }
  806.         dictionary mapping option destination names to default
  807.         values for each destination [1]
  808.     [1] These mappings are common to (shared by) all components of the
  809.         controlling OptionParser, where they are initially created.
  810.     """
  811.     def __init__(self, option_class, conflict_handler, description):
  812.         # Initialize the option list and related data structures.
  813.         # This method must be provided by subclasses, and it must
  814.         # initialize at least the following instance attributes:
  815.         # option_list, _short_opt, _long_opt, defaults.
  816.         self._create_option_list()
  817.         self.option_class = option_class
  818.         self.set_conflict_handler(conflict_handler)
  819.         self.set_description(description)
  820.     def _create_option_mappings(self):
  821.         # For use by OptionParser constructor -- create the master
  822.         # option mappings used by this OptionParser and all
  823.         # OptionGroups that it owns.
  824.         self._short_opt = {}            # single letter -> Option instance
  825.         self._long_opt = {}             # long option -> Option instance
  826.         self.defaults = {}              # maps option dest -> default value
  827.     def _share_option_mappings(self, parser):
  828.         # For use by OptionGroup constructor -- use shared option
  829.         # mappings from the OptionParser that owns this OptionGroup.
  830.         self._short_opt = parser._short_opt
  831.         self._long_opt = parser._long_opt
  832.         self.defaults = parser.defaults
  833.     def set_conflict_handler(self, handler):
  834.         if handler not in ("error", "resolve"):
  835.             raise ValueError, "invalid conflict_resolution value %r" % handler
  836.         self.conflict_handler = handler
  837.     def set_description(self, description):
  838.         self.description = description
  839.     def get_description(self):
  840.         return self.description
  841.     def destroy(self):
  842.         """see OptionParser.destroy()."""
  843.         del self._short_opt
  844.         del self._long_opt
  845.         del self.defaults
  846.     # -- Option-adding methods -----------------------------------------
  847.     def _check_conflict(self, option):
  848.         conflict_opts = []
  849.         for opt in option._short_opts:
  850.             if self._short_opt.has_key(opt):
  851.                 conflict_opts.append((opt, self._short_opt[opt]))
  852.         for opt in option._long_opts:
  853.             if self._long_opt.has_key(opt):
  854.                 conflict_opts.append((opt, self._long_opt[opt]))
  855.         if conflict_opts:
  856.             handler = self.conflict_handler
  857.             if handler == "error":
  858.                 raise OptionConflictError(
  859.                     "conflicting option string(s): %s"
  860.                     % string.join(map(lambda co: co[0], conflict_opts), ", "),
  861.                     option)
  862.             elif handler == "resolve":
  863.                 for (opt, c_option) in conflict_opts:
  864.                     if opt[:2] == "--":
  865.                         c_option._long_opts.remove(opt)
  866.                         del self._long_opt[opt]
  867.                     else:
  868.                         c_option._short_opts.remove(opt)
  869.                         del self._short_opt[opt]
  870.                     if not (c_option._short_opts or c_option._long_opts):
  871.                         c_option.container.option_list.remove(c_option)
  872.     def add_option(self, *args, **kwargs):
  873.         """add_option(Option)
  874.            add_option(opt_str, ..., kwarg=val, ...)
  875.         """
  876.         if type(args[0]) is types.StringType:
  877.             option = apply(self.option_class, args, kwargs)
  878.         elif len(args) == 1 and not kwargs:
  879.             option = args[0]
  880.             if not isinstance(option, Option):
  881.                 raise TypeError, "not an Option instance: %r" % option
  882.         else:
  883.             raise TypeError, "invalid arguments"
  884.         self._check_conflict(option)
  885.         self.option_list.append(option)
  886.         option.container = self
  887.         for opt in option._short_opts:
  888.             self._short_opt[opt] = option
  889.         for opt in option._long_opts:
  890.             self._long_opt[opt] = option
  891.         if option.dest is not None:     # option has a dest, we need a default
  892.             if option.default is not NO_DEFAULT:
  893.                 self.defaults[option.dest] = option.default
  894.             elif not self.defaults.has_key(option.dest):
  895.                 self.defaults[option.dest] = None
  896.         return option
  897.     def add_options(self, option_list):
  898.         for option in option_list:
  899.             self.add_option(option)
  900.     # -- Option query/removal methods ----------------------------------
  901.     def get_option(self, opt_str):
  902.         return (self._short_opt.get(opt_str) or
  903.                 self._long_opt.get(opt_str))
  904.     def has_option(self, opt_str):
  905.         return (self._short_opt.has_key(opt_str) or
  906.                 self._long_opt.has_key(opt_str))
  907.     def remove_option(self, opt_str):
  908.         option = self._short_opt.get(opt_str)
  909.         if option is None:
  910.             option = self._long_opt.get(opt_str)
  911.         if option is None:
  912.             raise ValueError("no such option %r" % opt_str)
  913.         for opt in option._short_opts:
  914.             del self._short_opt[opt]
  915.         for opt in option._long_opts:
  916.             del self._long_opt[opt]
  917.         option.container.option_list.remove(option)
  918.     # -- Help-formatting methods ---------------------------------------
  919.     def format_option_help(self, formatter):
  920.         if not self.option_list:
  921.             return ""
  922.         result = []
  923.         for option in self.option_list:
  924.             if not option.help is SUPPRESS_HELP:
  925.                 result.append(formatter.format_option(option))
  926.         return string.join(result, "")
  927.     def format_description(self, formatter):
  928.         return formatter.format_description(self.get_description())
  929.     def format_help(self, formatter):
  930.         result = []
  931.         if self.description:
  932.             result.append(self.format_description(formatter))
  933.         if self.option_list:
  934.             result.append(self.format_option_help(formatter))
  935.         return string.join(result, "n")
  936. class OptionGroup (OptionContainer):
  937.     def __init__(self, parser, title, description=None):
  938.         self.parser = parser
  939.         OptionContainer.__init__(
  940.             self, parser.option_class, parser.conflict_handler, description)
  941.         self.title = title
  942.     def _create_option_list(self):
  943.         self.option_list = []
  944.         self._share_option_mappings(self.parser)
  945.     def set_title(self, title):
  946.         self.title = title
  947.     def destroy(self):
  948.         """see OptionParser.destroy()."""
  949.         OptionContainer.destroy(self)
  950.         del self.option_list
  951.     # -- Help-formatting methods ---------------------------------------
  952.     def format_help(self, formatter):
  953.         result = formatter.format_heading(self.title)
  954.         formatter.indent()
  955.         result = result + OptionContainer.format_help(self, formatter)
  956.         formatter.dedent()
  957.         return result
  958. class OptionParser (OptionContainer):
  959.     """
  960.     Class attributes:
  961.       standard_option_list : [Option]
  962.         list of standard options that will be accepted by all instances
  963.         of this parser class (intended to be overridden by subclasses).
  964.     Instance attributes:
  965.       usage : string
  966.         a usage string for your program.  Before it is displayed
  967.         to the user, "%prog" will be expanded to the name of
  968.         your program (self.prog or os.path.basename(sys.argv[0])).
  969.       prog : string
  970.         the name of the current program (to override
  971.         os.path.basename(sys.argv[0])).
  972.       epilog : string
  973.         paragraph of help text to print after option help
  974.       option_groups : [OptionGroup]
  975.         list of option groups in this parser (option groups are
  976.         irrelevant for parsing the command-line, but very useful
  977.         for generating help)
  978.       allow_interspersed_args : bool = true
  979.         if true, positional arguments may be interspersed with options.
  980.         Assuming -a and -b each take a single argument, the command-line
  981.           -ablah foo bar -bboo baz
  982.         will be interpreted the same as
  983.           -ablah -bboo -- foo bar baz
  984.         If this flag were false, that command line would be interpreted as
  985.           -ablah -- foo bar -bboo baz
  986.         -- ie. we stop processing options as soon as we see the first
  987.         non-option argument.  (This is the tradition followed by
  988.         Python's getopt module, Perl's Getopt::Std, and other argument-
  989.         parsing libraries, but it is generally annoying to users.)
  990.       process_default_values : bool = true
  991.         if true, option default values are processed similarly to option
  992.         values from the command line: that is, they are passed to the
  993.         type-checking function for the option's type (as long as the
  994.         default value is a string).  (This really only matters if you
  995.         have defined custom types; see SF bug #955889.)  Set it to false
  996.         to restore the behaviour of Optik 1.4.1 and earlier.
  997.       rargs : [string]
  998.         the argument list currently being parsed.  Only set when
  999.         parse_args() is active, and continually trimmed down as
  1000.         we consume arguments.  Mainly there for the benefit of
  1001.         callback options.
  1002.       largs : [string]
  1003.         the list of leftover arguments that we have skipped while
  1004.         parsing options.  If allow_interspersed_args is false, this
  1005.         list is always empty.
  1006.       values : Values
  1007.         the set of option values currently being accumulated.  Only
  1008.         set when parse_args() is active.  Also mainly for callbacks.
  1009.     Because of the 'rargs', 'largs', and 'values' attributes,
  1010.     OptionParser is not thread-safe.  If, for some perverse reason, you
  1011.     need to parse command-line arguments simultaneously in different
  1012.     threads, use different OptionParser instances.
  1013.     """
  1014.     standard_option_list = []
  1015.     def __init__(self,
  1016.                  usage=None,
  1017.                  option_list=None,
  1018.                  option_class=Option,
  1019.                  version=None,
  1020.                  conflict_handler="error",
  1021.                  description=None,
  1022.                  formatter=None,
  1023.                  add_help_option=True,
  1024.                  prog=None,
  1025.                  epilog=None):
  1026.         OptionContainer.__init__(
  1027.             self, option_class, conflict_handler, description)
  1028.         self.set_usage(usage)
  1029.         self.prog = prog
  1030.         self.version = version
  1031.         self.allow_interspersed_args = True
  1032.         self.process_default_values = True
  1033.         if formatter is None:
  1034.             formatter = IndentedHelpFormatter()
  1035.         self.formatter = formatter
  1036.         self.formatter.set_parser(self)
  1037.         self.epilog = epilog
  1038.         # Populate the option list; initial sources are the
  1039.         # standard_option_list class attribute, the 'option_list'
  1040.         # argument, and (if applicable) the _add_version_option() and
  1041.         # _add_help_option() methods.
  1042.         self._populate_option_list(option_list,
  1043.                                    add_help=add_help_option)
  1044.         self._init_parsing_state()
  1045.     def destroy(self):
  1046.         """
  1047.         Declare that you are done with this OptionParser.  This cleans up
  1048.         reference cycles so the OptionParser (and all objects referenced by
  1049.         it) can be garbage-collected promptly.  After calling destroy(), the
  1050.         OptionParser is unusable.
  1051.         """
  1052.         OptionContainer.destroy(self)
  1053.         for group in self.option_groups:
  1054.             group.destroy()
  1055.         del self.option_list
  1056.         del self.option_groups
  1057.         del self.formatter
  1058.     # -- Private methods -----------------------------------------------
  1059.     # (used by our or OptionContainer's constructor)
  1060.     def _create_option_list(self):
  1061.         self.option_list = []
  1062.         self.option_groups = []
  1063.         self._create_option_mappings()
  1064.     def _add_help_option(self):
  1065.         self.add_option("-h", "--help",
  1066.                         action="help",
  1067.                         help=_("show this help message and exit"))
  1068.     def _add_version_option(self):
  1069.         self.add_option("--version",
  1070.                         action="version",
  1071.                         help=_("show program's version number and exit"))
  1072.     def _populate_option_list(self, option_list, add_help=True):
  1073.         if self.standard_option_list:
  1074.             self.add_options(self.standard_option_list)
  1075.         if option_list:
  1076.             self.add_options(option_list)
  1077.         if self.version:
  1078.             self._add_version_option()
  1079.         if add_help:
  1080.             self._add_help_option()
  1081.     def _init_parsing_state(self):
  1082.         # These are set in parse_args() for the convenience of callbacks.
  1083.         self.rargs = None
  1084.         self.largs = None
  1085.         self.values = None
  1086.     # -- Simple modifier methods ---------------------------------------
  1087.     def set_usage(self, usage):
  1088.         if usage is None:
  1089.             self.usage = _("%prog [options]")
  1090.         elif usage is SUPPRESS_USAGE:
  1091.             self.usage = None
  1092.         # For backwards compatibility with Optik 1.3 and earlier.
  1093.         elif string.lower(usage)[:7] == "usage: ":
  1094.             self.usage = usage[7:]
  1095.         else:
  1096.             self.usage = usage
  1097.     def enable_interspersed_args(self):
  1098.         self.allow_interspersed_args = True
  1099.     def disable_interspersed_args(self):
  1100.         self.allow_interspersed_args = False
  1101.     def set_process_default_values(self, process):
  1102.         self.process_default_values = process
  1103.     def set_default(self, dest, value):
  1104.         self.defaults[dest] = value
  1105.     def set_defaults(self, **kwargs):
  1106.         self.defaults.update(kwargs)
  1107.     def _get_all_options(self):
  1108.         options = self.option_list[:]
  1109.         for group in self.option_groups:
  1110.             options.extend(group.option_list)
  1111.         return options
  1112.     def get_default_values(self):
  1113.         if not self.process_default_values:
  1114.             # Old, pre-Optik 1.5 behaviour.
  1115.             return Values(self.defaults)
  1116.         defaults = self.defaults.copy()
  1117.         for option in self._get_all_options():
  1118.             default = defaults.get(option.dest)
  1119.             if isbasestring(default):
  1120.                 opt_str = option.get_opt_string()
  1121.                 defaults[option.dest] = option.check_value(opt_str, default)
  1122.         return Values(defaults)
  1123.     # -- OptionGroup methods -------------------------------------------
  1124.     def add_option_group(self, *args, **kwargs):
  1125.         # XXX lots of overlap with OptionContainer.add_option()
  1126.         if type(args[0]) is types.StringType:
  1127.             group = apply(OptionGroup, (self,) + args, kwargs)
  1128.         elif len(args) == 1 and not kwargs:
  1129.             group = args[0]
  1130.             if not isinstance(group, OptionGroup):
  1131.                 raise TypeError, "not an OptionGroup instance: %r" % group
  1132.             if group.parser is not self:
  1133.                 raise ValueError, "invalid OptionGroup (wrong parser)"
  1134.         else:
  1135.             raise TypeError, "invalid arguments"
  1136.         self.option_groups.append(group)
  1137.         return group
  1138.     def get_option_group(self, opt_str):
  1139.         option = (self._short_opt.get(opt_str) or
  1140.                   self._long_opt.get(opt_str))
  1141.         if option and option.container is not self:
  1142.             return option.container
  1143.         return None
  1144.     # -- Option-parsing methods ----------------------------------------
  1145.     def _get_args(self, args):
  1146.         if args is None:
  1147.             return sys.argv[1:]
  1148.         else:
  1149.             return args[:]              # don't modify caller's list
  1150.     def parse_args(self, args=None, values=None):
  1151.         """
  1152.         parse_args(args : [string] = sys.argv[1:],
  1153.                    values : Values = None)
  1154.         -> (values : Values, args : [string])
  1155.         Parse the command-line options found in 'args' (default:
  1156.         sys.argv[1:]).  Any errors result in a call to 'error()', which
  1157.         by default prints the usage message to stderr and calls
  1158.         sys.exit() with an error message.  On success returns a pair
  1159.         (values, args) where 'values' is an Values instance (with all
  1160.         your option values) and 'args' is the list of arguments left
  1161.         over after parsing options.
  1162.         """
  1163.         rargs = self._get_args(args)
  1164.         if values is None:
  1165.             values = self.get_default_values()
  1166.         # Store the halves of the argument list as attributes for the
  1167.         # convenience of callbacks:
  1168.         #   rargs
  1169.         #     the rest of the command-line (the "r" stands for
  1170.         #     "remaining" or "right-hand")
  1171.         #   largs
  1172.         #     the leftover arguments -- ie. what's left after removing
  1173.         #     options and their arguments (the "l" stands for "leftover"
  1174.         #     or "left-hand")
  1175.         self.rargs = rargs
  1176.         self.largs = largs = []
  1177.         self.values = values
  1178.         try:
  1179.             stop = self._process_args(largs, rargs, values)
  1180.         except (BadOptionError, OptionValueError), err:
  1181.             self.error(str(err))
  1182.         args = largs + rargs
  1183.         return self.check_values(values, args)
  1184.     def check_values(self, values, args):
  1185.         """
  1186.         check_values(values : Values, args : [string])
  1187.         -> (values : Values, args : [string])
  1188.         Check that the supplied option values and leftover arguments are
  1189.         valid.  Returns the option values and leftover arguments
  1190.         (possibly adjusted, possibly completely new -- whatever you
  1191.         like).  Default implementation just returns the passed-in
  1192.         values; subclasses may override as desired.
  1193.         """
  1194.         return (values, args)
  1195.     def _process_args(self, largs, rargs, values):
  1196.         """_process_args(largs : [string],
  1197.                          rargs : [string],
  1198.                          values : Values)
  1199.         Process command-line arguments and populate 'values', consuming
  1200.         options and arguments from 'rargs'.  If 'allow_interspersed_args' is
  1201.         false, stop at the first non-option argument.  If true, accumulate any
  1202.         interspersed non-option arguments in 'largs'.
  1203.         """
  1204.         while rargs:
  1205.             arg = rargs[0]
  1206.             # We handle bare "--" explicitly, and bare "-" is handled by the
  1207.             # standard arg handler since the short arg case ensures that the
  1208.             # len of the opt string is greater than 1.
  1209.             if arg == "--":
  1210.                 del rargs[0]
  1211.                 return
  1212.             elif arg[0:2] == "--":
  1213.                 # process a single long option (possibly with value(s))
  1214.                 self._process_long_opt(rargs, values)
  1215.             elif arg[:1] == "-" and len(arg) > 1:
  1216.                 # process a cluster of short options (possibly with
  1217.                 # value(s) for the last one only)
  1218.                 self._process_short_opts(rargs, values)
  1219.             elif self.allow_interspersed_args:
  1220.                 largs.append(arg)
  1221.                 del rargs[0]
  1222.             else:
  1223.                 return                  # stop now, leave this arg in rargs
  1224.         # Say this is the original argument list:
  1225.         # [arg0, arg1, ..., arg(i-1), arg(i), arg(i+1), ..., arg(N-1)]
  1226.         #                            ^
  1227.         # (we are about to process arg(i)).
  1228.         #
  1229.         # Then rargs is [arg(i), ..., arg(N-1)] and largs is a *subset* of
  1230.         # [arg0, ..., arg(i-1)] (any options and their arguments will have
  1231.         # been removed from largs).
  1232.         #
  1233.         # The while loop will usually consume 1 or more arguments per pass.
  1234.         # If it consumes 1 (eg. arg is an option that takes no arguments),
  1235.         # then after _process_arg() is done the situation is:
  1236.         #
  1237.         #   largs = subset of [arg0, ..., arg(i)]
  1238.         #   rargs = [arg(i+1), ..., arg(N-1)]
  1239.         #
  1240.         # If allow_interspersed_args is false, largs will always be
  1241.         # *empty* -- still a subset of [arg0, ..., arg(i-1)], but
  1242.         # not a very interesting subset!
  1243.     def _match_long_opt(self, opt):
  1244.         """_match_long_opt(opt : string) -> string
  1245.         Determine which long option string 'opt' matches, ie. which one
  1246.         it is an unambiguous abbrevation for.  Raises BadOptionError if
  1247.         'opt' doesn't unambiguously match any long option string.
  1248.         """
  1249.         return _match_abbrev(opt, self._long_opt)
  1250.     def _process_long_opt(self, rargs, values):
  1251.         arg = rargs.pop(0)
  1252.         # Value explicitly attached to arg?  Pretend it's the next
  1253.         # argument.
  1254.         if "=" in arg:
  1255.             (opt, next_arg) = string.split(arg, "=", 1)
  1256.             rargs.insert(0, next_arg)
  1257.             had_explicit_value = True
  1258.         else:
  1259.             opt = arg
  1260.             had_explicit_value = False
  1261.         opt = self._match_long_opt(opt)
  1262.         option = self._long_opt[opt]
  1263.         if option.takes_value():
  1264.             nargs = option.nargs
  1265.             if len(rargs) < nargs:
  1266.                 if nargs == 1:
  1267.                     self.error(_("%s option requires an argument") % opt)
  1268.                 else:
  1269.                     self.error(_("%s option requires %d arguments")
  1270.                                % (opt, nargs))
  1271.             elif nargs == 1:
  1272.                 value = rargs.pop(0)
  1273.             else:
  1274.                 value = tuple(rargs[0:nargs])
  1275.                 del rargs[0:nargs]
  1276.         elif had_explicit_value:
  1277.             self.error(_("%s option does not take a value") % opt)
  1278.         else:
  1279.             value = None
  1280.         option.process(opt, value, values, self)
  1281.     def _process_short_opts(self, rargs, values):
  1282.         arg = rargs.pop(0)
  1283.         stop = False
  1284.         i = 1
  1285.         for ch in arg[1:]:
  1286.             opt = "-" + ch
  1287.             option = self._short_opt.get(opt)
  1288.             i = i + 1                      # we have consumed a character
  1289.             if not option:
  1290.                 raise BadOptionError(opt)
  1291.             if option.takes_value():
  1292.                 # Any characters left in arg?  Pretend they're the
  1293.                 # next arg, and stop consuming characters of arg.
  1294.                 if i < len(arg):
  1295.                     rargs.insert(0, arg[i:])
  1296.                     stop = True
  1297.                 nargs = option.nargs
  1298.                 if len(rargs) < nargs:
  1299.                     if nargs == 1:
  1300.                         self.error(_("%s option requires an argument") % opt)
  1301.                     else:
  1302.                         self.error(_("%s option requires %d arguments")
  1303.                                    % (opt, nargs))
  1304.                 elif nargs == 1:
  1305.                     value = rargs.pop(0)
  1306.                 else:
  1307.                     value = tuple(rargs[0:nargs])
  1308.                     del rargs[0:nargs]
  1309.             else:                       # option doesn't take a value
  1310.                 value = None
  1311.             option.process(opt, value, values, self)
  1312.             if stop:
  1313.                 break
  1314.     # -- Feedback methods ----------------------------------------------
  1315.     def get_prog_name(self):
  1316.         if self.prog is None:
  1317.             return os.path.basename(sys.argv[0])
  1318.         else:
  1319.             return self.prog
  1320.     def expand_prog_name(self, s):
  1321.         return string.replace(s, "%prog", self.get_prog_name())
  1322.     def get_description(self):
  1323.         return self.expand_prog_name(self.description)
  1324.     def exit(self, status=0, msg=None):
  1325.         if msg:
  1326.             sys.stderr.write(msg)
  1327.         sys.exit(status)
  1328.     def error(self, msg):
  1329.         """error(msg : string)
  1330.         Print a usage message incorporating 'msg' to stderr and exit.
  1331.         If you override this in a subclass, it should not return -- it
  1332.         should either exit or raise an exception.
  1333.         """
  1334.         self.print_usage(sys.stderr)
  1335.         self.exit(2, "%s: error: %sn" % (self.get_prog_name(), msg))
  1336.     def get_usage(self):
  1337.         if self.usage:
  1338.             return self.formatter.format_usage(
  1339.                 self.expand_prog_name(self.usage))
  1340.         else:
  1341.             return ""
  1342.     def print_usage(self, file=None):
  1343.         """print_usage(file : file = stdout)
  1344.         Print the usage message for the current program (self.usage) to
  1345.         'file' (default stdout).  Any occurence of the string "%prog" in
  1346.         self.usage is replaced with the name of the current program
  1347.         (basename of sys.argv[0]).  Does nothing if self.usage is empty
  1348.         or not defined.
  1349.         """
  1350.         if self.usage:
  1351.             file.write(self.get_usage() + 'n')
  1352.     def get_version(self):
  1353.         if self.version:
  1354.             return self.expand_prog_name(self.version)
  1355.         else:
  1356.             return ""
  1357.     def print_version(self, file=None):
  1358.         """print_version(file : file = stdout)
  1359.         Print the version message for this program (self.version) to
  1360.         'file' (default stdout).  As with print_usage(), any occurence
  1361.         of "%prog" in self.version is replaced by the current program's
  1362.         name.  Does nothing if self.version is empty or undefined.
  1363.         """
  1364.         if self.version:
  1365.             file.write(self.get_version() + 'n')
  1366.     def format_option_help(self, formatter=None):
  1367.         if formatter is None:
  1368.             formatter = self.formatter
  1369.         formatter.store_option_strings(self)
  1370.         result = []
  1371.         result.append(formatter.format_heading(_("Options")))
  1372.         formatter.indent()
  1373.         if self.option_list:
  1374.             result.append(OptionContainer.format_option_help(self, formatter))
  1375.             result.append("n")
  1376.         for group in self.option_groups:
  1377.             result.append(group.format_help(formatter))
  1378.             result.append("n")
  1379.         formatter.dedent()
  1380.         # Drop the last "n", or the header if no options or option groups:
  1381.         return string.join(result[:-1], "")
  1382.     def format_epilog(self, formatter):
  1383.         return formatter.format_epilog(self.epilog)
  1384.     def format_help(self, formatter=None):
  1385.         if formatter is None:
  1386.             formatter = self.formatter
  1387.         result = []
  1388.         if self.usage:
  1389.             result.append(self.get_usage() + "n")
  1390.         if self.description:
  1391.             result.append(self.format_description(formatter) + "n")
  1392.         result.append(self.format_option_help(formatter))
  1393.         result.append(self.format_epilog(formatter))
  1394.         return string.join(result, "")
  1395.     # used by test suite
  1396.     def _get_encoding(self, file):
  1397.         encoding = getattr(file, "encoding", None)
  1398.         if not encoding:
  1399.             encoding = sys.getdefaultencoding()
  1400.         return encoding
  1401.     def print_help(self, file=None):
  1402.         """print_help(file : file = stdout)
  1403.         Print an extended help message, listing all options and any
  1404.         help text provided with them, to 'file' (default stdout).
  1405.         """
  1406.         if file is None:
  1407.             file = sys.stdout
  1408.         encoding = self._get_encoding(file)
  1409.         file.write(encode_wrapper(self.format_help(), encoding, "replace"))
  1410. # class OptionParser
  1411. def _match_abbrev(s, wordmap):
  1412.     """_match_abbrev(s : string, wordmap : {string : Option}) -> string
  1413.     Return the string key in 'wordmap' for which 's' is an unambiguous
  1414.     abbreviation.  If 's' is found to be ambiguous or doesn't match any of
  1415.     'words', raise BadOptionError.
  1416.     """
  1417.     # Is there an exact match?
  1418.     if wordmap.has_key(s):
  1419.         return s
  1420.     else:
  1421.         # Isolate all words with s as a prefix.
  1422.         possibilities = filter(lambda w, s=s: w[:len(s)] == s, wordmap.keys())
  1423.         # No exact match, so there had better be just one possibility.
  1424.         if len(possibilities) == 1:
  1425.             return possibilities[0]
  1426.         elif not possibilities:
  1427.             raise BadOptionError(s)
  1428.         else:
  1429.             # More than one possible completion: ambiguous prefix.
  1430.             possibilities.sort()
  1431.             raise AmbiguousOptionError(s, possibilities)
  1432. # Some day, there might be many Option classes.  As of Optik 1.3, the
  1433. # preferred way to instantiate Options is indirectly, via make_option(),
  1434. # which will become a factory function when there are many Option
  1435. # classes.
  1436. make_option = Option