ce{ dZddlZddlZddlZddlZddlZddlZddlZ ddl m Z ddl m Zddl mZddlZddlmZddlZddlmZddlmZddlZej:eZdgZ ejBd d ejDd d ddejFdddejHdddejHdddejBdddgddgZ%d Z&d!Z'e(d"e)d#e*d$iZ+d%Z,Gd&d'Z-d(Z.d)Z/d*Z0d+Z1d,Z2d-Z3d.Z4d/Z5d0Z6d1Z7d2Z8d3Z9d4Z:d5Z;d6Zed9k(re>yy#e$r ddlZdZYwxYw);zSample configuration generator Tool for generating a sample configuration file. See ../doc/source/cli/generator.rst for details. .. versionadded:: 1.4 N)core)nodes)roles)cfg)_messageDEFAULTz output-filez1Path of the file to write to. Defaults to stdout.)helpz wrap-widthFz!The maximum length of help lines.)defaultminr namespaceTzHOption namespace under "oslo.config.opts" in which to query for options.)requiredr minimalFz*Generate a minimal required configuration.)r r summarizezaOnly output summaries of help text to config files. Retain longer help text for Sphinx documents.formatzDesired format for the output.ini))rz;The only format that can be used directly with oslo.config.)jsonz_Intended for third-party tools that want to write config files based on the sample config data.)yamlz Same as json)rstzzCan be used to dump the text given to Sphinx when building documentation using the Sphinx extension. Useful for debugging,format_)r r choicesdestc.|jty)a Register the formatter's CLI options with a ConfigOpts instance. Note, this must be done before the ConfigOpts instance is called to parse the configuration. :param conf: a ConfigOpts instance :raises: DuplicateOptError, ArgsAlreadyParsedError N)register_cli_opts_generator_opts)confs 7/usr/lib/python3/dist-packages/oslo_config/generator.pyrras ?+c t|tjr9|j|j}nC|jsdg}n2|j}n$|jt |j}n|jd}nt|tj tjtjtjtjtjtjtjtjf rt |j}nDt|tjr%t |jj!}nt|tj"tj$tj&fr#dj)d|jD}nt|tj*r[t-|jj/t1j2d}dj)|Dcgc]}d|z c}}n4t4j7dt9|t |j}|g}g}|D]F}t|t s t |}|j;|k7rd |z}|j=|H|Scc}w) z*Return a list of formatted default values.,c32K|]}t|ywNstr).0ds r z#_format_defaults..s"?a3q6"?srkeyz%s:%szUnknown option type: %sz"%s") isinstancer MultiStrOptsample_defaultr r&StrOptIntOptFloatOptIPOptPortOpt HostnameOptHostAddressOptURIOptOptBoolOptlowerListOpt_ConfigFileOpt _ConfigDirOptjoinDictOptsorteditemsoperator itemgetterLOGwarningreprstripappend)optdefaults default_str sorted_itemsiresultss r_format_defaultsrNms#s'    )))HtH{{H    )c001K [[ "K cjj#**cllCII!kk3??CL((#FAGaK#FGK KK149 =ckk*K=G$ +s+k*K    + - ;.K{# $ N$Gs- Kz string valuez integer valuezfloating point valuecl |jS#t$rYnwxYw t|S#t$rYywxYw)z3Format the type name to use in describing an optionz unknown value) type_nameAttributeError _TYPE_NAMESKeyError)opt_types r_format_type_namerUsJ !!!     8$$    s  ' 33c<eZdZdZd dZdZdZdZdZdZ d Z y) _OptFormatterz3Format configuration option descriptions to a file.NcP|xstj|_|jxsd|_|j|_|j |_t rtjjD]1\}}tj||}tj||3tjjD]\}}tj||dD]<}tj|tj}tj||>yy)zConstruct an OptFormatter object. :param conf: The config object from _generator_opts :param output_file: a writeable file object i)zoslo.config:optionzoslo.config:groupN)sysstdout output_file wrap_widthrrrst2txt sphinx_rolesgeneric_docrolesr@docutils_roles GenericRoleregister_local_rolespecific_docrolesdocutils_nodesstrong)selfrr[rolename nodeclassgenericfuncs r__init__z_OptFormatter.__init__s '4#**//0S||  '3'D'D'J'J'L F#)(44XyI228WE F#/"@"@"F"F"H C$228TB CH F(44X5C5J5JL228WE F rc trotj|tjd|jij }d}|j D]}||rd|zdzndz }|g}|S|jdkDrad}|j D]G}djtj||jdddd }||dk(rd n|z }|dz }I|g}|Sd|zdzg}|S) zyFormat the help for a group or option to the output file. :param help_text: The text of the help string r\)sourcewritersettings_overridesr #  z# rF)initial_indentsubsequent_indentbreak_long_wordsreplace_whitespace#) r] docutils_corepublish_stringWriterr\decode splitlinesr=textwrapwrap)rf help_textlineslinewrappedtexts r _format_helpz_OptFormatter._format_helps" %44 ~~'$0$//#Bfh  E!,,. ?tt+> ?GE __q G!,,. yytT__>BAE@EBG "IJ $"*3$64 IE I%,-E rc*|y|dk(ryt|S)Nr!r z''r%)rfchoices r_get_choice_textz_OptFormatter._get_choice_texts > r\6{rct|tjr=|}d|jzg}|jr'||j |jz }n|}d|zg}|j |y)zFormat the description of a group header to the output file :param group_or_groupname: a cfg.OptGroup instance or a name of group :returns: a formatted group description string z[%s] N)r,rOptGroupnamer r writelines)rfgroup_or_groupnamegroupr groupnames r format_groupz_OptFormatter.format_groupsg (#,, 7&E *+Ezz**5::66*I )*E rc  |js tjd|jt |j }d}|j r|jjdsd}|jrz|jrW|jjd}|djdjd}t|d kDr|d z }|d z }n |j}||d |d }nd|z}|j|}t|j dd4|jdj|j j t|j dd4|jdj|j j"t|j ddr}|jd|j j$D]S} |j'| d|j j$| xsd}|j)|j|U |j*r|jd|j:D]\} | j<sd| j<vs|jd| j>xs|d| j<xs |jd ^|j r|j@r|jd!|j@zn|jd"|jd#|jBr-|j)|jd$|jBz|jDr|jd%|jFr|jd&tI|j d'r1|j jK|jL|jF} n8tjOd(|j |j<d)tQ|} | D]i}|rd*|jSd d+z}|jTr"|j|jd,|d H|jd-|jd,|d k|jW|y#t,$ry} ddl} t1|t2j4s/| j7d|jd |j8d| n!| j7d|jd| Yd} ~ d} ~ wwxYw).zFormat a description of an option to the output file. :param opt: a cfg.Opt instance :param group_name: name of the group to which the opt is assigned :returns: a formatted opt description string z"%s" is missing a help stringr DEPRECATEDz DEPRECATED:  r:.z%. For more information, refer to the zdocumentation.z ()z(%s)r Nz# Minimum value: {} maxz# Maximum value: {} rz# Possible values: z - zz7# Note: This option can be changed without restarting. zIncompatible option class for z): z"Failed to fully format sample for z: -z# Deprecated group/name - [z]/rqz2# This option is deprecated for removal since %s. z)# This option is deprecated for removal. z3# Its value may be silently ignored in the future. zReason: z# Advanced Option: intended for advanced users and not used # by the majority of users, and might have a significant # effect on stability and/or performance. z# # This option has a sample default set, which means that # its actual default value may vary from the one documented # below. format_defaultszThe type for option %(name)s which is %(type)s is not a subclass of types.ConfigType and doesn't provide a 'format_defaults' method. A default formatter is not available so the best-effort formatter will be used.)typer z # z =rv),r rCrDrrUrdeprecated_for_removal startswithrsplitrstriplenrgetattrrGrr rrrextendmutablerQwarningsr,rr7warn __class__deprecated_optsrrdeprecated_sincedeprecated_reasonadvancedr.hasattrrr debugrNreplacerr)rfrH group_namerT opt_prefix_splitopt_helpr~rrerrrr(rIrJs rrz_OptFormatter.formats0xx KK7 B$SXX.  & &HH'' 5'J 88~~/!!9++C077<v;? GGH 00H88'18XFI)I!!), 388UD ) 5 LL077 E F 388UD ) 5 LL077 E F 388Y - LL/ 0((** ;))&1HH$$V,K0KKM  T..y9:  ;  /{{ N,$$ JAvv#QVV+ gg33QVV5Gsxx5GIJ  J  % %## I,,./ @B LLF H$$ %%j33H3H&HIK << LL>     LL  388. /xx// 030B0BDH IIG3884  6 (,H# DK!K$7$7i$HH || 388[AB CHHkBC  D W / c377+ XXs}}c3  "xx./! /s4R T A.TT c:|jj|y)z]Write an arbitrary string to the output file. :param s: an arbitrary string N)r[write)rfss rrz_OptFormatter.writes q!rc:|jj|y)zvWrite an arbitrary sequence of strings to the output file. :param lines: a list of arbitrary strings N)r[r)rfrs rrz_OptFormatter.writeliness ##E*rr$) __name__ __module__ __qualname____doc__rkrrrrrrrrrWrWs,=F4B B"+rrWc tj}|D]\}}||vrtj||<|D]\}}|rt|dt|}|j t vr|j }n|j }||k7r-tjd||t|dr||_ n|}|||vrtj|||<|D]}|||||j<|D cgc]6}|||D cgc]#} | t||| jf%c} f8} }} | Scc} wcc} }w)aCleanup duplicate options in namespace groups Return a structure which removes duplicate options from a namespace group. NOTE:(rbradfor) This does not remove duplicated options from repeating groups in different namespaces: :param read_opts: a list (namespace, [(group, [opt_1, opt_2])]) tuples :returns: a list of (namespace, [(group, [opt_1, opt_2])]) tuples rznormalizing group name %r to %r) collections OrderedDictrr&upperUPPER_CASE_GROUP_NAMESr9rCrDrrrlistvalues) read_optscleanr listingroptsr normalized_gnrHg cleaned_optss r _cleanup_optsrs  # # %E'8 7 E !*668E) " 8KE4$UFCJ? ##%)??$.$4$4$6M$.$4$4$6M J.KK A: -/uf-%2 -E),,*5*A*A*Ci ' 847i '1 8' 88<  #I.0eI.q188:;<0 1L  0s E (E<E E ctjjd|td}|Dcgc]}|j|j fc}Scc}w)zList the options available via the given namespaces. :param namespaces: a list of namespaces registered under 'oslo.config.opts' :returns: a list of (namespace, [(group, [opt_1, opt_2])]) tuples zoslo.config.optsF)nameson_load_failure_callbackinvoke_on_load stevedorenamedNamedExtensionManagerrrplugin) namespacesmgres r_get_raw_opts_loadersrsL // / /!9 0 C ), ,1QVVQXX  ,, ,sActjjd|z|td}|Dcgc]}|j|j fc}Scc}w)Nzoslo.config.opts.F)r rrrr)rdriver_option_namerrs r_get_driver_opts_loadersrsP // / /%(::!9 0 C ), ,1QVVQXX  ,, ,sAci}t||}|D]C\}}|jD]&\}}|j|gj|(E|S)ayList the options available from plugins for drivers based on the option. :param driver_option_name: The name of the option controlling the driver options. :param namespaces: a list of namespaces registered under 'oslo.config.opts.' + driver_option_name :returns: a dict mapping driver name to option list )rr@ setdefaultr)rrall_optsloaders plugin_nameloader driver_name option_lists r_get_driver_optsrsmH&z3EFG&E V(.(8 E $K    R 0 7 7 D EE Orctjjd|dtd}|Dcgc]}|jc}Scc}w)Nzoslo.config.opts.defaultsF)rwarn_on_missing_entrypointrr)rrrrr)rreps r_get_opt_default_updatersrsD // / /##(!9 0 C !$ $"BII $$ $sAc2t|D] }| y)z7Let application hooks update defaults inside libraries.N)r)rupdates r_update_defaultsrs+J7rc2t|}t|g}|D]\}}g}|D]\}}t|}t|tj r|j rt|j |}i} t|jD]>\} } | j| gjd| D|j| @|j| |j||f|j||ft|S)aList the options available via the given namespaces. Duplicate options from a namespace are removed. :param namespaces: a list of namespaces registered under 'oslo.config.opts' :returns: a list of (namespace, [(group, [opt_1, opt_2])]) tuples c34K|]}|jywr$)r)r'os rr)z_list_opts..)sL2'(AFFL2s)rrrr,rr driver_optionrr?r@rr_save_driver_optsrGr) rrresponser rnamespace_valuesr group_opts driver_optsdriver_opt_namesrrs r _list_optsrs7$J/GZ H$ 7 6"( 9 E:j)J%.&&"2++"#K(*$-3K4E4E4G-H0) T)33KDKKL2,0L22"))$/ 0++,<=  # #UJ$7 83 94 $456A 7B  ""rcr$r)argskwargss rrr2s rc |j|dxs|t|dtjdD]{\}}|j d|zt|tj dD]?} |j r |jsn#|j d|j||A}y#t$r>}|j d|jd|j d |dYd}~d}~wwxYw) Nobjectrrr*z # # From %s # rrqz'# Warning: Failed to format sample for rp) rr?rArBr attrgetterrrr Exceptionr)fr group_datar rrHrs r _output_optsr6sNN:h'051#J|$<(0(;(;A(>@ +D % 12$H$7$7 $CD +C +99S\\GGDMHHS%( + + +$%C)** +s:, [opt_1, opt_2])]) tuples, such as returned by _list_opts. :returns: {, {'object': , 'namespaces': [(, )]}} may be a string or a group object. is always a string. will only be set if was a group object in at least one namespace. Keying by group_name avoids adding duplicate group names in case a group is added as both an OptGroup and as a str, but still makes the additional OptGroup data available to the output code when possible. rN)rrrrr)rrrG)conf_nsgroupsr rrr is_optgrouprs r _get_groupsrHs"D; , 'name': } :param opt: The Opt object to represent as a dict. :param group: The name of the group containing opt. :param namespace: The name of the namespace containing opt. :param conf: The ConfigOpts object containing the options for the generator tool _r rrNr rrrr)rr) __dict__r@rrrrrUrrGr) rHrr rr+valueentryrdeprecated_opts r _build_entryr isC+.,,*<*<*> )JCNN3'%Z )E )"E+ uV}i.f 5 5 ; ; =>ii5=%6E%L5=%6E%L%eFm4E&MO 12""c1D1D&D  " "(..7%',,=f    /E  L3 )sDc  iiid}|jD]"\}}gdd |d|<|dD]}|dD]}|dr# j|djn jddidt|||d |} d j |t j |d D]K}|jd } |d } | j| g|d|d<||d<| | j |M d D cgc] t fd dDs d!} } | d<%t||d<|Scc} w)aCreate data structure for machine readable sample config Returns a dictionary with the top-level keys 'options', 'deprecated_options', and 'generator_options'. 'options' contains a dict mapping group names to a list of options in that group. Each option is represented by the result of a call to _build_entry. Only non-deprecated options are included in this list. 'deprecated_options' contains a dict mapping groups names to a list of opts from that group which were deprecated. 'generator_options' is a dict mapping the options for the sample config generator itself to their values. :param groups: A dict of groups as returned by _get_groups. :param conf: The ConfigOpts object containing the options for the generator tool )optionsdeprecated_optionsgenerator_optionsr )rr r rrr)dynamic_group_ownerrrrrrrr rreplacement_namereplacement_groupc38K|]}dd|vyw)rrNr)r'r(r output_groups rr)z2_generate_machine_readable_data..s,=yL$?$BB=sr standard_optsr) r@r_get_generator_datar rGcopydeepcopypopranydict)rr output_datarrr rHrr rr rnon_driver_opt_namesrs ` @r_generate_machine_readable_datars(!)+(*,K#),,.!= J "B/ -9 Iz*#L1 EI | Eh' ''"8,@@B!''/1)+')) %S*ilDIV$++E2&*mmE:K4L&MEN*..w7E)45I)J&&11%<9>vN#56:DN#67&u-44^D E E E4"&) = ,] ;== fI  )= _%C!=F(,DzK#$  s$EcVt|j}|j|S)zoslo_i18n yaml representer Returns a translated to the default locale string for yaml.safe_dump :param dumper: a SafeDumper instance passed by yaml.safe_dump :param data: a oslo_i18n._message.Message instance )r& translation represent_str)dumperdataserializedDatas ri18n_representerr$s())+,N    //rcZt||}|jdk(rYtjj t j t|jtj|dn&|jtj|d|jdy)aWrite a machine readable sample config file Take the data returned by _generate_machine_readable_data and write it in the format specified by the format_ attribute of conf. :param groups: A dict of groups as returned by _get_groups. :param output_file: A file-like object to which the data should be written. :param conf: The ConfigOpts object containing the options for the generator tool rF)default_flow_styleT) sort_keysrqN) rrr SafeDumperadd_representerrMessager$r safe_dumprdumps)rr[rrs r_output_machine_readabler-s2&$?K ||v ''(8(8:JK$..> Dd T7#  TN    xx|  s $ A::>B8__main__r$)?rrrimportlib.metadatar@rrBrArYdocutilsrrwdocutils.parsers.rstrrdrr`r]sphinxr^r1r|rr0r oslo_i18nrstevedore.namedr getLoggerrrCrr/r0r-r8rrrNr&intfloatrRrUrWrrrrrrrrrrr rr$r-r4r<rJrrrrUs$    .<<, g!#CJJ @BCJJ 0 2 COO CKK 9;CKK12 CJJ -  /&R ,'V !  c+c+L/d --$% 1#h +$B'T<~ 0*.$*Z   zFsGsE EE