c,(dZdZddlZddlZddlmZddlmZddlm Z m Z ddl m Z Gdd e ZGd d e ZGd d eZGddeZGddeZeZdZe ddZe dddZe dddZy)zHelper functions to support command line tools providing more than one command. e.g called as "tool command [options] args..." where and are command'specific zrestructuredtext enN)basename) Configuration)init_log get_threshold)callable_deprecatedceZdZdZy)BadCommandUsagezRaised when an unknown command is used or when a command is not correctly used (bad options, too much / missing arguments...). Trigger display of command usage. N__name__ __module__ __qualname____doc__;/usr/lib/python3/dist-packages/logilab/common/clcommands.pyr r %srr ceZdZdZy) CommandErrorz|Raised when a command can't be processed and we want to display it and exit, without traceback nor usage displayed. Nr rrrrr-srrcdeZdZdZdddddej dfdZd dZdZd dZ d dZ d Z d Z y) CommandLineaFUsage: >>> LDI = cli.CommandLine('ldi', doc='Logilab debian installer', version=version, rcfile=RCFILE) >>> LDI.register(MyCommandClass) >>> LDI.register(MyOtherCommandClass) >>> LDI.run(sys.argv[1:]) Arguments: * `pgm`, the program name, default to `basename(sys.argv[0])` * `doc`, a short description of the command line tool * `copyright`, additional doc string that will be appended to the generated doc * `version`, version number of string of the tool. If specified, global --version option will be available. * `rcfile`, path to a configuration file. If specified, global --C/--rc-file option will be available? self.rcfile = rcfile * `logger`, logger to propagate to commands, default to `logging.getLogger(self.pgm))` NTc|ttjd}||_||_||_||_||_d|_||_ ||_ y)Nr) rsysargvpgmdoc copyrightversionrcfilelogger logthresholdcheck_duplicated_command)selfrrrrrrr s r__init__zCommandLine.__init__RsU ;388A;'C"   ((@%rc|jr$|s"|j|vsJd|jz|||j<|S)z,register the given :class:`Command` subclassza command %s is already defined)r name)r!clsforces rregisterzCommandLine.registergsE00ESXXT=Q - 8 QSXX rc$td|jd |jd}dvr|j d|j .|dvr*t |j tjd|j}|'|d vr# |jd}|jd} |j|} tjj||y#t$r|j dYwxYw#t$r|j dYuwxYw#t$r,t d |zt |j dYwxYw#t$rQ}t d d t|rt d|zd t tjdYd}~yd}~wt$rN}t d|t t j!tjdYd}~yd}~wwxYw)zmain command line access point: * init logging * handle global options (-h/--help, --version, -C/--rc-file) * check command * run command Terminate by :exc:`SystemExit` Tz%(levelname)s: %(message)s)debugr logformatr)z-h--helpNz --version)z-Cz --rc-filezERROR: no %s command Interrupted endz: %szERROR:)rrpop IndexErrorusage_and_exitrprintrexitr get_commandKeyErrormain_runKeyboardInterruptstrr help)r!argsargrcommandexcerrs rrunzCommandLine.runos **2  #((1+C " "    " << # (< $,,  HHQK  #)<"< '!hhqk #&&s+G  HHW%%dF3 4+ #    " # '##A& ' # (3. / G    " # !  -S )3xfsl, G HHQKK  (C G ',,. ! HHQKK  s[C( "D0D(%E (DDD%$D%(2EE H)AF55 HAH  Hctj|j}|g|_|t |j }|j ||SN)loggingLoggerrhandlersrrsetLevel)r!handlerrrs r create_loggerzCommandLine.create_loggersD)")  ():):;L % rc| |j}|Jtj|jx}|_|j t |j |||SrD)rrE getLoggerrrHrr)r!cmdrs rr7zCommandLine.get_commandsX >[[F >#*#4#4TXX#> >FT[ OOM$*;*;< =tCy  rctd|jd|jr tddtd|jrtd|jztd|jzt |Dcgc] }t |c}}d|z}t|jD]3\}}|jrtd||zd||j5|jrtd |jztd |jz|jrtd |jz|jrtd |jyycc}w) z\display usage for the main program (i.e. when no command supplied) and exit zusage:r.r/z [--rc-file=]z) [options] ...z %szi Type "%(pgm)s --help" for more information about a specific command. Available commands are : Nz Use --rc-file= / -C before the command to specify a configuration file. Default to %s. z?%(pgm)s -h/--help display this usage information and exitzA%(pgm)s -v/--version display version configuration and exit ) r5rrr__dict__maxlensorteditemshiddenshort_descriptionrr)r!rMmax_lenpaddingcmdnames rusagezCommandLine.usagesP hc* ;; 4# > 9: 88 &488# $  'mm  40Cs3x01-"4::<0 SLGS::cGg-x8#:O:O:QR S ;; ++    1mm  << 0--   >> $ ' 11sE3cN|jtj|yrD)rZrr6)r!statuss rr4zCommandLine.usage_and_exits  r)FrD) r r r rrEERRORr"r'rBrJr7rZr4rrrrr6sH:  ]]!%A*0d!)(Vrrc^eZdZdZdZdZdZdZdZe dZ e dZ dZ dZ d d Zd Zy) CommandaBase class for command line commands. Class attributes: * `name`, the name of the command * `min_args`, minimum number of arguments, None if unspecified * `max_args`, maximum number of arguments, None if unspecified * `arguments`, string describing arguments, used in command usage * `hidden`, boolean flag telling if the command should be hidden, e.g. does not appear in help's commands list * `options`, options list, as allowed by :mod:configuration FNc:|jjddS)Nz r`)rreplacer%s r descriptionzCommand.descriptions{{""62..rcF|jjddS)N.r)rdsplitrcs rrVzCommand.short_descriptions &&s+A..rcd|jd|jd|j}tj||||_y)Nz%prog r.z )rZ)r$ argumentsrdrr"r)r!rrZs rr"zCommand.__init__s6(, 4>>4CSCSCUVt51 rc|j#t||jkr td|j$t||jkDr tdyy)z&check command's arguments are providedNzmissing argumenttoo many arguments)min_argsrRr max_argsr!r=s r check_argszCommand.check_args sU == $TT]])B!"45 5 == $TT]])B!"67 7*C $rc|r|j||j|} |j||j|y#t$r%}|j j |Yd}~yd}~wwxYw)aRun the command and return status 0 if everything went fine. If :exc:`CommandError` is raised by the underlying command, simply log the error and return status 2. Any other exceptions, including :exc:`BadCommandUsage` will be propagated. Nr)load_file_configurationload_command_line_configurationrorBrrerror)r!r=rrAs rr9zCommand.main_runsm   ( ( 033D9  OOD ! HHTN  KK  c " s"A A7A22A7ct)+run the command with its specific arguments)NotImplementedErrorrns rrBz Command.run's !##rrD)r r r rrir$rUrlrm classmethodrdrVr"ror9rBrrrr_r_s\$I D FHH//// 8($rr_c"eZdZdZdZdZdZdZy)ListCommandsCommandz4list available commands, useful for bash completion. listcommandsz [command]Tc |rG|j}t|}|jD]\}}tdtd|z yt tj }|D]#}t|}|j rt|%y)rvr,z--N)r2 _COMMANDSoptionsr5rSkeysrU)r!r=r?rMoptnameoptdictcommandss rrBzListCommandsCommand.run3s hhjGG$C$'KK & hdWn% &inn./H# #(zz'N #rN)r r r rr$rirUrBrrrrzrz,s> DI F #rrzz~Copyright (c) 2004-2011 LOGILAB S.A. (Paris, FRANCE), all rights reserved. http://www.logilab.fr/ -- mailto:contact@logilab.frzuse cls.register(cli)c<|D]}tj|y)zregister existing commandsN)r}r')r command_klasss rregister_commandsrLs!"* =)*rzuse args.pop(0)cp|t_|t_|t_tj |y)zcommand line tool: run command specified by argument list (without the program name). Raise SystemExit with status 0 if everything went fine. >>> main_run(sys.argv[1:]) N)r}rrrrB)r=rrrs rr9r9Ss'IM#II MM$rc |jd}|t||kDr td|S#t$r t|wxYw)z7helper function to get and check command line argumentsrrk)r2r3r rR) args_listexpected_size_aftermsgvalues rpop_argr`sV# a &3y>rs$& 6>:i9h$h\E$mE$P#'#2 M 7 ,-*.* &' ( &'(r