a 7a͂@sdZddlmZmZddlmZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlmZmZddlmZmZmZmZmZmZddlmZmZmZmZmZmZmZm Z m!Z!m"Z"dd l#m$Z$dd l%m&Z&dd l'm(Z(m)Z)dd l*m+Z+d ,Z-d,Z.e/e dsdge _0dZ1e j23ddZ4e45dvr>dZ6n e45dvrRdZ6n e7de4ddZ8Gddde9Z:Gdddej;ZZ?e=j@ZAd%d d!ZBd"d#ZCeDd$kre=EdS)&z,A base class for a configurable application.) defaultdict OrderedDict)deepcopyN) ConfigurableSingletonConfigurable)KVArgParseConfigLoaderPyFileConfigLoaderConfig ArgumentErrorConfigFileNotFoundJSONFileConfigLoader) BoolUnicodeListEnumDictInstance TraitErrorobserveobserve_compatdefault) import_item cast_unicode)indentwrap_paragraphs)dedentz The options below are convenience aliases to configurable class-options, as listed in the "Equivalent to" description-line of the aliases. To see all configurable class-options for some , use: --help-all z The command-line option below sets the respective configurable class-parameter: --Class.parameter=value This line is evaluated in Python, so simple expressions are allowed. For instance, to set `C.a=[0,1,2]`, you may type this: --C.a='range(3)' argvzp Subcommands are launched as `{app} cmd [args]`. For information on using subcommand 'cmd', do: `{app} cmd -h`. -TRAITLETS_APPLICATION_RAISE_CONFIG_FILE_ERROR>true1T>rZfalse0FzUnsupported value for environment variable: 'TRAITLETS_APPLICATION_RAISE_CONFIG_FILE_ERROR' is set to '%s' which is none of {'0', '1', 'false', 'true', ''}.cstfdd}|S)aMethod decorator for catching invalid config (Trait/ArgumentErrors) during init. On a TraitError (generally caused by bad config), this will print the trait's message, and exit the app. For use on init methods, to prevent invoking excepthook on invalid input. c snz|g|Ri|WSttfyh}z4|jd||jd|j|dWYd}~n d}~00dS)Nz0Bad config encountered during initialization: %szConfig at the time: %s)rr logZfataldebugconfigexit)appargskwargsemethod;lib/python3.9/site-packages/traitlets/config/application.pyinnerUs z!catch_config_error..inner) functoolswraps)r.r1r/r-r0catch_config_errorMsr4c@s eZdZdS)ApplicationErrorN)__name__ __module__ __qualname__r/r/r/r0r5`sr5cs*eZdZdZejZdZfddZZ S)LevelFormattera Formatter with additional `highlevel` record This field is empty if log level is less than highlevel_limit, otherwise it is formatted with self.highlevel_format. Useful for adding 'WARNING' to warning messages, without adding 'INFO' to info, etc. z %(levelname)s |cs2|j|jkr|j|j|_nd|_tt||S)Nr)Zlevelnohighlevel_limithighlevel_format__dict__Z highlevelsuperr9format)selfrecord __class__r/r0r>ps zLevelFormatter.format) r6r7r8__doc__loggingWARNr:r;r> __classcell__r/r/rAr0r9dsr9cseZdZdZedZedZeeZeeZee Z e Z e Z eZgZdsddZedZeZeeZedejd d jd d Zed eddZeZ edddjd d Z!edddjd d Z"eddeddZ#e$dddZ%ddiZ&dd ej'iidfddd iid fdd!d iid"fd#Z(e)Z*e+d$d d%Z,eeZ-e+e.d&id'dZ/eZ0ed(djd d Z1ed)djd d Z2ed!d*d+Z3edd,d-Z4d.d/Z5ed0efd1d2Z6e7dtd3d4Z8d5d6Z9d7d8Z:d9d:Z;d;d<ZZ=d?d@Z>dAdBZ?dCdDZ@dEdFZAdGdHZBdIdJZCdudLdMZDdvdNdOZEdPdQZFdRdSZGdTdUZHdVdWZIdXdYZJdZd[ZKe7dwd\d]ZLd^d_ZMd`daZNe7dxdbdcZOePdydddeZQeRdfdgZSe7dzdhdiZTd{djdkZUd|dldmZVd}dodpZWePd~dqdrZXZYS) Applicationz8A singleton application with full configuration support.Z applicationzThis is an application.NccsV|dur|j}t}|D]8}t|D]&}t|tr(||vr(|||Vq(qdS)aIterate through configurable classes, including configurable parents :param classes: The list of classes to iterate; if not set, uses :attr:`classes`. Children should always be after parents, and each class should only be yielded once. N)classessetreversedmro issubclassradd)r?rHseencparentr/r/r0_classes_inc_parentss  z Application._classes_inc_parentsz0.0) r (2DEBUGINFOrEZERRORZCRITICALz#Set the log level by value or name.)Z default_valuehelpTr' log_levelcCs0|j}t|tr tt|}||_|j|dS)z+Adjust the log level when log_level is set.N)new isinstancestrgetattrrDr[r%setLevel)r?changer\r/r/r0_log_level_changeds   zApplication._log_level_changedz%Y-%m-%d %H:%M:%Sz:The date format used by logging formatters for %(asctime)s)rYz#[%(name)s]%(highlevel)s %(message)szThe Logging format template log_datefmt log_formatcCsF|}|s&td|jdtdS|j|j|jd}||dS)z0Change the log formatter when log_format is set.zNo Handler found on z(, setting log_format will have no effectNZfmtZdatefmt) Z_get_log_handlerwarningswarnr%RuntimeWarning_log_formatter_clsrdrc setFormatter)r?ra _log_handler_log_formatterr/r/r0_log_format_changeds zApplication._log_format_changedr%cCst|jj}||jd|_|}|rD|jr2|S|js|g|j|_n|jd|jdS)Nr)r__init__rBrHinsert)r?r+clsr/r/r0r6s   zApplication.__init__r'cs$tt|||jd|jdS)NzConfig changed: %r)r=rG_config_changedr%r&r\rzrAr/r0rBszApplication._config_changedcCs||dS)zMDo the basic steps to configure me. Override in subclasses. N)parse_command_line)r?rr/r/r0 initializeHszApplication.initializecCs|jdur|jSdS)zAStart the app mainloop. Override in subclasses. N)subappr|r?r/r/r0r|Qs zApplication.startc Cs|j}|jD]0}|j|vr||j}|dd|ddq|jrrtj|t j ddt dt j ddS|j rtd|j D]}td |qtt|D]Z}||}|sqt|td dd }t|D]*}||} td |tj| fi|qqdS) z,start function used when show_config is TruerwNrxr$T)rZ sort_keysr zLoaded config files:z )rZcompactz .{} = {})r'copyrBrKr6poprxjsondumprpstdoutreprwrite_loaded_config_filesprintsorteddictr>pprintZpformat) r?r'rZ cls_configf classnameZ class_configZpformat_kwargs traitnamevaluer/r/r0r}Ys:          zApplication.start_show_configcCstd|dS)z"Print the alias parts of the help.rN)rjoinemit_alias_helprr/r/r0print_alias_help~szApplication.print_alias_helpc cs^|js dSi}|jD]$}|ddD]}|||j<q(q|jD]\}}zt|trd|\}}nd}|ddd\}}|d|}||}|jdd|} |j | |d }t|ts|f}t |t d}d d d |D}|d d |||d <|D] } | Vqtd|VWqDtyV} z|jd|| WYd} ~ qDd} ~ 00qDdS)z+Yield the lines for alias part of the help.N.TrZ)Zhelptextkey, css&|]}t|dkrdnd|VqdSr$z--%sz-%sNlen.0mr/r/r0 sz.Application.emit_alias_help..r--zEquivalent to: [--%s]z7Failed collecting help-message for alias %r, due to: %s)aliasesrHrKr6itemsr]tuplesplitZ class_traitsZclass_get_trait_help splitlinesrrrreplacer Exceptionr%error) r? classdictrrOaliaslongnamefhelprrtraitlexr/r/r0rs>        zApplication.emit_alias_helpcCstd|dS)z Print the flag part of the help.rN)rremit_flag_helprr/r/r0print_flag_helpszApplication.print_flag_helpc cs|js dS|jD]\}\}}zzt|ts2|f}t|td}ddd|D}|Vtt| Vddd|D}d|}tt|VWqt y}z|j d ||WYd}~qd}~00qdS) z.Yield the lines for the flag part of the help.Nrrcss&|]}t|dkrdnd|VqdSrrrr/r/r0rsz-Application.emit_flag_help.. css2|]*\}}|D]\}}d|||fVqqdS)z --%s.%s=%sN)r)rZclnameZ props_dictZpropvalr/r/r0rszEquivalent to: [%s]z6Failed collecting help-message for flag %r, due to: %s) flagsrr]rrrrrrstriprr%r)r?rZcfgrZcfg_listZcfg_txtrr/r/r0rs,    zApplication.emit_flag_helpcCstd|dS)z#Print the options part of the help.rN)rremit_options_helprr/r/r0 print_optionsszApplication.print_optionsccsv|js|jsdSd}|Vdt|Vt|jD]}|VdVq2|D] }|VqL|D] }|Vq`dVdS)z1Yield the lines for the options part of the help.NZOptions=r)rrrroption_descriptionrr)r?headerprr/r/r0rs   zApplication.emit_options_helpcCstd|dS)z&Print the subcommand part of the help.rN)rremit_subcommands_helprr/r/r0print_subcommandsszApplication.print_subcommandsccs|js dSd}|Vdt|Vt|jj|jdD]}|VdVq6|jD](\}\}}|V|rRtt| VqRdVdS)z4Yield the lines for the subcommand part of the help.NZ Subcommandsr)r)r) subcommandsrrsubcommand_descriptionr>namerrrr)r?rrsubcrrYr/r/r0rs z!Application.emit_subcommands_helpccs|sdVdVdS)zzYield the very bottom lines of the help message. If classes=False (the default), print `--help-all` msg. z5To see all available configurables, use `--help-all`.rNr/r?rHr/r/r0emit_help_epilogueszApplication.emit_help_epilogueFcCstd|j|ddS)zPrint the help for each Configurable class in self.classes. If classes=False (the default), only flags and aliases are printed. rrHN)rr emit_helprr/r/r0 print_helpszApplication.print_helpccs|D] }|Vq|D] }|Vq|D] }|Vq0|r|}|rtdVdVt|jD]}|VdVqb|D]}|VdVqx|D] }|Vq||D] }|VqdS)zYield the help-lines for each Configurable class in self.classes. If classes=False (the default), only flags and aliases are printed. z Class optionsz =============rN) emit_descriptionrr_classes_with_config_traitsrkeyvalue_descriptionZclass_get_help emit_examplesr)r?rHrZ help_classesrrr/r/r0rs*     zApplication.emit_helpcCsddd|DS)zwGenerate rST format documentation for the config options this application Returns a multiline string. rcss|]}|VqdSry)Zclass_config_rst_doc)rrOr/r/r0r%sz6Application.document_config_options..)rrQrr/r/r0document_config_options s z#Application.document_config_optionscCstd|dS)z"Print the application description.rN)rrrrr/r/r0print_description(szApplication.print_descriptionccs&t|jp |jD]}|VdVqdS)z-Yield lines with the application description.rN)r descriptionrC)r?rr/r/r0r,szApplication.emit_descriptioncCstd|dS)z2Print usage and examples (see `emit_examples()`). rN)rrrrr/r/r0print_examples2szApplication.print_examplesccs6|jr2dVdVdVtt|jVdVdS)zYield lines with the usage and examples. This usage string goes at the end of the command line help string and should contain examples of the application's usage. ZExamplesz--------rN)examplesrrrrr/r/r0r6s zApplication.emit_examplescCst|jdS)zPrint the version string.N)rversionrr/r/r0 print_versionCszApplication.print_versioncCs|j|\}}t|tr"t|}t|trPt|trP|j |j |d|_ n t |rd|||_ n t d||j |dS)z"Initialize a subcommand with argv.)rPz%Invalid mappings for subcommand '%s'!N)rgetr]r^rtyperLrGrBZclear_instanceinstancercallableAssertionErrorr)r?rrr_r/r/r0initialize_subcommandGs    z!Application.initialize_subcommandcCsftt}|jD]0}|j}|ddD]}||j|q(qi}|jD]r\}}t|t rh|\}}| dd\}} ||} t | dkr| d}t|t s|f}|D]} d || g|| <qqNi} |j D]\} \}}i}|D]H\}}||} t | dkr| d}||vr(|||q|||<qt| t sD| f} | D]}||f| |<qHq| |fS)aFlatten flags and aliases for loaders, so cl-args override as expected. This prevents issues such as an alias pointing to InteractiveShell, but a config file setting the same trait in TerminalInteraciveShell getting inappropriate priority over the command-line arg. Also, loaders expect ``(key: longname)`` and not ````key: (longname, help)`` items. Only aliases with exactly one descendent in the class list will be promoted. r$rrr)rlistrHr6rKappendrrr]rrrrrupdate)r?Zmro_treerZclsnamerPrrrrrZchildrenZalrrZflagdictrYZnewflagZsubdictkr/r/r0 flatten_flags^s@       zApplication.flatten_flagscCst|||||jdS)N)rHr%)rr%)r?rrrrHr/r/r0_create_loaders zApplication._create_loadercst|trJ|dur$tjddn|}dd|D|_|rZ|ddkrZ|dddg}|jrt|dkr|d|dd}}td|r||jvr|||Sz|d| d Wnt y|Yn0t fd d d Dr| d v| ddvsdvr(|| d|\}}t|}|j||||d}zt||_WntyzYn0||j|j|_dS)z!Parse the command line arguments.Nr$cSsg|] }t|qSr/r)rargr/r/r0 z2Application.parse_command_line..rrY-hz ^\w(\-?\w)*$rc3s|]}|vVqdSryr/)rxZinterpreted_argvr/r0rrz1Application.parse_command_line..)r --help-allz--helprz --versionz-Vr)r]r^rprrrrematchrindex ValueErroranyrr(rrrrrr load_config cli_config SystemExit update_config extra_args)r?rrZsubargvrrrHloaderr/rr0rs8        zApplication.parse_command_linec csXt|ts|g}|dddD]2}|j|d||d}|rR|d||pNt|j|d||d}g}g}||fD]} d} z | } WnFtyYnHt y| j p|} |r|r|j d| dd Yn0|r|d | j | rvt ||D]:\} } | | } | r|r|d | | j tj| d d q| | j fV|| || j qvqdS)zeLoad config files (py,json) by filename and path. yield each config object in turn. Nz.py)pathr%zLooking for %s in %sz.jsonz&Exception while loading config file %sT)exc_infozLoaded config file: %szMCollisions detected in {0} and {1} config files. {1} has higher priority: {2}r)r)r]rpython_config_loader_classr&rtgetcwdjson_config_loader_classrr rZ full_filenamerzip collisionsZwarningr>rdumpsr)rZ basefilenamerr%raise_config_file_errorsZpyloaderZ jsonloaderZloaded filenamesrr'filenameZearlier_configrr/r/r0_load_config_filessF          zApplication._load_config_filescCs|jddS)z$Currently loaded configuration filesN)rrr/r/r0loaded_config_filesszApplication.loaded_config_filescCsptj|\}}t}|j|||j|jdD](\}}||||jvr,|j |q,||j | |dS)z'Load config files by filename and path.)rr%rN) rtrsplitextr rr%rmergerrrr)r?rrextZ new_configr'r/r/r0load_config_files    zApplication.load_config_filec#s|dur|j}tdd||Dfdd}tfddD|kr2q`q2D]\}}|rh|VqhdS)a Yields only classes with configurable traits, and their subclasses. :param classes: The list of classes to iterate; if not set, uses :attr:`classes`. Thus, produced sample config-file will contain all classes on which a trait-value may be overridden: - either on the class owning the trait, - or on its subclasses, even if those subclasses do not define any traits themselves. Ncss"|]}|t|jddfVqdS)TrZN)boolZclass_own_traits)rrr/r/r0r#sz:Application._classes_with_config_traits..cstfdd|jDS)Nc3s|]}|vo|VqdSryr/)rb cls_to_configr/r0r(rzZApplication._classes_with_config_traits..is_any_parent_included..)r __bases__)rrr/r0is_any_parent_included'szGApplication._classes_with_config_traits..is_any_parent_includedc3s"|]\}}||p|fVqdSryr/)rrinc_yes)rr/r0r/s)rHrrQrr)r?rHZ to_incl_origZclrr/)rrr0rs  z'Application._classes_with_config_traitscCsZd|jg}|d|dur$|jn|}t||}|D]}|||q:d|S)z/generate default config file from Configurablesz# Configuration file for %s.rNr)rrrHrrZclass_config_sectionr)r?rHlinesZconfig_classesrr/r/r0generate_config_file8s  z Application.generate_config_filercCs |jd|jt|dS)NzExiting application: %s)r%r&rrpr()r? exit_statusr/r/r0r(BszApplication.exitcKs&|jfi|}|||dS)zLaunch a global instance of this Application If a global instance already exists, this reinitializes and starts it N)rrr|)rrr+r)r/r/r0launch_instanceFs zApplication.launch_instance)N)N)F)F)N)N)NNF)N)N)N)r)N)Zr6r7r8rCrrrrrrrrr rrrHrQrrrr r rrrDrEtagr[rrrbr9rircrdrmrrvrrWrrrrrrr rrrwrxr{r~rrr4rr|r}rrrrrrrrrrrrrrrrrrrrr classmethodrpropertyrr rrr(rrFr/r/rAr0rGxs          %(    ; 0 /   & rGcCsV|p d|}|pd|}|d\}}||dii}||dii}|||fd|||fiS)aHelper for building basic --trait, --no-trait flags. Parameters ---------- name : str The name of the flag. configurable : str The 'Class.trait' string of the trait to be set/unset with the flag set_help : unicode help string for --name flag unset_help : unicode help string for --no-name flag Returns ------- cfg : dict A dict with two keys: 'name', and 'no-name', for setting and unsetting the trait, respectively. z set %s=Truez set %s=FalserTFzno-)r)rZ configurableZset_helpZ unset_helprrsetterZunsetterr/r/r0 boolean_flagWs     rcCstrtjStSdS)z|Get the config object for the global Application instance, if there is one otherwise return an empty config object N)rGZ initializedrr'r r/r/r/r0 get_configvs r__main__)rr)FrC collectionsrrrrr2rrDrtrrrprfZtraitlets.config.configurablerrZtraitlets.config.loaderrrr r r r Ztraitlets.traitletsr rrrrrrrrrZutils.importstringrZutilsrZtraitlets.utils.textrrtextwraprrrrhasattrrrenvironrZ_envvarlowerr rr4rr5Z Formatterr9rGrZdefault_aliasesrZ default_flagsrrr6rr/r/r/r0sV  0      a