֦i d Z dZg dZdZddlZddlZddlZd Z ddlmZm Z eZ G d
d e Z
G d d
e
Z G d de Z G d de
Z G d de
Z G d de Z G d d Z G d de Z G d de Zd Zd Ze e d fe e d fe e d fe e d fd!Zd" Zd# Z d$Z G d% d& Z d'Z d(Z G d) d* Z! G d+ d, Z" G d- d.e" Z# G d/ d0e" Z$d1 Z%e Z&y# e
$ r d Zd Z Y w xY w)2a 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.3)Option make_option
SUPPRESS_HELPSUPPRESS_USAGEValuesOptionContainer OptionGroup OptionParser
HelpFormatterIndentedHelpFormatterTitledHelpFormatter
OptParseError OptionErrorOptionConflictErrorOptionValueErrorBadOptionError check_choicea"
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 L d| j j t | | fz S )Nz<%s at 0x%x: %s>) __class____name__idselfs !/usr/lib64/python3.12/optparse.py_reprr O s" !8!8"T(D I II )gettextngettextc | S N )messages r r r \ s r c |dk( r| S |S N r! )singularpluralns r r r _ s 6O
r c e Zd Zd Zd Zy)r
c || _ y r msgr r, s r __init__zOptParseError.__init__h s r c | j S r r+ r s r __str__zOptParseError.__str__k s xxr N)r
__module__ __qualname__r. r0 r! r r r
r
g s r r
c e Zd ZdZd Zd Zy)r z]
Raised if an Option instance is created with invalid or
inconsistent arguments.
c 2 || _ t | | _ y r )r, str option_id)r r, options r r. zOptionError.__init__u s Vr c j | j r d| j d| j S | j S )Nzoption z: )r6 r, r s r r0 zOptionError.__str__y s% >>&*nndhh? ?88Or Nr r1 r2 __doc__r. r0 r! r r r r o s
% r r c e Zd ZdZy)r zE
Raised if conflicting options are added to an OptionParser.
Nr r1 r2 r: r! r r r r s r r c e Zd ZdZy)r zS
Raised if an invalid option value is encountered on the command
line.
Nr< r! r r r r s r r c e Zd ZdZd Zd Zy)r zB
Raised if an invalid option is seen on the command line.
c || _ y r )opt_strr r@ s r r. zBadOptionError.__init__ s r c 2 t d | j z S )Nzno such option: %s)_r@ r s r r0 zBadOptionError.__str__ s %& 55r Nr9 r! r r r r s 6r r c e Zd ZdZd Zd Zy)AmbiguousOptionErrorzD
Raised if an ambiguous option is seen on the command line.
c > t j | | || _ y r )r r.
possibilities)r r@ rG s r r. z AmbiguousOptionError.__init__ s g. *r c h t d | j dj | j fz S )Nzambiguous option: %s (%s?), )rC r@ joinrG r s r r0 z AmbiguousOptionError.__str__ s2 ./<<4+=+=!>?@ Ar Nr9 r! r r rE rE s +Ar rE c n e Zd ZdZdZd Zd Zd Zd Zd Z d Z
d Z d
Z d Z
d Zd
Zd Zd Zd Zd Zy)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").
nonec d d | _ || _ |" t t j d }|dz }|| _ t |t |dz
|dz x| _
| _ d| _ d| _
d | _ || _ d| _ i | _ d| _ d| _ y # t
t f$ r d}Y w xY w) NCOLUMNSP 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_fmtr rS r] rY ra s r r. zHelpFormatter.__init__ s
0 =
BJJy 12
QJE
%s52:7G!7K'LM NT 3
&% % $ j)
s B B/.B/c || _ y r )rR r rR s r
set_parserzHelpFormatter.set_parser s r c B |dvrt d|z d|z dz | _ y )N) z/invalid metavar delimiter for short options: %r%s)rX rd r delims r set_short_opt_delimiterz%HelpFormatter.set_short_opt_delimiter s2 ! AEIK
K "UlT 1r c B |dvrt d|z d|z dz | _ y )N)=rl z.invalid metavar delimiter for long options: %rrm )rX re rn s r set_long_opt_delimiterz$HelpFormatter.set_long_opt_delimiter s2
" @5HJ
J !E\D 0r c l | xj | j z
c_ | xj dz
c_ y r$ r^ rS r_ r s r indentzHelpFormatter.indent s& t 4 44
a
r c l | xj | j z c_ | xj dz c_ y r$ ru r s r dedentzHelpFormatter.dedent s& t 4 44
a
r c t d Nzsubclasses must implementNotImplementedErrorr usages r format_usagezHelpFormatter.format_usage !"=>>r c t d rz r{ r headings r format_headingz HelpFormatter.format_heading r r c t | j | j z
d }d| j z }t j |||| S )z
Format a paragraph of free-form text for inclusion in the
help output at the current indentation level.
rl )initial_indentsubsequent_indent)r[ rY r^ textwrapfill)r text
text_widthrv s r _format_textzHelpFormatter._format_text sK
d&9&992>
T(((}}T ',2/57 7r c 0 |r| j | dz S yN
rk r r descriptions r format_descriptionz HelpFormatter.format_description s $$[1D8 8r c 6 |rd| j | z dz S yr r )r epilogs r
format_epilogzHelpFormatter.format_epilog s# $++F33d: :r c 2 | j | j s |j S | j j j |j
}|t u s| | j }|j j | j t | S r )
rR rb helpdefaultsgetdest
NO_DEFAULTNO_DEFAULT_VALUEreplacer5 )r r7
default_values r expand_defaultz HelpFormatter.expand_default sv ;; d&6&6;; ,,00=
J &-*? 1 1M{{""4#3#3S 5GHHr c t g }| j | }| j | j z
dz
}t | |kD r d| j d|fz }| j }nd| j d||fz }d}|j | |j
r~| j
| }t j || j }|j d|d|d fz |j |dd D cg c] }d| j d|fz c} n|d dk7 r|j d dj | S c c}w ) NrP z%*s%s
rk z %*s%-*s r r% r ) rc r\ r^ lenappendr r r wrapr` extendrJ ) r r7 resultopts opt_width indent_first help_text
help_lineslines r
format_optionzHelpFormatter.format_option( s= ""6*&&)<)<>D --L $"5"5r9d!KKD L
d ;; ++F3I! y$//BJ MM)|RA &GG H MM'1!"~7'5t %(:(:B'EE'57
8
"X
MM$ wwv 7s *D5c | j d}|j D ]D }| j | }|| j |< t |t | | j z }F | j |j D ]U }|j D ]D }| j | }|| j |< t |t | | j z }F W | j | j t |dz | j | _ t | j | j z
d | _
y )Nr rP r )rv option_listformat_option_stringsrc r[ r r^
option_groupsrx rZ r] r\ rY r` )r rR max_lenoptstringsgroups r store_option_stringsz"HelpFormatter.store_option_stringsK s
%%C005G'.D $'3w<$2E2E#EFG &
))E (( 44S9+2##C( gs7|d6I6I'IJ ) *
1d.D.D E djj4+=+= =rBr c |j ry|j xs |j j }|j D cg c] }| j
||fz }}|j D cg c] }| j ||fz }}n|j }|j }| j r||z }n||z }dj | S c c}w c c}w )z@Return a comma-separated list of option strings & metavariables.rI )
takes_valuemetavarr upper _short_optsrd
_long_optsre ra rJ )r r7 r sopt
short_optslopt long_optsr s r r z#HelpFormatter.format_option_strings] s nn; (9(9(;G&,&8&8:&8d --w?&8
: &,%6%68%6T ++tWo=%6
8 ++J ))I )D z)Dyy :8s C
/CN)r r1 r2 r: r r. ri rp rs rv rx r r r r r r r r r r! r r r
r
s^ 'R %2 2 1
??
7 I! FC$ r r
c , e Zd ZdZ ddZd Zd Zy)r z.Format help with indented section bodies.
Nc 6 t j | |||| y r r
r. rf s r r. z IndentedHelpFormatter.__init__t
"$5uk Kr c t d |z S )Nz
Usage: %s
)rC r} s r r z"IndentedHelpFormatter.format_usage| s %''r c & d| j d|fz S )Nz%*s%s:
rk )r^ r s r r z$IndentedHelpFormatter.format_heading s T 0 0"g >>>r )rP Nr% r r1 r2 r: r. r r r! r r r r p s% #$#% K(?r r c , e Zd ZdZ ddZd Zd Zy)r z1Format help with underlined section headers.
Nc 6 t j | |||| y r r rf s r r. z TitledHelpFormatter.__init__ r r c B | j t d d|dS )NUsagez r )r rC r} s r r z TitledHelpFormatter.format_usage s ! 0 07 ?E7#
$% %r )NODEFAULTc e Zd ZdZg dZdZdZdZdZdZ dZ
e e e e e d Z
d
Zd Zd Zd
Zd Zd Zd Zd Zd Zd Zd Zd ZeeeeeeegZd ZeZ d Z d Z d Z d Z d Z!d Z"y
) r 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 r )
store store_const
store_true store_falser append_constcountr r version)r r r r r r r )r r r )r r )r r )stringrT r r r choice)rT r r r r Nc g | _ g | _ | j | }| j | | j | | j
D ]
} || y r )r r _check_opt_strings_set_opt_strings
_set_attrs
CHECK_METHODS)r r attrscheckers r r. zOption.__init__4 sX &&t, d#
))G DM *r c N |D cg c] }|s| }}|s t d |S c c}w )Nz+at least one option string must be supplied) TypeErrorr r r s r r zOption._check_opt_stringsG s3 $+tst+ IJ J ,s ""c R |D ] }t | dk rt d|z | t | dk( r;|d dk( r|d dk7 st d|z | | j j | i|dd dk( r|d dk7 st d|z | | j j | y ) NrP 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)--zGinvalid long option string %r: must start with --, followed by non-dash)r r r r r r s r r zOption._set_opt_stringsP s C3x!|!;=@ABFH H SQ A#
#a&C-%HJMN '',AaD(SVs]%CEHI &&s+% r c | j D ]> }||v rt | ||| ||= |dk( rt | |t 2t | |d @ |r7t |j }t ddj
| z | y )Nr z invalid keyword arguments: %srI )ATTRSsetattrr sortedkeysr rJ )r r attrs r r zOption._set_attrse s JJDu}dE$K0$K9$D$
3D$- 5::<(E /$))E2BB
r c | j d| _ y | j | j vrt d| j z | y )Nr zinvalid action: %r)r ACTIONSr r s r
_check_actionzOption._check_actionx s? ;; !DK
[[
, 2T[[ @$G G -r c | j 5| j | j v r | j d| _ y d| _ y y t | j t r| j j
| _ | j dk( rd| _ | j | j vrt d| j z | | j | j vrt d| j z | y )Nr r r5 zinvalid option type: %rz$must not supply a type for action %r) r r ALWAYS_TYPED_ACTIONSr
isinstancer TYPESr
TYPED_ACTIONSr s r _check_typezOption._check_type~ s 99 {{d 7 77<<+ (DI !)DI
8 $))T* II . . yyE! $ yy
*!";dii"GNN{{$"4"44!:T[[H$P P 5r c X | j dk( rv| j t d| t | j t t
f s=t dt
t | j j d d z | y | j t d| j z | y )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 tuplelistr5 splitr s r
_check_choicezOption._check_choice s 99 ||#!EtM M udm<!G$t||,-33C8;<=AC C = \\
% 5 A4I
I &r c
| j | j v xs | j d u}| j O|rL| j r(| j d dd j dd | _ y | j d d | _ y y y )Nr rP r
rC r% )r
STORE_ACTIONSr r r r r )r r s r _check_destzOption._check_dest s {{d&8&88 -yy, 99 OOA .qr 2 : :3 D , ,Q / 2 "- r c | j | j vr&| j t d| j z | y y )Nz*'const' must not be supplied for action %r)r
CONST_ACTIONSr r r s r _check_constzOption._check_const sB ;;d 0 0 0TZZ5K "B C z
!%%+D))/RF DMM$UF DT DV D v
KKM
y
" KKM 04;; >? ?r )#r r1 r2 r: r
r r" r r r% r r r r4 r r. r r r r r r r# r& r( r, r0 r __repr__r r2 r5 r8 r< r: r! r r r r s *
E G M!M &%M
DE$ !. - - - , L M
&,*&H P0 I
3 N8 # " !!$
&M< H%'-H
@ r r SUPPRESSHELP
SUPPRESSUSAGEc L e Zd Zd dZd ZeZd Zd Zd Z d Z
d dZ d d Z d
Z
y)
r Nc T |r&|j D ] \ }}t | || y y r )itemsr )r r r r s r r. zValues.__init__9 s+ '~~ / sdC( 0 r c , t | j S r )r5 __dict__r s r r0 zValues.__str__> s 4==!!r c t |t r| j |j k( S t |t r| j |k( S t S r )r r rK r+ NotImplemented)r others r __eq__z
Values.__eq__C s> eV $==ENN2 2
t
$==E) )! !r c X t | D ] }||v s|| }|t | || y)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 dvals r _update_carefulzValues._update_carefulK s4 IDt|Dz#D$- r c : | j j | y)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)rK update)r r+ s r
_update_loosezValues._update_looseX s
T"r c z |dk( r| j | y |dk( r| j | y t d|z )Ncarefulloosezinvalid update mode: %r)rS rV rX )r r+ modes r _updatezValues._update` s> 9 &
W_ t $ 6 => >r c v t | t j | }| j t | | y r )
__import__sysmodulesr[ vars)r modnamerZ mods r read_modulezValues.read_moduleh s* 7kk'" T#Y%r c r i }t t | j | | j || y r )execopenreadr[ )r filenamerZ r` s r read_filezValues.read_filem s, T(^
"D) T4 r c d t | | r t | |
t | || t | | S r )hasattrgetattrr )r r r s r r> zValues.ensure_valuer s1 tT"gdD&9&A D$ &tT""r r )rX )r r1 r2 r. r0 r rD rO rS rV r[ rc ri r> r! r r r r 7 s6 )
" H" .#?&
!
#r r c p e Zd ZdZd Zd Zd Zd Zd Zd Z d Z
d Z d
Z d Z
d Zd
Zd Zd Zd Zd Zy)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 v | j || _ | j | | j | y r )_create_option_list option_classset_conflict_handlerset_description)r rp conflict_handlerr s r r. zOptionContainer.__init__ s5
" ( !!"23 [)r c . i | _ i | _ i | _ y r
_short_opt _long_optr r s r _create_option_mappingsz'OptionContainer._create_option_mappings s
r c j |j | _ |j | _ |j | _ y r ru rh s r _share_option_mappingsz&OptionContainer._share_option_mappings s) !++ ))
r c 6 |dvrt d|z || _ y )N)errorresolvez$invalid conflict_resolution value %r)rX rs )r handlers r rq z$OptionContainer.set_conflict_handler s$ . . Cg MN N ' r c || _ y r r r s r rr z OptionContainer.set_description s
&r c | j S r r r s r get_descriptionz OptionContainer.get_description s r c | ` | `| `yzsee OptionParser.destroy().Nru r s r destroyzOptionContainer.destroy s O N Mr c
g }|j D ]1 }|| j v s|j || j | f 3 |j D ]1 }|| j v s|j || j | f 3 |r| j
}|dk( r/t
ddj |D cg c] }|d c} z | |dk( r|D ] \ }}|j d r)|j j | | j |= n(|j j | | j |= |j ru|j r|j j j | y y y c c}w )Nr| z conflicting option string(s): %srI r r} r ) r rv r r rw rs r rJ
startswithremove containerr )r r7
conflict_optsr r~ coc_options r _check_conflictz OptionContainer._check_conflict sh
%%Cdoo% $$c4??3+?%@A & $$Cdnn$ $$c4>>#+>%?@ % ++G'!)6ii ? 2A ?@A I%'4OS(~~d+ ++2237 NN3 / ,,33C8 OOC 0 $ 0 0H4G4G **66==hG (5 &
!@s + E8c t |d t r | j |i |}n>t | dk( r%|s#|d }t |t st d|z t d | j
| | j j | | |_ |j D ] }|| j |< |j D ] }|| j |< |j h|j t ur%|j | j" |j < |S |j | j" vrd| j" |j < |S )zOadd_option(Option)
add_option(opt_str, ..., kwarg=val, ...)
r r% znot an Option instance: %rinvalid argumentsN)r r5 rp r r r r r r r r rv r rw r r r r )r rB rC r7 r s r
add_optionzOptionContainer.add_option s* d1gs #&T&&77F
Y!^F!WF ff- || j v xs || j v S r )rv rw rA s r
has_optionzOptionContainer.has_option s$ 4??* *4>>) +r c V | j j | }|| j j | }|t d|z |j D ] }| j |= |j
D ] }| j |= |j j j | y )Nzno such option %r) rv r rw rX r r r r r )r r@ r7 r s r
remove_optionz OptionContainer.remove_option s $$W- >^^''0F > 07 :; ;%%C$ &$$Cs# %$$++F3r c | j syg }| j D ]5 }|j t us|j |j | 7 dj | S Nrk )r r r r r rJ )r formatterr r7 s r format_option_helpz"OptionContainer.format_option_help sV &&F;;-/
i 5 5f => ' wwv r c @ |j | j S r )r r r r s r r z"OptionContainer.format_description( s ++D,@,@,BCCr c g }| j r |j | j | | j r |j | j | dj | S )Nr )r r r r r rJ r r r s r format_helpzOptionContainer.format_help+ sV MM$11)< = MM$11)< =yy r N)r r1 r2 r: r. rx rz rq rr r r r r r r r r r r r r! r r r r x sY < *((
' H6 <$ -+ 4 D!r r c , e Zd ZddZd Zd Zd Zd Zy)r Nc x || _ t j | |j |j | || _ y r )rR r r. rp rs title)r rR r r s r r. zOptionGroup.__init__6 s4 &%%v'>'> M
r c H g | _ | j | j y r )r rz rR r s r ro z OptionGroup._create_option_list< s ##DKK0r c || _ y r )r )r r s r set_titlezOptionGroup.set_title@ s
r c 2 t j | | `yr )r r r r s r r zOptionGroup.destroyC s % r c |j | j }|j |t j | | z
}|j |S r )r r rv r r rx r s r r zOptionGroup.format_helpJ sJ ))$**5/--dI>>
r r )r r1 r2 r. ro r r r r! r r r r 4 s 1 r r c
e Zd ZdZg Zddedddddddf
dZd Zd Zd Z d Z
d*d
Z d Z d Z
d
Zd Zd Zd Zd Zd Zd Zd Zd Zd Zd+dZd Zd Zd Zd Z d Z d Z d Z d Z d,d Z!d! Z"d" Z#d-d#Z$d$ Z%d-d%Z&d-d&Z'd' Z(d-d(Z)d-d)Z*y).r 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 > t j | ||| | j | | | _ || _ d| _ d| _ |
t }|| _ | j j | |
| _
| j || | j y )NT)add_help)
r r. set_usageprogr allow_interspersed_argsprocess_default_valuesr r ri r _populate_option_list_init_parsing_state) r r~ r rp r rs r r add_help_optionr r s r r. zOptionParser.__init__ s , 0+ ? u '+$&*# -/I" !!$'
"";,; # =
"r c | t j | | j D ] }|j | `| `| `y)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 r r r )r r s r r zOptionParser.destroy s< %''E MMO ( Nr c @ g | _ g | _ | j y r )r r rx r s r ro z OptionParser._create_option_list s $$&r c @ | j dddt d y )Nz-hz--helpr z show this help message and exitr r r rC r s r _add_help_optionz OptionParser._add_help_option s$ h % @ A Cr c > | j ddt d y )Nz --versionr z&show program's version number and exitr r r s r _add_version_optionz OptionParser._add_version_option s" ( G H Jr c | j r| j | j |r| j | | j r| j |r| j y y r )standard_option_listr r r r )r r r s r r z"OptionParser._populate_option_list sW $ $ T 6 6 7 [ ) << $ $ & ! ! # r c . d | _ d | _ d | _ y r )rargslargsr; r s r r z OptionParser._init_parsing_state s
r c |t d | _ y |t u rd | _ y |j j d r |dd | _ y || _ y )Nz%prog [options]zusage: )rC r~ r r r r} s r r zOptionParser.set_usage sK =,-DJ
n
$ DJ
[[]
%
%i
0 qrDJ DJr c d| _ y)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.TNr r s r enable_interspersed_argsz%OptionParser.enable_interspersed_args s (,$r c d| _ y)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.
FNr r s r disable_interspersed_argsz&OptionParser.disable_interspersed_args s (-$r c || _ y r )r )r r< s r set_process_default_valuesz'OptionParser.set_process_default_values s
&-#r c " || j |< y r )r )r r r s r set_defaultzOptionParser.set_default s #
dr c : | j j | y r )r rU )r rC s r set_defaultszOptionParser.set_defaults s
V$r c | | j d d }| j D ] }|j |j |S r )r r r )r optionsr s r _get_all_optionsz OptionParser._get_all_options s9 ""1%''E NN5,, - (r c n | j st | j S | j j }| j D ]] }|j |j }t |t s/|j }|j || ||j < _ t | S r ) r r r copyr r r r r5 r2 r5 )r r r7 r r@ s r get_default_valuesz OptionParser.get_default_values s **$--( (==%%'++-F ll6;;/G'3' //1(.(:(:7G(L% . h r c 0 t |d t rt | g|i |}nWt | dk( r>|s<|d }t |t st d|z |j
| urt
d t d | j j | |S )Nr r% z not an OptionGroup instance: %rz"invalid OptionGroup (wrong parser)r ) r r5 r r r rR rX r r )r rB rC r s r add_option_groupz OptionParser.add_option_group+ s d1gs # 6t6v6E
Y!^FGE e[1 AE IJJ||4' !EFF /0 0 !!%( r c | j j | xs | j j | }|r|j | ur |j S y r )rv r rw r )r r@ r7 s r get_option_groupz OptionParser.get_option_group; sO //%%g. ...$$W- f&&d2## #r c 6 |t j dd S |d d S r$ )r^ argv)r rB s r _get_argszOptionParser._get_argsE s <88AB< 7Nr c 8 | j | }|| j }|| _ g x| _ }|| _ | j ||| }||z }| j || S # t t f$ r$}| j t | Y d}~Ed}~ww xY w)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| r5 check_values)r rB r; r r stoperrs r
parse_argszOptionParser.parse_argsK s t$ >,,.F
U !%%eUF;D u} .. 01 ! JJs3x !s A& &B5BBc
||fS )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; rB s r r zOptionParser.check_valuesr s ~ r c |rx|d }|dk( r|d= y|dd dk( r| j || nK|dd dk( r!t | dkD r| j || n"| j r|j | |d= ny|rwyy)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 r NrP r% r
)_process_long_optr _process_short_optsr r )r r r r; args r r zOptionParser._process_args s (C d{!HQqT!&&uf5RaC CHqL ((7-- S!!H' r c . 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_abbrevrw )r r s r _match_long_optz OptionParser._match_long_opt s S$..11r c & |j d }d|v r*|j dd \ }}|j d| d}n|}d}| j | }| j | }|j rh|j }t | |k r#| j t dd| ||dz nM|dk( r|j d } n6t |d| } |d|= n"|r | j t d |z nd } |j | || y )
Nr rr r% TF.%(option)s option requires %(number)d argument/%(option)s option requires %(number)d argumentsr7 numberz %s option does not take a value)
popr insertr rw r r r r| r r rC r< )
r r r; r r next_arghad_explicit_valuer7 r r s
r r z OptionParser._process_long_opt s iil #: !iiQ /OS( LLH %!% C!& ""3' $ LLE5zE!
8DE ),u = > ? ! ! eAen-!E'N
JJq:;cA B EsE640r c |j d }d}d}|dd D ] }d|z }| j j | }|dz
}|s t | |j r|t | k r|j
d||d d}|j } t | | k r#| j t dd| || dz n-| dk( r|j d }
nt |d| }
|d| = nd }
|j |
|| |s y y ) Nr Fr% r
Tr r r ) r rv r r r r r r r| r r r< ) r r r; r r ichr r7 r r s r r z OptionParser._process_short_opts s" iil
ab'B(C__((-F
FA$S))!!# s3x<LLCG, D u:%JJxHI -05!A B C aZ !IIaLE !%%. 1E ag NN3vt 4A r c | j 0t j j t j
d S | j S r1 )r rU pathbasenamer^ r r s r
get_prog_namezOptionParser.get_prog_name s3 99 77##CHHQK0 099 r c B |j d| j S )Nz%prog)r r )r ss r expand_prog_namez OptionParser.expand_prog_name s yy$"4"4"677r c 8 | j | j S r )r r r s r r z OptionParser.get_description s $$T%5%566r c p |r t j j | t j | y r )r^ stderrwriter@ )r statusr, s r r@ zOptionParser.exit s# JJ S ! r c | j t j | j d| j d|d y)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.
rP z : error: r N) print_usager^ r r@ r r- s r r| zOptionParser.error s2
$ !$*<*<*>DEr c | j r4| j j | j | j S yr )r~ r r r r s r get_usagezOptionParser.get_usage# s7 ::>>..%%djj13
3 r c T | j r t | j | yy)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)r~ printr r r s r r zOptionParser.print_usage* s! :: $.." . r c R | j r| j | j S yr )r r r s r get_versionzOptionParser.get_version6 s! <<(( 6 6r c T | j r t | j | yy)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.
r N)r r r r s r rA zOptionParser.print_version< s# << $""$4 0 r c | | j }|j | g }|j |j t d |j | j r6|j t j | | |j d | j D ]3 }|j |j | |j d 5 |j dj |d d S )NOptionsr rk r )
r r r r rC rv r r r r r rx rJ )r r r r s r r z OptionParser.format_option_helpG s I&&t,
i..q|<= MM/< 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.
r% r )r r r r sortrE )r wordmapwordrG s r r r t s G| +2,,. 0.$ OOA . .
0 } " # # # #
&q-8 80s A1)'r: __version____all__
__copyright__r^ rU r r r r ImportErrorrC Exceptionr
r r r r rE r
r r r r r r r r r r r r r r r r r r r r! r r r sy . $
@ J ) Y = ;
6m 6
AN
AM M ^?] ?&G= G& %a l3%q|4 !1%5#67 %q| 47
G%
n nf "
#># >#By! y!x? <]'O ]'D9: m1 s C: : DD