B
YN^ @ s d Z dZdddddddd d
d d d
dddddgZddlZddlZddlZddl m Z
m Z dZ dZ
dZdZdZdZd ZG d d d eZd d ZG d!d deZG d"d deZG d#d d eZG d$d deZG d%d
d
eZd&d' ZG d(d de Z G d)d de Z G d*d d eZ G d+d, d,e Z G d-d. d.e Z!G d/d0 d0e!Z"G d1d2 d2e!Z#G d3d4 d4e Z$G d5d6 d6e Z%G d7d8 d8e Z&G d9d: d:e Z'G d;d< d d>e Z)G d?d deZ*G d@d d eZ+G dAdB dBeZ,G dCdD dDe,Z-G dEdF dFe-Z.G dGd dee,Z/dS )Ha
Command-line parsing library
This module is an optparse-inspired command-line parsing library that:
- handles both optional and positional arguments
- produces highly informative usage messages
- supports parsers that dispatch to sub-parsers
The following is a simple usage example that sums integers from the
command-line and writes the result to a file::
parser = argparse.ArgumentParser(
description='sum the integers at the command line')
parser.add_argument(
'integers', metavar='int', nargs='+', type=int,
help='an integer to be summed')
parser.add_argument(
'--log', default=sys.stdout, type=argparse.FileType('w'),
help='the file where the sum should be written')
args = parser.parse_args()
args.log.write('%s' % sum(args.integers))
args.log.close()
The module contains the following public classes:
- ArgumentParser -- The main entry point for command-line parsing. As the
example above shows, the add_argument() method is used to populate
the parser with actions for optional and positional arguments. Then
the parse_args() method is invoked to convert the args at the
command-line into an object with attributes.
- ArgumentError -- The exception raised by ArgumentParser objects when
there are errors with the parser's actions. Errors raised while
parsing the command-line are caught by ArgumentParser and emitted
as command-line messages.
- FileType -- A factory for defining types of files to be created. As the
example above shows, instances of FileType are typically passed as
the type= argument of add_argument() calls.
- Action -- The base class for parser actions. Typically actions are
selected by passing strings like 'store_true' or 'append_const' to
the action= argument of add_argument(). However, for greater
customization of ArgumentParser actions, subclasses of Action may
be defined and passed as the action= argument.
- HelpFormatter, RawDescriptionHelpFormatter, RawTextHelpFormatter,
ArgumentDefaultsHelpFormatter -- Formatter classes which
may be passed as the formatter_class= argument to the
ArgumentParser constructor. HelpFormatter is the default,
RawDescriptionHelpFormatter and RawTextHelpFormatter tell the parser
not to change the formatting for help text, and
ArgumentDefaultsHelpFormatter adds information about argument defaults
to the help.
All other classes in this module are considered implementation details.
(Also note that HelpFormatter and RawDescriptionHelpFormatter are only
considered public as object names -- the API of the formatter objects is
still considered an implementation detail.)
z1.1ArgumentParser
ArgumentErrorArgumentTypeErrorFileType
HelpFormatter ArgumentDefaultsHelpFormatterRawDescriptionHelpFormatterRawTextHelpFormatterMetavarTypeHelpFormatter NamespaceAction ONE_OR_MOREOPTIONALPARSER REMAINDERSUPPRESS ZERO_OR_MORE N)gettextngettextz ==SUPPRESS==?*+zA...z...Z_unrecognized_argsc @ s( e Zd ZdZdd Zdd Zdd ZdS ) _AttributeHoldera Abstract base class that provides __repr__.
The __repr__ method returns a string in the format::
ClassName(attr=name, attr=name, ...)
The attributes are determined either by a class-level attribute,
'_kwarg_names', or by inspecting the instance __dict__.
c C s t | j}g }i }x | D ]}|t| q W x8| D ],\}}| r`|d||f q<|||< q s z6HelpFormatter._Section.format_help.. z%*s%s:
) rT rS rP _join_partsr+ rR rU r rA )r! r Z item_helpZcurrent_indentrU r& r& r' format_help s
z"HelpFormatter._Section.format_help)N)r r, r- rN r] r& r& r& r' rD s
rD c C s | j j||f d S )N)rF r+ r )r! rW rX r& r& r' _add_item s zHelpFormatter._add_itemc C s0 | | | | j|}| |jg || _d S )N)rP rD rF r^ r] )r! rU Zsectionr& r& r'
start_section s zHelpFormatter.start_sectionc C s | j j| _ | d S )N)rF rT rR )r! r& r& r' end_section s
zHelpFormatter.end_sectionc C s$ |t k r |d k r | | j|g d S )N)r r^ _format_text)r! textr& r& r' add_text s zHelpFormatter.add_textc C s& |t k r"||||f}| | j| d S )N)r r^
_format_usage)r! usageactionsgroupsprefixrX r& r& r' add_usage s zHelpFormatter.add_usagec C sz |j tk rv| j}||g}x | |D ]}||| q&W tdd |D }|| j }t| j|| _| | j |g d S )Nc S s g | ] }t |qS r& )len)rV sr& r& r' rY s z.HelpFormatter.add_argument..)
helpr _format_action_invocation_iter_indented_subactionsr r? rA rC r^ _format_action)r! actionZget_invocationZ invocations subactionZinvocation_lengthZ
action_lengthr& r& r' add_argument s
zHelpFormatter.add_argumentc C s x|D ]}| | qW d S )N)rr )r! rf rp r& r& r'
add_arguments s
zHelpFormatter.add_argumentsc C s. | j }|r*| jd|}|dd }|S )Nz
r[ )rE r] rK substrip)r! rl r& r& r' r] s
zHelpFormatter.format_helpc C s d dd |D S )NrZ c S s g | ]}|r|t k r|qS r& )r )rV partr& r& r' rY # s z-HelpFormatter._join_parts..)r )r! Z part_stringsr& r& r' r\ " s
zHelpFormatter._join_partsc s: |d krt d}|d k r,|t| jd }n|d krL|sLdt| jd }n|d kr.dt| jd }g }g }x(|D ] }|jr|| qt|| qtW | j} | || |}
ddd ||
gD }| j| j t |t | kr.d} | ||} | ||}
t
| | }t
| |
}d|| ks*t d||
ks>t d fdd }t |t | d
krdt |t | d }|r||g| ||}|
||| n |r||g| ||}n|g}nZdt | }|| }|||}t |d krg }|
||| |
||| |g| }d |}d
||f S )Nzusage: )rL z%(prog)s c S s g | ] }|r|qS r& r& )rV rk r& r& r' rY C s z/HelpFormatter._format_usage..z%\(.*?\)+(?=\s|$)|\[.*?\]+(?=\s|$)|\S+c s g }g }|d k r t |d }n t |d }xb| D ]Z}|d t | krp|rp||d| g }t |d }|| |t |d 7 }q0W |r||d| |d k r|d t |d |d< |S )NrO rw r )rj r r )partsindentrh lineslineZline_lenrv )
text_widthr& r' get_linesW s"
z.HelpFormatter._format_usage..get_linesg ?rO r[ z%s%s
)N)_dictr; option_stringsr _format_actions_usager r@ rA rj rG findallrQ extend)r! re rf rg rh rL optionals positionalsrp formatZ action_usageZ part_regexpZ opt_usageZ pos_usageZ opt_partsZ pos_partsr} ry rz rx r& )r| r' rd ' sZ
zHelpFormatter._format_usagec C s t }i }x(|D ] }y||jd }W n tk
rB wY qX |t|j }||| |jkrx|jD ]}|| qlW |js||kr|| d7 < nd||< ||kr|| d7 < nd||< nF||kr|| d7 < nd||< ||kr|| d7 < nd||< x t|d |D ]} d || < q W qW g }
x0t|D ]"\} }|j t
kr|
d | | d kr|
| n"| | d d krh|
| d n|js| |} | || } ||kr| d dkr| d
dkr| dd
} |
| nf|jd }
|jdkr"d |
} n"| |} | || }d |
|f } |js^||kr^d
| } |
| qFW x(t|ddD ]} || g|
| | < q|W ddd |
D }d}d}td| d|}td| d|}td||f d|}tdd|}| }|S )Nr z [[]z (()rO |z%sz%s %sz[%s]T)reverserw c S s g | ]}|d k r|qS )Nr& )rV itemr& r& r' rY s z7HelpFormatter._format_actions_usage..z[\[(]z[\])]z(%s) z\1z (%s)z%s *%srZ z \(([^|]*)\))setindex_group_actionsr: rj addrequiredrange enumeraterl r r getpopr #_get_default_metavar_for_positional _format_argsnargs!_get_default_metavar_for_optionalr) r rG rt ru )r! rf rg
group_actionsZinsertsgroupstartendrp irx defaultrv
option_string args_stringrb opencloser& r& r' r sz
z#HelpFormatter._format_actions_usagec C sF d|kr|t | jd }t| j| j d}d| j }| |||d S )Nz%(prog))rL rw z
)r r; r? r@ rA
_fill_text)r! rb r| ry r& r& r' ra s
zHelpFormatter._format_textc
C sB t | jd | j}t| j| d}|| j d }| |}|jsV| jd|f}d| }n@t||kr~| jd||f}d| }d}n| jd|f}d| }|}|g}|jr| |} |
| |}
| d|d|
d f x@|
dd D ]} | d|d| f qW n| ds| d x$|
|D ]} | | | q W | |S ) Nr2 r rZ z%*s%s
z %*s%-*s r rO r[ )r> rC r= r? r@ rA rm rl rj _expand_help _split_linesr endswithrn ro r\ )
r! rp Z
help_positionZ
help_widthZ action_widthZ
action_headertupZ indent_firstrx Z help_textZ
help_linesr{ rq r& r& r' ro s6
z HelpFormatter._format_actionc C s |j s&| |}| ||d\}|S g }|jdkrB||j n8| |}| ||}x |j D ]}|d||f q`W d|S d S )NrO r z%s %sz, ) r r _metavar_formatterr r r r r r )r! rp r metavarrx r r r& r& r' rm $ s
z'HelpFormatter._format_action_invocationc sP |j d k r|j n.|jd k r.z{%s},c s t tr S f| S d S )N)
isinstancetuple)Z
tuple_size)resultr& r' r E s
z0HelpFormatter._metavar_formatter..format)r choicesr )r! rp default_metavarZ choice_strsr r& )r r' r < s
z HelpFormatter._metavar_formatterc C s | ||}|jd kr$d|d }n|jtkr.rw )
r r r
r r r r r r r )r! rp r Z get_metavarr Zformatsr& r& r' r L s$
zHelpFormatter._format_argsc C s t t|| jd}x"t|D ]}|| tkr ||= q W x,t|D ] }t|| dr@|| j||< q@W |dd k rddd |d D }||d< | || S )N)rL r r z, c S s g | ] }t |qS r& )r )rV cr& r& r' rY j s z.HelpFormatter._expand_help..)
r varsr; r/ r hasattrr r r _get_help_string)r! rp Zparamsr$ Z choices_strr& r& r' r a s
zHelpFormatter._expand_helpc c s@ y
|j }W n tk
r Y n X | | E d H | d S )N)_get_subactionsAttributeErrorrP rR )r! rp Zget_subactionsr& r& r' rn n s
z'HelpFormatter._iter_indented_subactionsc C s& | j d| }dd l}|||S )Nrw r )rJ rt ru textwrapZwrap)r! rb rM r r& r& r' r x s zHelpFormatter._split_linesc C s, | j d| }dd l}|j||||dS )Nrw r )Zinitial_indentZsubsequent_indent)rJ rt ru r Zfill)r! rb rM ry r r& r& r' r s
zHelpFormatter._fill_textc C s |j S )N)rl )r! rp r& r& r' r s z HelpFormatter._get_help_stringc C s
|j S )N)destupper)r! rp r& r& r' r s z/HelpFormatter._get_default_metavar_for_optionalc C s |j S )N)r )r! rp r& r& r' r s z1HelpFormatter._get_default_metavar_for_positional)r2 r3 N)N) r r, r- r. rN rP rR objectrD r^ r_ r` rc ri rr rs r] r\ rd r ra ro rm r r r rn r r r r r r& r& r& r' r s<
`g/
c @ s e Zd ZdZdd ZdS )r zHelp message formatter which retains any formatting in descriptions.
Only the name of this class is considered a public API. All the methods
provided by the class are considered an implementation detail.
c s d fdd|jddD S )NrZ c 3 s | ]} | V qd S )Nr& )rV r{ )ry r& r' s z9RawDescriptionHelpFormatter._fill_text..T)keepends)r
splitlines)r! rb rM ry r& )ry r' r s z&RawDescriptionHelpFormatter._fill_textN)r r, r- r. r r& r& r& r' r s c @ s e Zd ZdZdd ZdS )r zHelp message formatter which retains formatting of all help text.
Only the name of this class is considered a public API. All the methods
provided by the class are considered an implementation detail.
c C s | S )N)r )r! rb rM r& r& r' r s z!RawTextHelpFormatter._split_linesN)r r, r- r. r r& r& r& r' r s c @ s e Zd ZdZdd ZdS )r zHelp message formatter which adds default values to argument help.
Only the name of this class is considered a public API. All the methods
provided by the class are considered an implementation detail.
c C s> |j }d|j kr:|jtk r:ttg}|js2|j|kr:|d7 }|S )Nz
%(default)z (default: %(default)s))rl r r r
r r r )r! rp rl Zdefaulting_nargsr& r& r' r s
z.ArgumentDefaultsHelpFormatter._get_help_stringN)r r, r- r. r r& r& r& r' r s c @ s e Zd ZdZdd Zdd ZdS )r a Help message formatter which uses the argument 'type' as the default
metavar value (instead of the argument 'dest')
Only the name of this class is considered a public API. All the methods
provided by the class are considered an implementation detail.
c C s |j jS )N)r r )r! rp r& r& r' r s z:MetavarTypeHelpFormatter._get_default_metavar_for_optionalc C s |j jS )N)r r )r! rp r& r& r' r s z.r& )r! namesr& )r! r' r > s zAction._get_kwargsc C s t tdd S )Nz.__call__() not defined)NotImplementedErrorr~ )r! parser namespacevaluesr r& r& r' __call__L s zAction.__call__)NNNNNFNN)N)r r, r- r. rN r r r& r& r& r' r s 1
c s( e Zd Zd fdd ZdddZ ZS ) _StoreActionNFc sT |dkrt d|d k r,|tkr,t dt tt| j||||||||| |
d
d S )Nr znargs for store actions must be > 0; if you have nothing to store, actions such as store true or store const may be more appropriatez nargs must be %r to supply const)
r r r r r r r r rl r )r: r
superr rN ) r! r r r r r r r r rl r ) __class__r& r' rN R s
z_StoreAction.__init__c C s t || j| d S )N)setattrr )r! r r r r r& r& r' r o s z_StoreAction.__call__)NNNNNFNN)N)r r, r- rN r
__classcell__r& r& )r r' r P s r c s( e Zd Zd fdd ZdddZ ZS ) _StoreConstActionNFc s" t t| j||d||||d d S )Nr )r r r r r r rl )r r rN )r! r r r r r rl r )r r& r' rN u s
z_StoreConstAction.__init__c C s t || j| j d S )N)r r r )r! r r r r r& r& r' r s z_StoreConstAction.__call__)NFNN)N)r r, r- rN r r r& r& )r r' r s s
r c s e Zd Zd fdd Z ZS )_StoreTrueActionFNc s t t| j||d|||d d S )NT)r r r r r rl )r r rN )r! r r r r rl )r r& r' rN s
z_StoreTrueAction.__init__)FFN)r r, r- rN r r& r& )r r' r s r c s e Zd Zd fdd Z ZS )_StoreFalseActionTFNc s t t| j||d|||d d S )NF)r r r r r rl )r r rN )r! r r r r rl )r r& r' rN s
z_StoreFalseAction.__init__)TFN)r r, r- rN r r& r& )r r' r s r c s( e Zd Zd fdd ZdddZ ZS )
_AppendActionNFc sT |dkrt d|d k r,|tkr,t dt tt| j||||||||| |
d
d S )Nr znargs for append actions must be > 0; if arg strings are not supplying the value to append, the append const action may be more appropriatez nargs must be %r to supply const)
r r r r r r r r rl r )r: r
r r rN ) r! r r r r r r r r rl r )r r& r' rN s
z_AppendAction.__init__c C s2 t || jd }t|}|| t|| j| d S )N)r r r1 r r )r! r r r r r+ r& r& r' r s
z_AppendAction.__call__)NNNNNFNN)N)r r, r- rN r r r& r& )r r' r s r c s( e Zd Zd fdd ZdddZ ZS ) _AppendConstActionNFc
s$ t t| j||d|||||d d S )Nr )r r r r r r rl r )r r rN )r! r r r r r rl r )r r& r' rN s
z_AppendConstAction.__init__c C s4 t || jd }t|}|| j t|| j| d S )N)r r r1 r r r )r! r r r r r+ r& r& r' r s z_AppendConstAction.__call__)NFNN)N)r r, r- rN r r r& r& )r r' r s
r c s( e Zd Zd fdd ZdddZ ZS ) _CountActionNFc s t t| j||d|||d d S )Nr )r r r r r rl )r r rN )r! r r r r rl )r r& r' rN s
z_CountAction.__init__c C s0 t || jd }|d krd}t|| j|d d S )Nr rO )r r r )r! r r r r countr& r& r' r s z_CountAction.__call__)NFN)N)r r, r- rN r r r& r& )r r' r s r c s. e Zd Zeedf fdd ZdddZ ZS ) _HelpActionNc s t t| j|||d|d d S )Nr )r r r r rl )r r rN )r! r r r rl )r r& r' rN s
z_HelpAction.__init__c C s | | d S )N)
print_helpexit)r! r r r r r& r& r' r s z_HelpAction.__call__)N)r r, r- r rN r r r& r& )r r' r s r c s0 e Zd Zdeedf fdd ZdddZ ZS )_VersionActionNz&show program's version number and exitc s$ t t| j|||d|d || _d S )Nr )r r r r rl )r r rN version)r! r r r r rl )r r& r' rN s
z_VersionAction.__init__c C sD | j }|d kr|j }| }|| || tj | d S )N)r _get_formatterrc _print_messager] _sysstdoutr )r! r r r r r rS r& r& r' r ' s
z_VersionAction.__call__)N)r r, r- r rN r r r& r& )r r' r s
r c sP e Zd ZG dd deZedddf fdd Zdd Zd d
Zd
d d Z Z
S )_SubParsersActionc s e Zd Z fddZ ZS )z&_SubParsersAction._ChoicesPseudoActionc s@ | }}|r |dd | 7 }ttj| }|jg |||d d S )Nz (%s)z, )r r rl r )r r r _ChoicesPseudoActionrN )r! r$ aliasesrl r r Zsup)r r& r' rN 5 s
z/_SubParsersAction._ChoicesPseudoAction.__init__)r r, r- rN r r& r& )r r' r 3 s r FNc s< || _ || _i | _g | _tt| j||t| j|||d d S )N)r r r r r rl r ) _prog_prefix
_parser_class_name_parser_map_choices_actionsr r rN r )r! r rL parser_classr r rl r )r r& r' rN = s
z_SubParsersAction.__init__c K s | dd kr d| j|f |d< |dd}d|krX|d}| |||}| j| | jf |}|| j|< x|D ]}|| j|< qtW |S )NrL z%s %sr r& rl )r r r r r r r r )r! r$ kwargsr rl Z
choice_actionr aliasr& r& r'
add_parserT s
z _SubParsersAction.add_parserc C s | j S )N)r )r! r& r& r' r k s z!_SubParsersAction._get_subactionsc C s |d }|dd }| j tk r,t|| j | y| j| }W n< tk
rv |d| jd}td| }t| |Y nX ||d \} }x$t |
D ]\}
} t||
| qW |rt | t g t
|t | d S )Nr rO z, ) parser_namer z5unknown parser %(parser_name)r (choices: %(choices)s))r r r r r9 r r~ r parse_known_argsr r+
setdefault_UNRECOGNIZED_ARGS_ATTRr r ) r! r r r r r r" rX msgZ subnamespacekeyr% r& r& r' r n s"
z_SubParsersAction.__call__)N) r r, r- r r r rN r r r r r& r& )r r' r 1 s r c @ s* e Zd ZdZd ddZdd Zd d
ZdS ) r a Factory for creating file object types
Instances of FileType are typically passed as type= arguments to the
ArgumentParser add_argument() method.
Keyword Arguments:
- mode -- A string indicating how the file is to be opened. Accepts the
same values as the builtin open() function.
- bufsize -- The file's desired buffer size. Accepts the same values as
the builtin open() function.
- encoding -- The file's encoding. Accepts the same values as the
builtin open() function.
- errors -- A string indicating how encoding and decoding errors are to
be handled. Accepts the same value as the builtin open() function.
rr Nc C s || _ || _|| _|| _d S )N)_mode_bufsize _encoding_errors)r! modebufsizeencodingerrorsr& r& r' rN s zFileType.__init__c
C s |dkr>d| j krtjS d| j kr(tjS td| j }t|yt|| j | j| j| j S t
k
r } z td}t |||f W d d }~X Y nX d S )N-r wzargument "-" with mode %rzcan't open '%s': %s) r r stdinr r~ r: r r r r OSErrorr )r! stringr er r& r& r' r s
zFileType.__call__c C sT | j | jf}d| jfd| jfg}ddd |D dd |D }dt| j|f S )Nr r z, c S s g | ]}|d krt |qS )r )r )rV r# r& r& r' rY s z%FileType.__repr__..c S s$ g | ] \}}|d k rd||f qS )Nz%s=%rr& )rV kwr# r& r& r' rY s z%s(%s))r r r r r r r )r! rX r Zargs_strr& r& r' r( s
zFileType.__repr__)r r NN)r r, r- r. rN r r( r& r& r& r' r s
c @ s( e Zd ZdZdd Zdd Zdd ZdS ) r
zSimple object for storing attributes.
Implements equality by attribute names and values, and provides a simple
string representation.
c K s" x |D ]}t | ||| qW d S )N)r )r! r r$ r& r& r' rN s
zNamespace.__init__c C s t |tstS t| t|kS )N)r r
NotImplementedr )r! otherr& r& r' __eq__ s
zNamespace.__eq__c C s
|| j kS )N)r* )r! r r& r& r' __contains__ s zNamespace.__contains__N)r r, r- r. rN r r r& r& r& r' r
s c s e Zd Z fddZdd Zd&ddZdd Zd
d Zd d
Zdd Z dd Z
dd Z dd Z dd Z
dd Zdd Zd'd d Zd d Zd d! Zd"d# Zd$d% Z ZS )(_ActionsContainerc s t t| || _|| _|| _|| _i | _| dd t | ddt | ddt
| ddt | ddt | ddt
| ddt | ddt | dd t | dd
t | dd t | g | _i | _g | _g | _i | _td | _g | _ d S )
Nrp ZstoreZ store_const
store_trueZ store_falser Z append_constr rl r parsersz^-\d+$|^-\d*\.\d+$) r r
rN descriptionargument_default prefix_charsconflict_handler _registriesregisterr r r r r r r r r r _get_handler_actions_option_string_actions_action_groups_mutually_exclusive_groups _defaultsrG rH _negative_number_matcher _has_negative_number_optionals)r! r
r r r )r r& r' rN s2 z_ActionsContainer.__init__c C s | j |i }|||< d S )N)r r )r!
registry_namer% r registryr& r& r' r s z_ActionsContainer.registerNc C s | j | ||S )N)r r )r! r r% r r& r& r'
_registry_get s z _ActionsContainer._registry_getc K s6 | j | x$| jD ]}|j|kr||j |_qW d S )N)r updater r r )r! r rp r& r& r' set_defaults s
z _ActionsContainer.set_defaultsc C s8 x(| j D ] }|j|kr|jd k r|jS qW | j|d S )N)r r r r r )r! r rp r& r& r' get_default& s
z _ActionsContainer.get_defaultc O s. | j }|r&t|dkrH|d d |krH|r:d|kr:td| j||}n | j||}d|kr|d }|| jkr~| j| |d< n| jdk r| j|d< | |}t|std|f |f |}| d|j
|j
}t|std |f t | d
r$y|
|d W n tk
r" td Y nX | |S ) z
add_argument(dest, ..., name=value, ...)
add_argument(option_string, option_string, ..., name=value, ...)
rO r r z+dest supplied twice for positional argumentr Nzunknown action "%s"r z%r is not callabler z,length of metavar tuple does not match nargs)r rj r: _get_positional_kwargs_get_optional_kwargsr r _pop_action_classcallabler r r r r TypeError _add_action)r! rX r charsr Z action_classrp type_funcr& r& r' rr 0 s2
z _ActionsContainer.add_argumentc O s t | f||}| j| |S )N)_ArgumentGroupr r )r! rX r r r& r& r' add_argument_group_ s z$_ActionsContainer.add_argument_groupc K s t | f|}| j| |S )N)_MutuallyExclusiveGroupr r )r! r r r& r& r' add_mutually_exclusive_groupd s z._ActionsContainer.add_mutually_exclusive_groupc C sh | | | j| | |_x|jD ]}|| j|< q$W x,|jD ]"}| j|r>| js>| jd q>W |S )NT) _check_conflictr r containerr r r matchr )r! rp r r& r& r' r& i s
z _ActionsContainer._add_actionc C s | j | d S )N)r remove)r! rp r& r& r' _remove_action~ s z _ActionsContainer._remove_actionc C s i }x8| j D ].}|j|kr0td}t||j |||j< q W i }xR|j D ]H}|j|krt| j|j|j|jd||j< x |jD ]}||j ||< q|W qJW x4|jD ]*}| j |j
d}x|jD ] }|||< qW qW x |j D ]}| ||
| qW d S )Nz.cannot merge actions - two groups are named %r)titler
r )r )r r2 r~ r: r* r
r r r r, r r r r& )r! r. Ztitle_group_mapr r Z group_maprp mutex_groupr& r& r' _add_container_actions s,
z(_ActionsContainer._add_container_actionsc K s^ d|krt d}t||dttgkr2d|d< |dtkrPd|krPd|d< t||g dS )Nr z1'required' is an invalid argument for positionalsr Tr )r r )r~ r% r r
r r )r! r r r r& r& r' r! s z(_ActionsContainer._get_positional_kwargsc O s g }g }xv|D ]n}|d | j kr@|| j d}td}t|| || |d | j krt|dkr|d | j kr|| qW |dd }|d kr|r|d }n|d }|| j }|std}t|| |dd}t|||d S )
Nr )optionr zNinvalid option string %(option)r: must start with a character %(prefix_chars)rrO r z%dest= is required for options like %rr r~ )r r ) r r~ r: r rj r lstripreplacer ) r! rX r r Zlong_option_stringsr r r Zdest_option_stringr& r& r' r" s0
z&_ActionsContainer._get_optional_kwargsc C s | d|}| d||S )Nrp )r r )r! r r rp r& r& r' r# s z#_ActionsContainer._pop_action_classc C sD d| j }y
t| |S tk
r> td}t|| j Y nX d S )Nz_handle_conflict_%sz%invalid conflict_resolution value: %r)r r r r~ r: )r! Zhandler_func_namer r& r& r' r s
z _ActionsContainer._get_handlerc C sP g }x0|j D ]&}|| jkr | j| }|||f q W |rL| }||| d S )N)r r r r )r! rp Zconfl_optionalsr Zconfl_optionalr r& r& r' r- s
z!_ActionsContainer._check_conflictc C s6 t ddt|}ddd |D }t||| d S )Nz conflicting option string: %sz conflicting option strings: %sz, c S s g | ] \}}|qS r& r& )rV r rp r& r& r' rY s z<_ActionsContainer._handle_conflict_error..)r rj r r )r! rp conflicting_actionsr Zconflict_stringr& r& r' _handle_conflict_error s
z(_ActionsContainer._handle_conflict_errorc C sB x<|D ]4\}}|j | | j|d |j s|j| qW d S )N)r r0 r r r. r1 )r! rp r8 r r& r& r' _handle_conflict_resolve s
z*_ActionsContainer._handle_conflict_resolve)N)N)r r, r- rN r r r r rr r* r, r& r1 r4 r! r" r# r r- r9 r: r r& r& )r r' r
s$ 4
/($
r
c s6 e Zd Zd fdd Z fddZ fddZ ZS ) r) Nc s |j }|d|j |d|j |d|j tt| j}|f d|i| || _g | _|j | _ |j
| _
|j | _ |j | _ |j
| _
|j| _d S )Nr r r r
)r r r r r r) rN r2 r r r r r r r )r! r. r2 r
r r Z
super_init)r r& r' rN s z_ArgumentGroup.__init__c s t t| |}| j| |S )N)r r) r& r r )r! rp )r r& r' r& ( s z_ArgumentGroup._add_actionc s t t| | | j| d S )N)r r) r1 r r0 )r! rp )r r& r' r1 - s z _ArgumentGroup._remove_action)NN)r r, r- rN r& r1 r r& r& )r r' r) s r) c s. e Zd Zd fdd Zdd Zdd Z ZS ) r+ Fc s t t| | || _|| _d S )N)r r+ rN r
_container)r! r. r )r r& r' rN 4 s z _MutuallyExclusiveGroup.__init__c C s2 |j rtd}t|| j|}| j| |S )Nz-mutually exclusive arguments must be optional)r r~ r: r; r& r r )r! rp r r& r& r' r& 9 s z#_MutuallyExclusiveGroup._add_actionc C s | j | | j| d S )N)r; r1 r r0 )r! rp r& r& r' r1 A s z&_MutuallyExclusiveGroup._remove_action)F)r r, r- rN r& r1 r r& r& )r r' r+ 2 s r+ c s* e Zd ZdZddddg eddddddf fdd Zdd Zd
d Zd d
Zdd Z dd Z
dAddZ dBddZ dd Z
dd Zdd Zd d Zd d Zd d! Zd"d# Zd$d% ZdCd&d'ZdDd(d)Zd*d+ Zd,d- Zd.d/ Zd0d1 Zd2d3 Zd4d5 Z dEd6d7Z dFd8d9Z dGd:d;Z dHd=d>Z d?d@ Z! Z"S )Ir a Object for parsing command line strings into Python objects.
Keyword Arguments:
- prog -- The name of the program (default: sys.argv[0])
- usage -- A usage message (default: auto-generated from arguments)
- description -- A description of what the program does
- epilog -- Text following the argument descriptions
- parents -- Parsers whose arguments should be copied into this one
- formatter_class -- HelpFormatter class for printing help messages
- prefix_chars -- Characters that prefix optional arguments
- fromfile_prefix_chars -- Characters that prefix files containing
additional arguments
- argument_default -- The default value for all arguments
- conflict_handler -- String indicating how to handle conflicts
- add_help -- Add a -h/-help option
- allow_abbrev -- Allow long options to be abbreviated unambiguously
Nr errorTc
s& t t| j}
|
||| |
d |d kr6tjtjd }|| _|| _ || _
|| _ || _ | | _
| | _| j}|td| _|td| _d | _dd }| dd | d|krdn|d }| j
r| j|d |d
d d ttd d
xD|D ]<}| | y
|j}W n tk
r Y qX | j| qW d S )N)r
r r r r zpositional argumentszoptional argumentsc S s | S )Nr& )r r& r& r' identity s z)ArgumentParser.__init__..identityr r hr2 rl z show this help message and exit)rp r rl )r r rN r7 pathbasenamer argvrL re epilogformatter_classfromfile_prefix_charsadd_help allow_abbrevr* r~ _positionals
_optionals _subparsersr rr r r4 r r r )r! rL re r
rB parentsrC r rD r r rE rF Z superinitZ add_groupr= Zdefault_prefixrT defaults)r r& r' rN Y sB
zArgumentParser.__init__c s" ddddddg} fdd|D S ) NrL re r
rC r rE c s g | ]}|t |fqS r& )r )rV r$ )r! r& r' rY s z.ArgumentParser._get_kwargs..r& )r! r r& )r! r' r s zArgumentParser._get_kwargsc K s | j d k r| td |dt| d|ks8d|krht|dd}t|dd }| ||| _ n| j| _ |dd kr| }|
}| j }| | j
||d | |d< | |d}|f d g i|}| j | |S )
Nz(cannot have multiple subparser argumentsr r2 r
Z subcommandsrL rZ r r )rI r< r~ r r r r* rG r r _get_positional_actionsr ri re r] ru r# r& ) r! r r2 r
rS r rg Z
parsers_classrp r& r& r' add_subparsers s$
z ArgumentParser.add_subparsersc C s$ |j r| j| n | j| |S )N)r rH r& rG )r! rp r& r& r' r& s zArgumentParser._add_actionc C s dd | j D S )Nc S s g | ]}|j r|qS r& )r )rV rp r& r& r' rY s z8ArgumentParser._get_optional_actions..)r )r! r& r& r' _get_optional_actions s z$ArgumentParser._get_optional_actionsc C s dd | j D S )Nc S s g | ]}|j s|qS r& )r )rV rp r& r& r' rY s z:ArgumentParser._get_positional_actions..)r )r! r& r& r' rL s z&ArgumentParser._get_positional_actionsc C s4 | ||\}}|r0td}| |d| |S )Nzunrecognized arguments: %srw )r r~ r< r )r! rX r rA r r& r& r'
parse_args s
zArgumentParser.parse_argsc C s |d krt jdd }nt|}|d kr.t }x>| jD ]4}|jtk r6t||js6|jtk r6t ||j|j q6W x*| j
D ] }t||svt ||| j
| qvW y<| ||\}}t|t r|
t|t t|t ||fS tk
r t d }| t| Y nX d S )NrO )r rA r/ r
r r r r r r r _parse_known_argsr r r delattrr exc_infor< r )r! rX r rp r errr& r& r' r s,
z ArgumentParser.parse_known_argsc s" j d k r i x` jD ]V}|j}xJt|jD ]<\}} |g }||d | |||d d q6W q W i g }t} xnt| D ]b\}}
|
dkr|d xF| D ]}
|d qW q |
} | d krd} n | |< d} || qW d
|t t d fdd fd d
}
fd d }g d
rpt
}nd}x|
|krt
fddD }
|kr|
}|
kr|
qvn|
kr
| }| |
|
qvW |
}|d g }x jD ]|}|kr|jr>|t| nT|jd k rt|jtrt|jr|jt|jkrt|j ||j qW |r tdd
| xb jD ]X}|jrxH|jD ]}|krP qW dd |jD }td} |d
| qW fS )NrO z--r AOrZ c s | | |}|| jk rf | x: | g D ]*}|kr8td}t|}t| || q8W |tk r|| || d S )Nz not allowed with argument %s)r _get_valuesr r r~ r r r )rp Zargument_stringsr Zargument_valuesZconflict_actionr Z action_name)action_conflictsr seen_actionsseen_non_default_actionsr! r& r' take_action3 s
z5ArgumentParser._parse_known_args..take_actionc s | }|\}}}j }g }x>|d kr> | | d S |d k r||d}j}|dkr|d |kr||g |f |d } | |d }|dd pd }
j} || kr| | }|
}ntd} t|| | n@|dkr| d }
|g}||||f P ntd} t|| | q | d }|d }|||}|| }
||
}||||f P q W |shtx |D ]\}}}||| qnW |
S )NrO rT r z ignored explicit argument %r)_match_argumentr r r r~ r rQ ) start_index option_tuplerp r explicit_argZmatch_argumentZ
action_tuples arg_countr' charZnew_explicit_argZ
optionals_mapr stoprX r Zselected_patterns)r" arg_strings_patternextrasoption_string_indicesr! rZ r& r' consume_optionalH sP
z:ArgumentParser._parse_known_args..consume_optionalc sr j }| d }||}x8t|D ]*\}} | | | }| |7 } || q(W t|d d d < | S )N)_match_arguments_partialziprj )r\ Z
match_partialZselected_patternZ
arg_countsrp r_ rX )r" rb r r! rZ r& r' consume_positionals s
z=ArgumentParser._parse_known_args..consume_positionalsr r c s g | ]}| kr|qS r& r& )rV r )r\ r& r' rY s z4ArgumentParser._parse_known_args..z(the following arguments are required: %sz, c S s g | ]}|j tk rt|qS r& )rl r r )rV rp r& r& r' rY s z#one of the arguments %s is requiredrw )N) rD _read_args_from_filesr r r r r iterr _parse_optionalr r rL r? r> r r r r r r r r r r
_get_valuer< r~ )r! r" r r3 r r Z mutex_actionZ conflictsZarg_string_pattern_partsZarg_strings_iter
arg_stringr] patternre rh Zmax_option_string_indexZnext_option_string_indexZpositionals_end_indexZstringsZ
stop_indexZrequired_actionsrp r r r r& ) rW r" rb rc r rd r rX rY r! r\ rZ r' rP s
J
z ArgumentParser._parse_known_argsc
C s g }x|D ]}|r |d | j kr,|| q
ylt|dd R}g }x2| D ]"}x | |D ]}|| qbW qRW | |}|| W d Q R X W q
tk
r t
d }| t | Y q
X q
W |S )Nr rO )
rD r r readr convert_arg_line_to_argsri r r r rR r< r )r! r" Znew_arg_stringsrm Z args_filearg_liner# rS r& r& r' ri s
z$ArgumentParser._read_args_from_filesc C s |gS )Nr& )r! rq r& r& r' rp s z'ArgumentParser.convert_arg_line_to_argsc C sz | |}t||}|d krld tdttdttdi}||j}|d krbtdd|j|j }t ||t
| dS )Nzexpected one argumentz expected at most one argumentz expected at least one argumentzexpected %s argumentzexpected %s argumentsrO ) _get_nargs_patternrG r/ r~ r
r r r r r rj r )r! rp rb
nargs_patternr/ Z nargs_errorsr r& r& r' r[ s
z ArgumentParser._match_argumentc st g }xjt t|ddD ]V}|d | }d fdd|D }t||}|d k r|dd | D P qW |S )Nr r rZ c s g | ]} |qS r& )rr )rV rp )r! r& r' rY 3 s z;ArgumentParser._match_arguments_partial..c S s g | ] }t |qS r& )rj )rV r r& r& r' rY 7 s )r rj r rG r/ r rg )r! rf rb r r Z
actions_slicern r/ r& )r! r' rf - s
z'ArgumentParser._match_arguments_partialc
C s |sd S |d | j krd S || jkr8| j| }||d fS t|dkrHd S d|kr~|dd\}}|| jkr~| j| }|||fS | jr| |}t|dkrddd |D }||d}td}| || nt|dkr|\} | S | j
|r| j sd S d |kr
d S d |d fS )
Nr rO =z, c S s g | ]\}}}|qS r& r& )rV rp r r^ r& r& r' rY ] s z2ArgumentParser._parse_optional..)r5 Zmatchesz4ambiguous option: %(option)s could match %(matches)srw ) r r rj splitrF _get_option_tuplesr r~ r< r r/ r )
r! rm rp r r^ Z
option_tuplesZoptionsrX r r] r& r& r' rk = s>
z ArgumentParser._parse_optionalc
C s2 g }| j }|d |kr~|d |kr~d|kr<|dd\}}n|}d }x| jD ],}||rL| j| }|||f}|| qLW n|d |kr |d |kr |}d }|d d }|dd } xr| jD ]T}||kr| j| }||| f}|| q||r| j| }|||f}|| qW n| td| |S )Nr rO rt r2 z unexpected option string: %s)r ru r
startswithr r< r~ )
r! r r r' Z
option_prefixr^ rp r Zshort_option_prefixZshort_explicit_argr& r& r' rv x s8
z!ArgumentParser._get_option_tuplesc C s |j }|d krd}nf|tkr"d}nX|tkr0d}nJ|tkr>d}n<|tkrLd}n.|tkrZd}n |tkrhd}ndd d
| }|jr| d d }| d d }|S )
Nz(-*A-*)z(-*A?-*)z (-*[A-]*)z
(-*A[A-]*)z([-AO]*)z (-*A[-AO]*)z(-*-*)z(-*%s-*)z-*rT rZ r )
r r
r r r r r r r r7 )r! rp r rs r& r& r' rr s( z!ArgumentParser._get_nargs_patternc C s4 | ||\}}|r0td}| |d| |S )Nzunrecognized arguments: %srw )parse_known_intermixed_argsr~ r< r )r! rX r rA r r& r& r' parse_intermixed_args s
z$ArgumentParser.parse_intermixed_argsc s | dd D }|r,td|d j fdd| jD rHtdzl| j}z| jd krp| dd | _x( D ] }|j|_t|_|j|_ t|_qvW |
||\}}xR D ]J}t ||j rt
||j g krddlm} |d |j |f t||j qW W d x D ]}|j|_|j |_qW X | }zRx |D ]}|j|_d
|_q4W x | jD ]} | j| _d
| _qTW |
||\}}
W d x|D ]}|j|_qW x| jD ]} | j| _qW X W d || _X ||
fS ) Nc S s g | ]}|j ttgkr|qS r& )r r r )rV rp r& r& r' rY s z>ArgumentParser.parse_known_intermixed_args..z3parse_intermixed_args: positional arg with nargs=%sr c s& g | ] }|j D ]}| kr|jqqS r& )r r )rV r rp )r r& r' rY s z;parse_intermixed_args: positional in mutuallyExclusiveGroup )warnzDo not expect %s in %sF)rL r% r r re format_usageZ
save_nargsr r Z save_defaultr r r r warningsr{ rQ rN r Z
save_required) r! rX r aZ
save_usagerp Zremaining_argsr{ r r rc r& )r r' rx sX
z*ArgumentParser.parse_known_intermixed_argsc s j ttgkr2y|d W n tk
r0 Y nX |sz j tkrz jrN j}n j}t |t
rv |} | n|s j t
kr js jd k r j}n|} | nt|dkr j d tgkr|\} |} | n j tkr fdd|D }nt j tkr@ fdd|D } |d nB j tkrRt}n0 fdd|D }x|D ]} | qlW |S )Nz--rO c s g | ]} |qS r& )rl )rV v)rp r! r& r' rY M s z.ArgumentParser._get_values..c s g | ]} |qS r& )rl )rV r )rp r! r& r' rY Q s r c s g | ]} |qS r& )rl )rV r )rp r! r& r' rY Z s )r r r r0 r: r
r r r r r rl _check_valuer rj r )r! rp r" r% rm r r& )rp r! r' rV ) sB
zArgumentParser._get_valuesc C s | d|j|j}t|s0td}t||| y ||}W n tk
r~ t|jdt|j}tt
d }t||Y nL t t fk
r t|jdt|j}||d}td}t||| Y nX |S )Nr z%r is not callabler rO )r r% z!invalid %(type)s value: %(value)r)
r r r$ r~ r r r r r r rR r% r: )r! rp rm r( r r r$ rX r& r& r' rl a s
zArgumentParser._get_valuec C sF |j d k rB||j krB|dtt|j d}td}t||| d S )Nz, )r% r z3invalid choice: %(value)r (choose from %(choices)s))r r mapr r~ r )r! rp r% rX r r& r& r' r { s
zArgumentParser._check_valuec C s$ | }|| j| j| j | S )N)r ri re r r r] )r! rS r& r& r' r| s zArgumentParser.format_usagec C sx | }|| j| j| j || j x:| jD ]0}||j ||j |
|j | q0W || j
| S )N)r ri re r r rc r
r r_ r2 rs r r` rB r] )r! rS Z action_groupr& r& r' r] s zArgumentParser.format_helpc C s | j | jdS )N)rL )rC rL )r! r& r& r' r s z ArgumentParser._get_formatterc C s" |d krt j}| | | d S )N)r r r r| )r! filer& r& r' print_usage s zArgumentParser.print_usagec C s" |d krt j}| | | d S )N)r r r r] )r! r r& r& r' r s zArgumentParser.print_helpc C s |r |d krt j}|| d S )N)r stderrwrite)r! r r r& r& r' r s z ArgumentParser._print_messager c C s |r| |tj t| d S )N)r r r r )r! Zstatusr r& r& r' r s zArgumentParser.exitc C s0 | tj | j|d}| dtd| dS )zerror(message: string)
Prints a usage message incorporating the message to stderr and
exits.
If you override this in a subclass, it should not return -- it
should either exit or raise an exception.
)rL r r2 z %(prog)s: error: %(message)s
N)r r r rL r r~ )r! r rX r& r& r' r< s zArgumentParser.error)NN)NN)NN)NN)N)N)N)r N)#r r, r- r. r rN r rM r& rN rL rO r rP ri rp r[ rf rk rv rr ry rx rV rl r r| r] r r r r r r< r r& r& )r r' r F sT 4
# w;,1
M8
)0r. __version____all__osr7 rerG sysr r r~ r r r
r r r r r r r r1 r r r r r r Exceptionr r r r r r r r r r r r r r r
r
r) r+ r r& r& r& r' > sz {
[#&b6 5"