Yf @ s d Z d Z d d d d d d d d d
d d d
d d d d g Z d Z d d l Z d d l Z d d l Z d d Z y d d l m Z m Z Wn* e
k
r d d Z d d Z Yn Xe Z Gd d
d
e Z
Gd d d e
Z Gd d d e Z Gd d d e
Z Gd d d e
Z Gd! d" d" e Z Gd# d
d
Z Gd$ d d e Z Gd% d d e Z d& d' Z d( d) Z d* e e d+ f d, e e d+ f d- e e d. f d/ e e d/ f i Z d0 d1 Z d2 d3 Z d4 d5 f Z Gd6 d d Z d7 d8 Z d7 d9 Z Gd: d d Z! Gd; d d Z" Gd< d d e" Z# Gd= d d e" Z$ d> d? Z% e Z& d S)@a A powerful, extensible, and easy-to-use option parser.
By Greg Ward
Originally distributed as Optik.
For support, use the optik-users@lists.sourceforge.net mailing list
(http://lists.sourceforge.net/lists/listinfo/optik-users).
Simple usage example:
from optparse import OptionParser
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
action="store_false", dest="verbose", default=True,
help="don't print status messages to stdout")
(options, args) = parser.parse_args()
z1.5.3Option make_option
SUPPRESS_HELPSUPPRESS_USAGEValuesOptionContainer OptionGroup OptionParser
HelpFormatterIndentedHelpFormatterTitledHelpFormatter
OptParseError OptionErrorOptionConflictErrorOptionValueErrorBadOptionErrora"
Copyright (c) 2001-2006 Gregory P. Ward. All rights reserved.
Copyright (c) 2002-2006 Python Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the author nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Nc C s d | j j t | | f S)Nz<%s at 0x%x: %s>) __class____name__id)self r -/opt/alt/python35/lib64/python3.5/optparse.py_reprN s r )gettextngettextc C s | S)Nr )messager r r r [ s r c C s | d k r | S| S)N r )ZsingularZpluralnr r r r ^ s r c @ s( e Z d Z d d Z d d Z d S)r c C s
| | _ d S)N)msg)r r r r r __init__g s zOptParseError.__init__c C s | j S)N)r )r r r r __str__j s zOptParseError.__str__N)r
__module__ __qualname__r r r r r r r f s c @ s. e Z d Z d Z d d Z d d Z d S)r
z]
Raised if an Option instance is created with invalid or
inconsistent arguments.
c C s | | _ t | | _ d S)N)r str option_id)r r optionr r r r t s zOptionError.__init__c C s( | j r d | j | j f S| j Sd S)Nz
option %s: %s)r$ r )r r r r r x s zOptionError.__str__N)r r! r" __doc__r r r r r r r
n s c @ s e Z d Z d Z d S)r zE
Raised if conflicting options are added to an OptionParser.
N)r r! r" r& r r r r r ~ s c @ s e Z d Z d Z d S)r zS
Raised if an invalid option value is encountered on the command
line.
N)r r! r" r& r r r r r s c @ s. e Z d Z d Z d d Z d d Z d S)r zB
Raised if an invalid option is seen on the command line.
c C s
| | _ d S)N)opt_str)r r' r r r r s zBadOptionError.__init__c C s t d | j S)Nzno such option: %s)_r' )r r r r r s zBadOptionError.__str__N)r r! r" r& r r r r r r r s c @ s. e Z d Z d Z d d Z d d Z d S)AmbiguousOptionErrorzD
Raised if an ambiguous option is seen on the command line.
c C s t j | | | | _ d S)N)r r
possibilities)r r' r* r r r r s z AmbiguousOptionError.__init__c C s# t d | j d j | j f S)Nzambiguous option: %s (%s?)z, )r( r' joinr* )r r r r r s z AmbiguousOptionError.__str__N)r r! r" r& r r r r r r r) s r) c @ s e Z d Z d Z d Z d d Z d d Z d d Z d d
Z d d Z d
d Z
d d Z d d Z d d Z
d d Z d d Z d d Z d d Z d d Z d d Z d! S)"r a
Abstract base class for formatting option help. OptionParser
instances should use one of the HelpFormatter subclasses for
formatting help; by default IndentedHelpFormatter is used.
Instance attributes:
parser : OptionParser
the controlling OptionParser instance
indent_increment : int
the number of columns to indent per nesting level
max_help_position : int
the maximum starting column for option help text
help_position : int
the calculated starting column for option help text;
initially the same as the maximum
width : int
total number of columns for output (pass None to constructor for
this value to be taken from the $COLUMNS environment variable)
level : int
current indentation level
current_indent : int
current indentation level (in columns)
help_width : int
number of columns available for option help text (calculated)
default_tag : str
text to replace with each option's default value, "%default"
by default. Set to false value to disable default value expansion.
option_strings : { Option : str }
maps Option instances to the snippet of help text explaining
the syntax of that option, e.g. "-h, --help" or
"-fFILE, --file=FILE"
_short_opt_fmt : str
format string controlling how short options with values are
printed in help text. Must be either "%s%s" ("-fFILE") or
"%s %s" ("-f FILE"), because those are the two syntaxes that
Optik supports.
_long_opt_fmt : str
similar but for long options; must be either "%s %s" ("--file FILE")
or "%s=%s" ("--file=FILE").
Znonec C s d | _ | | _ | d k r` y t t j d } Wn t t f k
rU d } Yn X| d 8} | | _ t | t | d | d | _
| _ d | _ d | _
d | _ | | _ d | _ i | _ d | _ d | _ d S) NZCOLUMNSP r z%defaultz%s %sz%s=%s)parserindent_incrementintosenvironKeyError
ValueErrorwidthminmax
help_positionmax_help_positioncurrent_indentlevel
help_width short_first default_tagoption_strings_short_opt_fmt
_long_opt_fmt)r r0 r: r6 r> r r r r s$
* zHelpFormatter.__init__c C s
| | _ d S)N)r/ )r r/ r r r
set_parser s zHelpFormatter.set_parserc C s1 | d k r t d | d | d | _ d S)N z/invalid metavar delimiter for short options: %rz%s)rD rE )r5 rA )r delimr r r set_short_opt_delimiter s
z%HelpFormatter.set_short_opt_delimiterc C s1 | d k r t d | d | d | _ d S)N=rE z.invalid metavar delimiter for long options: %rz%s)rH rE )r5 rB )r rF r r r set_long_opt_delimiter s
z$HelpFormatter.set_long_opt_delimiterc C s% | j | j 7_ | j d 7_ d S)Nr )r; r0 r< )r r r r indent s zHelpFormatter.indentc C s@ | j | j 8_ | j d k s- t d | j d 8_ d S)Nr zIndent decreased below 0.r )r; r0 AssertionErrorr< )r r r r dedent s zHelpFormatter.dedentc C s t d d S)Nzsubclasses must implement)NotImplementedError)r usager r r format_usage s zHelpFormatter.format_usagec C s t d d S)Nzsubclasses must implement)rM )r headingr r r format_heading s z HelpFormatter.format_headingc C sB t | j | j d } d | j } t j | | d | d | S)z
Format a paragraph of free-form text for inclusion in the
help output at the current indentation level.
rE Zinitial_indentZsubsequent_indent)r8 r6 r; textwrapZfill)r textZ
text_widthrJ r r r _format_text s
zHelpFormatter._format_textc C s | r | j | d Sd Sd S)N
rD )rU )r descriptionr r r format_description s z HelpFormatter.format_descriptionc C s# | r d | j | d Sd Sd S)NrV rD )rU )r epilogr r r
format_epilog s zHelpFormatter.format_epilogc C su | j d k s | j r | j S| j j j | j } | t k sP | d k rY | j } | j j | j t | S)N)
r/ r? helpdefaultsgetdest
NO_DEFAULTNO_DEFAULT_VALUEreplacer# )r r% Z
default_valuer r r expand_default s z HelpFormatter.expand_defaultc s) g } j | } j j d } t | | k r[ d j d | f } j } n d j d | | f } d } | j | | j r j | } t j | j } | j d | d | d f | j
f d d | d d D n | d
d k r | j d d j | S) Nr- z%*s%s
rD z %*s%-*s r c s& g | ] } d j d | f q S)z%*s%s
rD )r9 ).0line)r r r
D s z/HelpFormatter.format_option..r rV ) r@ r9 r; lenappendr[ rb rS Zwrapr= extendr+ )r r% resultoptsZ opt_widthZ indent_firstZ help_textZ
help_linesr )r r
format_option' s$
zHelpFormatter.format_optionc C s | j d } xI | j D]> } | j | } | | j | } | j | } | | j | .c s# g | ] } j | f q Sr )rB )rc Zlopt)rs r r r re b s z, ) takes_valuers r^ upper _short_opts
_long_optsr> r+ )r r% Z
short_optsZ long_optsrk r )rs r r rn \ s
z#HelpFormatter.format_option_stringsN)r r! r" r& r` r rC rG rI rJ rL rO rQ rU rX rZ rb rl rr rn r r r r r s" )
# c @ sF e Z d Z d Z d d d d d d Z d d Z d
d Z d S) r
z.Format help with indented section bodies.
r- Nr c C s t j | | | | | d S)N)r r )r r0 r: r6 r> r r r r s s z IndentedHelpFormatter.__init__c C s t d | S)Nz
Usage: %s
)r( )r rN r r r rO { s z"IndentedHelpFormatter.format_usagec C s d | j d | f S)Nz%*s%s:
rD )r; )r rP r r r rQ ~ s z$IndentedHelpFormatter.format_heading)r r! r" r& r rO rQ r r r r r
o s c @ sF e Z d Z d Z d d d d d d Z d d Z d d
Z d S) r z1Format help with underlined section headers.
r rx Nc C s t j | | | | | d S)N)r r )r r0 r: r6 r> r r r r s z TitledHelpFormatter.__init__c C s d | j t d | f S)Nz%s %s
ZUsage)rQ r( )r rN r r r rO s z TitledHelpFormatter.format_usagec C s d | d | j t | f S)Nz%s
%s
z=-)r< rg )r rP r r r rQ s z"TitledHelpFormatter.format_heading)r r! r" r& r rO rQ r r r r r s c C s | d d j d k r% d } n` | d d j d k r` d } | d d pZ d } n% | d d d k r d } n d } | | | S) Nr- Z0x Z0b0r
)lower)valtyperadixr r r
_parse_num s r c C s
t | t S)N)r r1 )r~ r r r
_parse_int s r r1 Zintegerlongfloatzfloating-pointcomplexc C sY t | j \ } } y | | SWn1 t k
rT t t d | | | f Yn Xd S)Nz option %s: invalid %s value: %r) _builtin_cvtr r5 r r( )r% rp valueZcvtZwhatr r r
check_builtin s
r c C sQ | | j k r | Sd j t t | j } t t d | | | f d S)Nz, z.option %s: invalid choice: %r (choose from %s))choicesr+ mapreprr r( )r% rp r r r r r check_choice s r ZNOZDEFAULTc @ s e Z d Z d Z d d d d d d d d d
d d d
g Z dA Z dB Z dC Z dD Z dE Z dF Z
d e d e d e d e d e i Z
d Z d d Z d d Z d! d" Z d# d$ Z d% d& Z d' d( Z d) d* Z d+ d, Z d- d. Z d/ d0 Z d1 d2 Z e e e e e e e g Z d3 d4 Z e Z d5 d6 Z d7 d8 Z d9 d: Z d; d< Z d= d> Z! d? d@ Z" d S)Gr ar
Instance attributes:
_short_opts : [string]
_long_opts : [string]
action : string
type : string
dest : string
default : any
nargs : int
const : any
choices : [string]
callback : function
callback_args : (any*)
callback_kwargs : { string : any }
help : string
metavar : string
actionr r^ defaultnargsconstr callback
callback_argscallback_kwargsr[ rs store store_const
store_true store_falserh append_constcountversionstringr1 r r r choiceNc O s] g | _ g | _ | j | } | j | | j | x | j D] } | | qE Wd S)N)rv rw _check_opt_strings_set_opt_strings
_set_attrs
CHECK_METHODS)r rk attrscheckerr r r r 3 s
zOption.__init__c C s) d d | D } | s% t d | S)Nc S s g | ] } | r | q Sr r )rc rp r r r re J s z-Option._check_opt_strings..z+at least one option string must be supplied) TypeError)r rk r r r r F s zOption._check_opt_stringsc C s x | D] } t | d k r5 t d | | q t | d k r | d d k od | d d k sz t d | | | j j | q | d d d k o | d d k s t d | | | j j | q Wd S) Nr- z>invalid option string %r: must be at least two characters longr -r zMinvalid short option string %r: must be of the form -x, (x any non-dash char)z--zGinvalid long option string %r: must start with --, followed by non-dash)rg r
rv rh rw )r rk rp r r r r O s$
& zOption._set_opt_stringsc C s xj | j D]_ } | | k r: t | | | | | | =q
| d k rY t | | t q
t | | d q
W| r t | j } t d d j | | d S)Nr z invalid keyword arguments: %sz, )ATTRSsetattrr_ sortedkeysr
r+ )r r attrr r r r d s
zOption._set_attrsc C sG | j d k r d | _ n( | j | j k rC t d | j | d S)Nr zinvalid action: %r)r ACTIONSr
)r r r r
_check_actionw s zOption._check_actionc C s | j d k rH | j | j k r | j d k r< d | _ q d | _ n t | j t ri | j j | _ | j d k r d | _ | j | j k r t d | j | | j | j k r t d | j | d S)Nr r r# zinvalid option type: %rz$must not supply a type for action %r) r r ALWAYS_TYPED_ACTIONSr
isinstancer TYPESr
TYPED_ACTIONS)r r r r _check_type} s zOption._check_typec C s | j d k rz | j d k r0 t d | q t | j t t f s t d t t | j j d d | n% | j d k r t d | j | d S)Nr z/must supply a list of choices for type 'choice'z1choices must be a list of strings ('%s' supplied)'r z#must not supply choices for type %r)r r r
r tuplelistr# split)r r r r
_check_choice s ,zOption._check_choicec C s | j | j k p | j d k } | j d k r| | r| | j rh | j d d d j d d | _ n | j d d | _ d S)Nr r- r r( r )r
STORE_ACTIONSr r^ rw ra rv )r rt r r r _check_dest s )zOption._check_destc C s; | j | j k r7 | j d k r7 t d | j | d S)Nz*'const' must not be supplied for action %r)r
CONST_ACTIONSr r
)r r r r _check_const s !
zOption._check_constc C sV | j | j k r- | j d k rR d | _ n% | j d k rR t d | j | d S)Nr z*'nargs' must not be supplied for action %r)r r r r
)r r r r _check_nargs s
zOption._check_nargsc C s | j d k r t | j s4 t d | j | | j d k rl t | j t rl t d | j | | j d k rt | j t rt d | j | na | j d k r t d | j | | j d k r t d | | j d k rt d | d S)Nr zcallback not callable: %rz3callback_args, if supplied, must be a tuple: not %rz4callback_kwargs, if supplied, must be a dict: not %rz.callback supplied (%r) for non-callback optionz.callback_args supplied for non-callback optionz0callback_kwargs supplied for non-callback option) r callabler r
r r r r dict)r r r r _check_callback s0 zOption._check_callbackc C s d j | j | j S)N/)r+ rv rw )r r r r r s zOption.__str__c C s
| j d k S)N)r )r r r r rt s zOption.takes_valuec C s# | j r | j d S| j d Sd S)Nr )rw rv )r r r r get_opt_string s zOption.get_opt_stringc C s9 | j j | j } | d k r% | S| | | | Sd S)N) TYPE_CHECKERr] r )r rp r r r r r check_value s zOption.check_valuec sO | d k rK j d k r+ j | St f d d | D Sd S)Nr c s" g | ] } j | q Sr )r )rc v)rp r r r re s z(Option.convert_value..)r r r )r rp r r )rp r r
convert_value s zOption.convert_valuec C s4 | j | | } | j | j | j | | | | S)N)r take_actionr r^ )r rp r valuesr/ r r r process s zOption.processc C s | d k r t | | | n| d k rA t | | | j nb| d k r` t | | d nC| d k r t | | d n$| d k r | j | g j | n | d k r | j | g j | j n | d k rt | | | j | d
d n | d k rJ| j pf } | j p(i } | j | | | | | | nY | d
k rm| j | j n6 | d k r| j | j n t
d | j d S)Nr r r Tr Frh r r r r r r[ r zunknown action %r) r r ensure_valuerh r r r
print_helpexit
print_versionr5 r ) r r r^ rp r r r/ argskwargsr r r r s4 #
zOption.take_action)
r r r r rh r r r r[ r )r r r r rh r r )r rh r )r rh )r r )r r1 r r r r )#r r! r" r& r r r r r r r r r r r r r r r r r r r r r r r r __repr__rt r r r r r r r r r r s
ZSUPPRESSZHELPZUSAGEc @ s e Z d Z d d d Z d d Z e Z d d Z d d Z d
d Z d d
Z
d d d Z d d d Z d d Z
d S)r Nc C s7 | r3 x* | j D] \ } } t | | | q Wd S)N)itemsr )r r\ r r~ r r r r 8 s zValues.__init__c C s
t | j S)N)r# __dict__)r r r r r = s zValues.__str__c C sC t | t r | j | j k St | t r; | j | k St Sd S)N)r r r r NotImplemented)r otherr r r __eq__B s
z
Values.__eq__c C sM xF t | D]8 } | | k r
| | } | d k r
t | | | q
Wd S)z
Update the option values from an arbitrary dictionary, but only
use keys from dict that already have a corresponding attribute
in self. Any keys in dict without a corresponding attribute
are silently ignored.
N)dirr )r r r Zdvalr r r _update_carefulJ s
zValues._update_carefulc C s | j j | d S)z
Update the option values from an arbitrary dictionary,
using all keys from the dictionary regardless of whether
they have a corresponding attribute in self or not.
N)r update)r r r r r
_update_looseW s zValues._update_loosec C sL | d k r | j | n, | d k r8 | j | n t d | d S)NcarefulZloosezinvalid update mode: %r)r r r5 )r r moder r r _update_ s
zValues._updater c C s1 t | t j | } | j t | | d S)N)
__import__sysmodulesr vars)r modnamer modr r r read_moduleg s
zValues.read_modulec C s3 i } t t | j | | j | | d S)N)execopenreadr )r filenamer r r r r read_filel s zValues.read_filec C sB t | | s% t | | d k r5 t | | | t | | S)N)hasattrgetattrr )r r r r r r r q s %zValues.ensure_value)r r! r" r r r r r r r r r r r r r r r r 6 s
c @ s e Z d Z d Z d d Z d d Z d d Z d d Z d
d Z d d
Z d d Z
d d Z d d Z d d Z
d d Z d d Z d d Z d d Z d d Z d d! Z d" S)#r a
Abstract base class.
Class attributes:
standard_option_list : [Option]
list of standard options that will be accepted by all instances
of this parser class (intended to be overridden by subclasses).
Instance attributes:
option_list : [Option]
the list of Option objects contained by this OptionContainer
_short_opt : { string : Option }
dictionary mapping short option strings, eg. "-f" or "-X",
to the Option instances that implement them. If an Option
has multiple short option strings, it will appear in this
dictionary multiple times. [1]
_long_opt : { string : Option }
dictionary mapping long option strings, eg. "--file" or
"--exclude", to the Option instances that implement them.
Again, a given Option can occur multiple times in this
dictionary. [1]
defaults : { string : any }
dictionary mapping option destination names to default
values for each destination [1]
[1] These mappings are common to (shared by) all components of the
controlling OptionParser, where they are initially created.
c C s1 | j | | _ | j | | j | d S)N)_create_option_list option_classset_conflict_handlerset_description)r r conflict_handlerrW r r r r s
zOptionContainer.__init__c C s i | _ i | _ i | _ d S)N)
_short_opt _long_optr\ )r r r r _create_option_mappings s z'OptionContainer._create_option_mappingsc C s( | j | _ | j | _ | j | _ d S)N)r r r\ )r r/ r r r _share_option_mappings s z&OptionContainer._share_option_mappingsc C s) | d k r t d | | | _ d S)Nerrorresolvez$invalid conflict_resolution value %r)r r )r5 r )r handlerr r r r s z$OptionContainer.set_conflict_handlerc C s
| | _ d S)N)rW )r rW r r r r s z OptionContainer.set_descriptionc C s | j S)N)rW )r r r r get_description s z OptionContainer.get_descriptionc C s | ` | ` | ` d S)zsee OptionParser.destroy().N)r r r\ )r r r r destroy s zOptionContainer.destroyc C sY g } x: | j D]/ } | | j k r | j | | j | f q Wx: | j D]/ } | | j k rM | j | | j | f qM W| rU| j } | d k r t d d j d d | D | n | d k rUx | D]w \ } } | j d r| j j | | j | =n | j j | | j | =| j p;| j s | j
j j | q Wd S)Nr z conflicting option string(s): %sz, c S s g | ] } | d q S)r r )rc cor r r re s z3OptionContainer._check_conflict..r z--) rv r rh rw r r r r+
startswithremove containerrm )r r% Z
conflict_optsrp r Zc_optionr r r _check_conflict s.
z OptionContainer._check_conflictc O s; t | d t r( | j | | } nQ t | d k rm | rm | d } t | t sy t d | n t d | j | | j j | | | _ x | j
D] } | | j | d? Z" d@ dA Z# d dB dC Z$ dD dE Z% d dF dG Z& d dH dI Z' dJ dK Z( d dL dM Z) d dN dO Z* d S)Pr a$
Class attributes:
standard_option_list : [Option]
list of standard options that will be accepted by all instances
of this parser class (intended to be overridden by subclasses).
Instance attributes:
usage : string
a usage string for your program. Before it is displayed
to the user, "%prog" will be expanded to the name of
your program (self.prog or os.path.basename(sys.argv[0])).
prog : string
the name of the current program (to override
os.path.basename(sys.argv[0])).
description : string
A paragraph of text giving a brief overview of your program.
optparse reformats this paragraph to fit the current terminal
width and prints it when the user requests help (after usage,
but before the list of options).
epilog : string
paragraph of help text to print after option help
option_groups : [OptionGroup]
list of option groups in this parser (option groups are
irrelevant for parsing the command-line, but very useful
for generating help)
allow_interspersed_args : bool = true
if true, positional arguments may be interspersed with options.
Assuming -a and -b each take a single argument, the command-line
-ablah foo bar -bboo baz
will be interpreted the same as
-ablah -bboo -- foo bar baz
If this flag were false, that command line would be interpreted as
-ablah -- foo bar -bboo baz
-- ie. we stop processing options as soon as we see the first
non-option argument. (This is the tradition followed by
Python's getopt module, Perl's Getopt::Std, and other argument-
parsing libraries, but it is generally annoying to users.)
process_default_values : bool = true
if true, option default values are processed similarly to option
values from the command line: that is, they are passed to the
type-checking function for the option's type (as long as the
default value is a string). (This really only matters if you
have defined custom types; see SF bug #955889.) Set it to false
to restore the behaviour of Optik 1.4.1 and earlier.
rargs : [string]
the argument list currently being parsed. Only set when
parse_args() is active, and continually trimmed down as
we consume arguments. Mainly there for the benefit of
callback options.
largs : [string]
the list of leftover arguments that we have skipped while
parsing options. If allow_interspersed_args is false, this
list is always empty.
values : Values
the set of option values currently being accumulated. Only
set when parse_args() is active. Also mainly for callbacks.
Because of the 'rargs', 'largs', and 'values' attributes,
OptionParser is not thread-safe. If, for some perverse reason, you
need to parse command-line arguments simultaneously in different
threads, use different OptionParser instances.
Nr Tc C s t j | | | | | j | | | _ | | _ d | _ d | _ | d k r\ t } | | _ | j j | |
| _
| j | d | | j d S)NTadd_help)
r r set_usageprogr allow_interspersed_argsprocess_default_valuesr
r rC rY _populate_option_list_init_parsing_state) r rN rm r r r rW r Zadd_help_optionr rY r r r r s
zOptionParser.__init__c C sA t j | x | j D] } | j q W| ` | ` | ` d S)a
Declare that you are done with this OptionParser. This cleans up
reference cycles so the OptionParser (and all objects referenced by
it) can be garbage-collected promptly. After calling destroy(), the
OptionParser is unusable.
N)r r ro rm r )r rq r r r r s
zOptionParser.destroyc C s g | _ g | _ | j d S)N)rm ro r )r r r r r s z OptionParser._create_option_listc C s& | j d d d d d t d d S)Nz-hz--helpr r[ z show this help message and exit)r r( )r r r r _add_help_option s z OptionParser._add_help_optionc C s# | j d d d d t d d S)Nz --versionr r r[ z&show program's version number and exit)r r( )r r r r _add_version_option s z OptionParser._add_version_optionc C sS | j r | j | j | r, | j | | j r? | j | rO | j d S)N)standard_option_listr r r
r )r rm r r r r r
s
z"OptionParser._populate_option_listc C s d | _ d | _ d | _ d S)N)rargslargsr )r r r r r s z OptionParser._init_parsing_statec C sn | d k r t d | _ nL | t k r6 d | _ n4 | j j d ra | d d | _ n | | _ d S)Nz%prog [options]zusage: )r( rN r r} r )r rN r r r r s zOptionParser.set_usagec C s
d | _ d S)a Set parsing to not stop on the first non-option, allowing
interspersing switches with command arguments. This is the
default behavior. See also disable_interspersed_args() and the
class documentation description of the attribute
allow_interspersed_args.TN)r )r r r r enable_interspersed_args s z%OptionParser.enable_interspersed_argsc C s
d | _ d S)zSet parsing to stop on the first non-option. Use this if
you have a command processor which runs another command that
has options of its own and you want to make sure these options
don't get confused.
FN)r )r r r r disable_interspersed_args s z&OptionParser.disable_interspersed_argsc C s
| | _ d S)N)r )r r r r r set_process_default_values
s z'OptionParser.set_process_default_valuesc C s | | j | t t f k
r } z | j t | WYd d } ~ Xn X| | } | j
| | S)aR
parse_args(args : [string] = sys.argv[1:],
values : Values = None)
-> (values : Values, args : [string])
Parse the command-line options found in 'args' (default:
sys.argv[1:]). Any errors result in a call to 'error()', which
by default prints the usage message to stderr and calls
sys.exit() with an error message. On success returns a pair
(values, args) where 'values' is a Values instance (with all
your option values) and 'args' is the list of arguments left
over after parsing options.
N) r r r r r
_process_argsr r r r# check_values)r r r r r stoperrr r r
parse_argsJ s
&
zOptionParser.parse_argsc C s
| | f S)a
check_values(values : Values, args : [string])
-> (values : Values, args : [string])
Check that the supplied option values and leftover arguments are
valid. Returns the option values and leftover arguments
(possibly adjusted, possibly completely new -- whatever you
like). Default implementation just returns the passed-in
values; subclasses may override as desired.
r )r r r r r r r q s zOptionParser.check_valuesc C s x | r | d } | d k r* | d =d S| d d d k rS | j | | q | d d d k r t | d k r | j | | q | j r | j | | d =q d Sq Wd S)a _process_args(largs : [string],
rargs : [string],
values : Values)
Process command-line arguments and populate 'values', consuming
options and arguments from 'rargs'. If 'allow_interspersed_args' is
false, stop at the first non-option argument. If true, accumulate any
interspersed non-option arguments in 'largs'.
r z--Nr- r r )_process_long_optrg _process_short_optsr rh )r r r r argr r r r ~ s
(
zOptionParser._process_argsc C s t | | j S)a _match_long_opt(opt : string) -> string
Determine which long option string 'opt' matches, ie. which one
it is an unambiguous abbreviation for. Raises BadOptionError if
'opt' doesn't unambiguously match any long option string.
)
_match_abbrevr )r rp r r r _match_long_opt s z OptionParser._match_long_optc
C sK | j d } d | k rL | j d d \ } } | j d | d } n | } d } | j | } | j | } | j r | j } t | | k r | j t d d | d | d | i q1| d k r | j d } q1t
| d | } | d | =n& | r+| j t d
| n d } | j | | | | d S) Nr rH r TFz.%(option)s option requires %(number)d argumentz/%(option)s option requires %(number)d argumentsr% numberz %s option does not take a value)
popr insertr' r rt r rg r r r r( r )
r r r r% rp Znext_argZhad_explicit_valuer% r r r r r r# s0
z OptionParser._process_long_optc C s^ | j d } d } d } x<| d d D]*} d | } | j j | } | d 7} | sj t | | j r3| t | k r | j d | | d d } | j } t | | k r | j t d d | d | d | i q9| d k r
| j d }
q9t
| d | }
| d | =n d }
| j | |
| | | r, Pq, Wd S)
Nr Fr r Tz.%(option)s option requires %(number)d argumentz/%(option)s option requires %(number)d argumentsr% r( ) r) r r] r rt rg r* r r r r r ) r r r r% r iZchrp r% r r r r r r$ s6
z OptionParser._process_short_optsc C s1 | j d k r& t j j t j d S| j Sd S)Nr )r r2 pathbasenamer r )r r r r
get_prog_name s zOptionParser.get_prog_namec C s | j d | j S)Nz%prog)ra r. )r sr r r expand_prog_name
s z OptionParser.expand_prog_namec C s | j | j S)N)r0 rW )r r r r r s z OptionParser.get_descriptionr c C s' | r t j j | t j | d S)N)r stderrwriter )r Zstatusr r r r r s zOptionParser.exitc C s4 | j t j | j d d | j | f d S)zerror(msg : string)
Print a usage message incorporating 'msg' to stderr and exit.
If you override this in a subclass, it should not return -- it
should either exit or raise an exception.
r- z%s: error: %s
N) print_usager r1 r r. )r r r r r r s zOptionParser.errorc C s- | j r% | j j | j | j Sd Sd S)NrD )rN r rO r0 )r r r r get_usage" s zOptionParser.get_usagec C s# | j r t | j d | d S)aa print_usage(file : file = stdout)
Print the usage message for the current program (self.usage) to
'file' (default stdout). Any occurrence of the string "%prog" in
self.usage is replaced with the name of the current program
(basename of sys.argv[0]). Does nothing if self.usage is empty
or not defined.
fileN)rN printr4 )r r5 r r r r3 ) s zOptionParser.print_usagec C s! | j r | j | j Sd Sd S)NrD )r r0 )r r r r get_version5 s zOptionParser.get_versionc C s# | j r t | j d | d S)aE print_version(file : file = stdout)
Print the version message for this program (self.version) to
'file' (default stdout). As with print_usage(), any occurrence
of "%prog" in self.version is replaced by the current program's
name. Does nothing if self.version is empty or undefined.
r5 N)r r6 r7 )r r5 r r r r ; s zOptionParser.print_versionc C s | d k r | j } | j | g } | j | j t d | j | j r} | j t j | | | j d x4 | j D]) } | j | j
| | j d q W| j d j | d d S)NZOptionsrV rD r rf )
r rr rh rQ r( rJ rm r r ro r rL r+ )r r rj rq r r r r F s
z OptionParser.format_option_helpc C s | j | j S)N)rZ rY )r r r r r rZ W s zOptionParser.format_epilogc C s | d k r | j } g } | j r; | j | j d | j r^ | j | j | d | j | j | | j | j | d j | S)NrV rD ) r rN rh r4 rW rX r rZ r+ )r r rj r r r r Z s zOptionParser.format_helpc C s, | d k r t j } | j | j d S)zprint_help(file : file = stdout)
Print an extended help message, listing all options and any
help text provided with them, to 'file' (default stdout).
N)r stdoutr2 r )r r5 r r r r f s zOptionParser.print_help)+r r! r" r& r r r r r r r
r
r r r r r r r r r r r r r" r r r' r# r$ r. r0 r r r r4 r3 r7 r r rZ r r r r r r r Q s` D
'
3 $ )
c s{ | k r S f d d | j D } t | d k rI | d S| s^ t n | j t | d S)z_match_abbrev(s : string, wordmap : {string : Option}) -> string
Return the string key in 'wordmap' for which 's' is an unambiguous
abbreviation. If 's' is found to be ambiguous or doesn't match any of
'words', raise BadOptionError.
c s% g | ] } | j r | q Sr )r )rc Zword)r/ r r re s z!_match_abbrev..r r N)r rg r sortr) )r/ Zwordmapr* r )r/ r r& s s
r& )'r& __version____all__Z
__copyright__r r2 rS r r r ImportErrorr( Exceptionr r
r r r r) r r
r r r r r r r r r_ r r r r r r r r& r r r r r sr
t
A $