U k&p[1]ã@sÆddlmZddlZddlZddlZddlZddlZzddlmZWn ek rdddl mZYnXddl Z ddl Z ddl Z ddl Z ddlZGdd„deƒZGdd„dejjƒZGdd „d eƒZdS) é)Úunicode_literalsN)ÚStringIOc@s eZdZdZdd„Zdd„ZdS)Ú AppExceptionzâBase class for application specific exceptions. Any exceptions that are subclasses of this one get printed as nice errors to the user. Any other exceptions cause a Python stack trace to be written to stderr. cCst |¡||_dS©N)Ú ExceptionÚ__init__Úmsg©Úselfr©r ú,/usr/lib/python3/dist-packages/cliapp/app.pyr.s zAppException.__init__cCs|jSr)r©r r r r Ú__str__2szAppException.__str__N)Ú__name__Ú __module__Ú __qualname__Ú__doc__rrr r r r r$src@s"eZdZdZddd„Zdd„ZdS) Ú LogHandlerz;Like RotatingFileHandler, but set permissions of new files.é€cOs"||_tjjj||f|ž|ŽdSr)Ú_permsÚloggingÚhandlersÚRotatingFileHandlerr)r ÚfilenameÚpermsÚargsÚkwargsr r r r:s ÿÿzLogHandler.__init__cCsDtj |j¡s6tjtjB}t |j||j¡}t |¡t j j   |¡Sr) ÚosÚpathÚexistsZ baseFilenameÚO_CREATÚO_WRONLYÚopenrÚcloserrrÚ_open)r ÚflagsÚfdr r r r$?s   zLogHandler._openN)r)rrrrrr$r r r r r6s rc@s¼eZdZdZdfdd„Zdd„Zdejdej fdd „Z d d „Z d d „Z dejej fdd„Z dd„Zdgdd„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd „Zd!d"„Zd#d$„Zd%d&„Zdhd'd(„Zd)d*„Zdid+d,„Zd-d.„Zd/d0„Zd1d2„Zd3d4„Zd5d6„Z d7d8„Z!d9d:„Z"d;d<„Z#d=d>„Z$d?d@„Z%dAdB„Z&dCdD„Z'dEdF„Z(dGdH„Z)dIdJ„Z*dKdL„Z+dMdN„Z,djdOdP„Z-dQdR„Z.dSdT„Z/dUdV„Z0dWdX„Z1dkdZd[„Z2ej3fd\d]„Z4d^d_„Z5d`da„Z6dbdc„Z7ddde„Z8dS)lÚ ApplicationaA framework for Unix-like command line programs. The user should subclass this base class for each application. The subclass does not need code for the mundane, boilerplate parts that are the same in every utility, and can concentrate on the interesting part that is unique to it. To start the application, call the `run` method. The ``progname`` argument sets tne name of the program, which is used for various purposes, such as determining the name of the configuration file. Similarly, ``version`` sets the version number of the program. ``description`` and ``epilog`` are included in the output of ``--help``. They are formatted to fit the screen. Unlike the default behavior of ``optparse``, empty lines separate paragraphs. Nú0.0.0cCs´d|_d|_d|_||_t|dƒs(d|_t|dƒs8i|_i|_i|_t ƒ|_ |  ¡D]}|  |¡}t ||ƒ|j|<qTtj|||j|j|d|_d|_t |j¡|_t ¡d|_dS)NrÚ arg_synopsisz [FILE]...Ú cmd_synopsis)ÚusageÚ descriptionÚepilogÚpluginséÿÿÿÿ)ÚfilenoÚ global_linenoÚlinenoÚ _descriptionÚhasattrr)r*Ú subcommandsÚsubcommand_aliasesÚsetÚhidden_subcommandsÚ_subcommand_methodnamesÚ_unnormalize_cmdÚgetattrÚcliappZSettingsÚ _format_usageÚ_format_descriptionÚsettingsÚ plugin_subdirZMemoryProfileDumperÚmemory_profile_dumperrÚtimesZ_started)r ÚprognameÚversionr,r-Z method_nameÚcmdr r r r_s,    ýzApplication.__init__cCsdS)z"Add application specific settings.Nr r r r r Ú add_settings}szApplication.add_settingsc s”|dkrtjn|}‡‡‡‡fdd„}ˆjjdkrH|rHtj |d¡ˆj_dˆ ˆjj¡}tj  |d¡}|rŠddl }|  dt ƒt ƒ|¡n|ƒdS)zRun the application.NcsˆjˆˆˆddS)N)rÚstderrÚlog)Ú_runr ©rrHr rGr r Úrun_it†szApplication.run..run_itrz %s_PROFILEÚzrun_it())ÚsysÚargvr?rCrrÚbasenameÚenvnameÚenvironÚgetÚcProfileZrunctxÚglobalsÚlocals) r rrGZsysargvrHrKrPZprofnamerSr rJr Úrun€szApplication.runcsJtj |¡}d|kr"| d¡d}d‰ˆˆ ¡7‰d ‡fdd„|Dƒ¡S)z=Create an environment variable name of the name of a program.Ú.rZ$abcdefghijklmnopqrstuvwxyz0123456789rLc3s"|]}|ˆkr| ¡ndVqdS)Ú_N)Úupper©Ú.0Úx©Úokr r Ú sz&Application.envname..)rrrOÚsplitrYÚjoin)r rCrOr r]r rP“s   zApplication.envnamec CsRd}t ¡dkrNtj |¡rNtdddƒ }| |jjdd…  ¡¡W5QRXdS)Nz/proc/self/commZLinuxÚwbré) ÚplatformÚsystemrrrr"Úwriter?rCÚencode)r ZcommÚfr r r Ú_set_process_nameŸszApplication._set_process_namec CsŠzÈ| ¡| ¡| ¡| ¡| ¡|jr8| ¡|dkrNtjdd…n|}|j |dd|j   ¡|  |¡}|  ¡|  ¡|j dr¢t|j ddƒ|_ntj|_| |¡| ¡| ¡Wn¦tjk r }z | dt|ƒ¡t d¡W5d}~XYndtjk rN}z | dt|ƒ¡t d¡W5d}~XYn"tk rš}z,|t ¡ƒ| dt|ƒ¡t d¡W5d}~XYnÖtk r}z^|jdk ræt|jƒt kræ|t|ƒƒ| dt|ƒ¡t t|jƒt kr|jnd¡W5d}~XYnXt!k rF}zt d¡W5d}~XYn*t"k r´}zP|j#t#j$kr||j%dkr|t d¡|t ¡ƒ| dt|ƒ¡t d¡W5d}~XYn¼t&k r(}zV|t ¡ƒt'|dƒrþ|j%rþ| d |j%|j(f¡n| d|j(¡t d¡W5d}~XYnHt)k rn}z(|t ¡ƒ| t ¡¡t d¡W5d}~XYnXt* +d |j j,|j j-¡dS) NéT)Ú configs_onlyÚoutputÚwz ERROR: %s éÿrzERROR: %s: %s z%s version %s ends normally).rirFÚsetup_plugin_managerÚsetupÚenable_pluginsr5Úadd_default_subcommandsrMrNÚ parse_argsr?Z load_configsÚ setup_loggingÚ log_configr"rlÚstdoutÚ process_argsÚcleanupÚdisable_pluginsr<ZUnknownConfigVariablerfÚstrÚexitZMalformedYamlConfigrÚ tracebackÚ format_excÚ SystemExitÚcodeÚtypeÚintÚKeyboardInterruptÚIOErrorÚerrnoZEPIPErÚOSErrorr4ÚstrerrorÚ BaseExceptionrÚinforCrD)r rrGrHÚer r r rI¥st      2    þzApplication._runcCsdS)aVCompute setting values after configs and options are parsed. You can override this method to implement a default value for a setting that is dependent on another setting. For example, you might have settings "url" and "protocol", where protocol gets set based on the schema of the url, unless explicitly set by the user. So if the user sets just the url, to "http://www.example.com/", the protocol would be set to "http". If the user sets both url and protocol, the protocol does not get modified by compute_setting_values. Nr )r r?r r r Úcompute_setting_valuesïsz"Application.compute_setting_valuesFcCs@||jkr<||j|<||j|<|p$g|j|<|r<|j |¡dS)afAdd a subcommand. Normally, subcommands are defined by add ``cmd_foo`` methods to the application class. However, sometimes it is more convenient to have them elsewhere (e.g., in plugins). This method allows doing that. The callback function must accept a list of command line non-option arguments. N)r5r*r6r8Úadd)r ÚnameÚfuncr)ÚaliasesZhiddenr r r Úadd_subcommandýs    zApplication.add_subcommandcCs4d|jkr| d|j¡d|jkr0| d|j¡dS)NÚhelpzhelp-all)r5rrÚhelp_allr r r r rrs  z#Application.add_default_subcommandscOs tj||ŽS)a«Return class to format subcommand documentation. The class will be used to format the full docstring of a subcommand description, but not other help texts. The class must have a compatible interface with cliapp.TextFormat. This method exists for those applications who want to change how help texts are formatted, e.g., to allow Markdown or reStructuredText. )r<Ú TextFormat)r ÚaÚkwr r r Úget_subcommand_help_formattersz)Application.get_subcommand_help_formattercCsd|jj||j|fS)Nzusage: %s %s %s)r?rCr*©r rEr r r Úget_subcommand_usage)sÿz Application.get_subcommand_usagec Csâzttj dd¡ƒ}Wntk r.d}YnX|rˆ|d}||jkrTt d|¡‚| |¡}|j |d}|  |  |¡¡}d||f}n6|j |d}tj |d}|  |j|d¡}d||f}|jj | d ¡¡}|j |¡dS) NZCOLUMNSZ78éNrzUnknown subcommand %s)Úwidthz%s %s)Úshow_allz%prog)rrrQrRÚ ValueErrorr5r<rÚ_format_usage_forr•ÚformatÚ_format_subcommand_helpr=r’r>r?rCrar`rlrf) r rršr™rEr+Úfmtr,Útextr r r Ú _help_helper-s(       ÿ zApplication._help_helpercCs| |d¡dS)z Print help.FN©r¡©r rr r r rEszApplication.helpcCs| |d¡dS)z)Print help, including hidden subcommands.TNr¢r£r r r r‘IszApplication.help_allcs‡fdd„tˆƒDƒS)Ncs*g|]"}| d¡rt tˆ|ƒ¡r|‘qS)Úcmd_)Ú startswithÚinspectZismethodr;rZr r r Ú Ns þz7Application._subcommand_methodnames..)Údirr r r r r9Ms ÿz#Application._subcommand_methodnamescCsd| dd¡S)Nzcmd_%sú-rX)Úreplacer–r r r Ú_normalize_cmdRszApplication._normalize_cmdcCs&| d¡st‚|tdƒd… dd¡S)Nr¤rXr©)r¥ÚAssertionErrorÚlenrª)r Úmethodr r r r:UszApplication._unnormalize_cmdcCsp|jrhg}d}t|jƒD]D}ts*||jkr|j |d¡p:d}| d|||f¡dt|ƒ}qd |¡SdSdS)z0Format usage, possibly also subcommands, if any.zUsage:rLz%s %%prog [options] %s %sú Ú N) r5ÚsortedÚallr8r*rRÚappendr­ra)r ršÚlinesÚprefixrErr r r r=Ys ÿ zApplication._format_usagecCs|j |d¡pd}d||fS)NrLzUsage: %%prog [options] %s %s)r*rR)r rErr r r rœhszApplication._format_usage_forcCs^|jrTg}t|jƒD]"}|s&||jkr| | |¡¡qd |¡}d|jpLd|fS|jSdS)z9Format OptionParser description, with subcommand support.rLz%s %sN)r5r±r8r³Ú_format_subcommand_summaryrar3)r ršZ summariesrEZcmd_descr r r r>ls zApplication._format_descriptioncCs>|j|}|jpd}| ¡}|r.|d ¡}nd}d||fS)NrLrz* %%prog %s: %s )r5rÚ splitlinesÚstrip)r rEr®Údocr´Zsummaryr r r r¶xs  z&Application._format_subcommand_summarycCsN|j|}|jpd}| dd¡}t|ƒdkr0|S|\}}|dt |¡SdS)NrLr°rj)r5rr`r­ÚtextwrapÚdedent)r rEr®r¹ÚtÚfirstÚrestr r r rž‚s    z#Application._format_subcommand_helpcCs¶|jd}tjtjtjtjtjtjdœ}| |tj¡}|jddkrN|  ¡}nH|jddkrf|  ¡}n0|jdrˆ|jddkrˆ|  ¡}n|  ¡}tj}t  ¡}| |¡| |¡dS)zSet up logging.z log-level)ÚdebugrˆZwarningÚerrorÚcriticalZfatalrHZsyslogrGZnoneN)r?rÚDEBUGÚINFOZWARNINGZERRORZCRITICALZFATALrRÚ setup_logging_handler_for_syslogÚ setup_logging_handler_for_stderrÚsetup_logging_handler_for_fileÚsetup_logging_handler_to_noneZ getLoggerZ addHandlerZsetLevel)r Z level_nameZlevelsÚlevelÚhandlerZloggerr r r rtŒs( ú    zApplication.setup_loggingcCs$tjjdd}| ¡}| |¡|S)z.Setup a logging.Handler for logging to syslog.z/dev/log)Zaddress)rrZ SysLogHandlerÚ"setup_logging_formatter_for_syslogÚ setFormatter©r rÉÚ formatterr r r rÄ©s z,Application.setup_logging_handler_for_syslogcCs&d |jj d¡¡}|d}t |¡S)z%Setup a logging.Formatter for syslog.z%%ú%z: %(levelname)s %(message)s)rar?rCr`rÚ Formatter)r rCrŸr r r rʲsz.Application.setup_logging_formatter_for_syslogcCst ¡}| ¡}| |¡|S)z.Setup a logging.Handler for logging to stderr.)rZ StreamHandlerÚ"setup_logging_formatter_for_stderrrËrÌr r r rŸs z,Application.setup_logging_handler_for_stderrcCsd}t |¡S)z%Setup a logging.Formatter for stderr.z%(levelname)s %(message)s©rrÏ)r rŸr r r rÐÁsz.Application.setup_logging_formatter_for_stderrcCsFt|jdt|jddƒ|jd|jddd}| ¡}| |¡|S)z4Setup a logging handler for logging to a named file.rHzlog-modeézlog-maxzlog-keepF)rZmaxBytesZ backupCountZdelay)rr?rÚ setup_logging_formatter_for_filerËrÌr r r rÆÆsû z*Application.setup_logging_handler_for_filecCsd}d}t ||¡}|S)z0Setup a logging.Formatter for logging to a file.ú%%(asctime)s %(levelname)s %(message)sú%Y-%m-%d %H:%M:%SrÑ)r rŸZdatefmtrÍr r r rÓÓs z,Application.setup_logging_formatter_for_filecCst d¡}|S)zr¶ržrtrÄrÊrÅrÐrÆrÓrÇrÖr×rurärorqryrsrprxrwrærìrêrçrírïrñròr r r r r'Gspÿ ÿ  Jÿ             r')Z __future__rr„r¦rZlogging.handlersrrÚ ImportErrorÚiorMr|rdrºr<rrrrrÚobjectr'r r r r Ús"