cedZddlZddlZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZ ddlZddlmZddlmZddlmcmZddlmZddlZe j0eZdZGdd ej8Zej<d d d gZGd de Z!Gdde!Z"Gdde!Z#Gdde!e$Z%Gdde!Z&Gdde!Z'Gdde!Z(Gdde!Z)Gdde!Z*Gdd e!Z+Gd!d"e!Z,Gd#d$e!Z-Gd%d&e!e.Z/Gd'd(e/Z0Gd)d*e!e.Z1d+Z2did,Z3djd-Z4d.Z5dkd/Z6dld0Z7d1Z8e9e jtjwd2Zd5Z?d6Z@ejGd7d8ZBGd9d:ZCGd;deBZEGd?d@eBZFGdAdBeBZGGdCdDeBZHGdEdFeBZIGdGdHeBZJGdIdJeBZKGdKdLeBZLGdMdNeBZMGdOdPeBZNGdQdReBZOGdSdTeBZPGdUdVePZQGdWdXeBZRGdYdZeBZSGd[d\eBZTGd]d^ZUGd_d`ejZVGdadbejZXGdcddejZZGdedfejZ\GdgdhejZ^e^Z_y#e$rdZYwxYw)nzPrimary module in oslo_config. N)abc) iniparser)sources)typesz?The name of the driver that can load this configuration source.c*eZdZdZdZdZdZdZdZdZ y) Locations)F)F)F)T)T)Tc ||_||_yN)numis_user_controlled)selfrrs 1/usr/lib/python3/dist-packages/oslo_config/cfg.py__init__zLocations.__init__As"4N) __name__ __module__ __qualname__ opt_default set_default set_overrideuser command_line environmentrrrrr9s%KKL DLK5rr LocationInfolocationdetailceZdZdZddZdZy)ErrorzBase class for cfg exceptions.Nc||_yrmsg)rr(s rrzError.__init__Ls rc|jSrr'rs r__str__z Error.__str__Os xxrrrrr__doc__rr+r rrr%r%Is(rr%ceZdZdZdZy)NotInitializedErrorz(Raised if parser is not initialized yet.cy)Nz.call expression on parser has not been invokedr r*s rr+zNotInitializedError.__str__Vs?rNrrrr-r+r rrr/r/Ss 2@rr/ceZdZdZdZy)ArgsAlreadyParsedErrorz0Raised if a CLI opt is registered after parsing.cFd}|jr|d|jzz }|S)Nzarguments already parsed: r')rrets rr+zArgsAlreadyParsedError.__str__]s%( 88 4$((? "C rNr1r rrr3r3Zs :rr3ceZdZdZddZdZy)NoSuchOptErrorz3Raised if an opt which doesn't exist is referenced.Nc ||_||_yropt_namegrouprr;r<s rrzNoSuchOptError.__init__g   rcp|jdn|jj}d|jd|dS)NDEFAULTzno such option in group []r<namer;r group_names rr+zNoSuchOptError.__str__ks)"&**"4Y$**// 48MM:NNrrr,r rrr8r8ds=Orr8ceZdZdZdZdZy)NoSuchGroupErrorz4Raised if a group which doesn't exist is referenced.c||_yrrFrEs rrzNoSuchGroupError.__init__s $rc d|jzS)Nzno such group [%s]rJr*s rr+zNoSuchGroupError.__str__vs#doo55rNr,r rrrHrHps>%6rrHceZdZdZdZdZy)DuplicateOptErrorz:Raised if multiple opts with the same name are registered.c||_yrr;)rr;s rrzDuplicateOptError.__init__}s   rc d|jzS)Nzduplicate option: %srPr*s rr+zDuplicateOptError.__str__s% 55rNr,r rrrNrNzsD!6rrNceZdZdZddZdZy)RequiredOptErrorzERaised if an option is required but no value is supplied by the user.Nc ||_||_yrr:r=s rrzRequiredOptError.__init__r>rcp|jdn|jj}d|jd|dS)Nr@zvalue required for option rArBrCrEs rr+zRequiredOptError.__str__s0"&**"4Y$**// ?C}}?IK Krrr,r rrrSrSsOKrrSceZdZdZdZy)TemplateSubstitutionErrorzBRaised if an error occurs substituting a variable in an opt value.c d|jzS)Nztemplate substitution error: %sr'r*s rr+z!TemplateSubstitutionError.__str__s0488;;rNr1r rrrWrWs Lddj|jzS)Nz$Failed to find some config files: %s,joinr]r*s rr+z ConfigFilesNotFoundError.__str__!6**+, -rNr,r rrrZrZs;)-rrZceZdZdZdZdZy) ConfigFilesPermissionDeniedErrorz4Raised if one or more config files are not readable.c||_yrr\r^s rrz)ConfigFilesPermissionDeniedError.__init__r_rc>ddj|jzS)Nz$Failed to open some config files: %srarbr*s rr+z(ConfigFilesPermissionDeniedError.__str__rdrNr,r rrrfrfs>)-rrfceZdZdZdZdZy)ConfigDirNotFoundErrorz0Raised if the requested config-dir is not found.c||_yr config_dir)rrms rrzConfigDirNotFoundError.__init__rKrc d|jzS)Nz(Failed to read config file directory: %srlr*s rr+zConfigDirNotFoundError.__str__s:T__LMrNr,r rrrjrjs:%NrrjceZdZdZdZdZy)ConfigFileParseErrorz2Raised if there is an error parsing a config file.c ||_||_yr config_filer()rrsr(s rrzConfigFileParseError.__init__s&rc:d|jd|jS)NzFailed to parse r5rrr*s rr+zConfigFileParseError.__str__s+/+;+;TXXFFrNr,r rrrprps<GrrpceZdZdZy)ConfigSourceValueErrorz>& !D ZZ^^M *F7>c3=124 )0 VW%d067 VUG,.2w T5'*D H %!1A %% %s .C=6C=c|D]I}tjj|||}tjj|sG|cSy)aSearch a list of directories for a given filename or directory name. Iterator over the supplied directories, returning the first file found with the supplied name and extension. :param dirs: a list of directories :param basename: the filename or directory name, for example 'glance-api' :param extension: the file extension, for example '.conf' :returns: the path to a matching file or directory, or None N)r}r~rcexists)dirsbasename extensiondr~s r _search_dirsrsAww||A9=> 77>>$ Krc|Ftjjtjd}|j dr|dd}t |fd||fD}|Dcgc]}|s| c}Scc}w)Nr.pyc3<K|]}|rt|ywr)r).0rrrs r z%_find_config_files..s$3!1i83s)r}r~rsysargvendswithr)rprogrr]rrs ` @r_find_config_filesr sp |ww , == 9D(H3%t_3L$ )!qA )) )s (A70A7ct|||S)aReturn a list of default configuration files. :param project: an optional project name :param prog: the program name, defaulting to the basename of sys.argv[0], without extension .py :param extension: the type of the config file We default to two config files: [${project}.conf, ${prog}.conf] And we look for those config files in the following directories:: ~/.${project}/ ~/ /etc/${project}/ /etc/ ${SNAP_COMMON}/etc/${project} ${SNAP}/etc/${project} We return an absolute path for (at most) one of each the default config files, for the topmost directory it exists in. For example, if project=foo, prog=bar and /etc/foo/foo.conf, /etc/bar.conf and ~/.foo/bar.conf all exist, then we return ['/etc/foo/foo.conf', '~/.foo/bar.conf'] If no project name is supplied, we only look for ${prog}.conf. rrrrs rfind_config_filesrs8 gtY 77rct|||S)aReturn a list of default configuration dirs. :param project: an optional project name :param prog: the program name, defaulting to the basename of sys.argv[0], without extension .py :param extension: the type of the config directory. Defaults to '.conf.d' We default to two config dirs: [${project}.conf.d/, ${prog}.conf.d/]. If no project name is supplied, we only look for ${prog.conf.d/}. And we look for those config dirs in the following directories:: ~/.${project}/ ~/ /etc/${project}/ /etc/ ${SNAP_COMMON}/etc/${project} ${SNAP}/etc/${project} We return an absolute path for each of the two config dirs, in the first place we find it (iff we find it). For example, if project=foo, prog=bar and /etc/foo/foo.conf.d/, /etc/bar.conf.d/ and ~/.foo/bar.conf.d/ all exist, then we return ['/etc/foo/foo.conf.d/', '~/.foo/bar.conf.d/'] rrs rfind_config_dirsr8s6 gtY 77rcv|j|vr+||jd|k7rt|jyy)aCheck whether an opt with the same name is already registered. The same opt may be registered multiple times, with only the first registration having any effect. However, it is an error to attempt to register a different opt with the same name. :param opts: the set of opts already registered :param opt: the opt to be registered :returns: True if the opt was previously registered, False otherwise :raises: DuplicateOptError if a naming conflict is detected optTF)destrNrD)optsrs r_is_opt_registeredrVs: xx4 >% C '#CHH- -rOSLO_CONFIG_SHOW_CODE_LOCATIONScxtsytjd|dz} ||} |d~~S#~wxYw#~wxYw)zReturn a string describing where this is being called from. :param n: Number of steps up the stack to look. Defaults to ``2``. :type n: int :returns: str Nr )_show_caller_detailsinspectstack)nsframes r_get_caller_detailrnsM  QA ! 8  s606369c |D]L}|j|vs||j|_ttjt |_Nyr)rdefaultr!rrr _set_location)rkwargsrs r set_defaultsrsKC 88v  *CK ,Y-B-B-?-A!CC Crc0|dk(r|S|jSNr@)lowerrJs r_normalize_group_namersY    rcxtrddlm}|jt||ytj ||y)aReport use of a deprecated option Uses versionutils from oslo.log if it is available. If not, logs a simple warning message. :param format_str: The message to use for the report :param format_dict: A dict containing keys for any parameters in format_str r) versionutilsN)oslo_logrreport_deprecated_featureLOGwarning) format_str format_dictrs r_report_deprecationrs1 *..sJ/: < J ,rceZdZdZdZ ddZdZdZdZdZ d Z e jZ d Z dd Z dd Zd ZdZdZddZdZy)OptaBase class for all configuration options. The only required parameter is the option's name. However, it is common to also supply a default and help string for all options. :param name: the option's name :param type: the option's type. Must be a callable object that takes string and returns converted and validated value :param dest: the name of the corresponding :class:`.ConfigOpts` property :param short: a single character CLI option name :param default: the default value of the option :param positional: True if the option is a positional CLI argument :param metavar: the option argument to show in --help :param help: an explanation of how the option is used :param secret: true if the value should be obfuscated in log output :param required: true if a value must be supplied for this option :param deprecated_name: deprecated name option. Acts like an alias :param deprecated_group: the group containing a deprecated alias :param deprecated_opts: list of :class:`.DeprecatedOpt` :param sample_default: a default string for sample config files :param deprecated_for_removal: indicates whether this opt is planned for removal in a future release :param deprecated_reason: indicates why this opt is planned for removal in a future release. Silently ignored if deprecated_for_removal is False :param deprecated_since: indicates which release this opt was deprecated in. Accepts any string, though valid version strings are encouraged. Silently ignored if deprecated_for_removal is False :param mutable: True if this option may be reloaded :param advanced: a bool True/False value if this option has advanced usage and is not normally used by the majority of users An Opt object has no public methods, but has a number of public properties: .. py:attribute:: name the name of the option, which may include hyphens .. py:attribute:: type a callable object that takes string and returns converted and validated value. Default types are available from :class:`oslo_config.types` .. py:attribute:: dest the (hyphen-less) :class:`.ConfigOpts` property which contains the option value .. py:attribute:: short a single character CLI option name .. py:attribute:: default the default value of the option .. py:attribute:: sample_default a sample default value string to include in sample config files .. py:attribute:: positional True if the option is a positional CLI argument .. py:attribute:: metavar the name shown as the argument to a CLI option in --help output .. py:attribute:: help a string explaining how the option's value is used .. py:attribute:: advanced in sample files, a bool value indicating the option is advanced .. versionchanged:: 1.2 Added *deprecated_opts* parameter. .. versionchanged:: 1.4 Added *sample_default* parameter. .. versionchanged:: 1.9 Added *deprecated_for_removal* parameter. .. versionchanged:: 2.7 An exception is now raised if the default value has the wrong type. .. versionchanged:: 3.2 Added *deprecated_reason* parameter. .. versionchanged:: 3.5 Added *mutable* parameter. .. versionchanged:: 3.12 Added *deprecated_since* parameter. .. versionchanged:: 3.15 Added *advanced* parameter and attribute. FNc \|jdrtd|d||_|tj}t |s t d||_| |rdnd} |"|jjdd|_ n||_ ||_ ||_ ||_ ||_ ||_||_| |_| |_||_||_||_d|_|j,t.urd}nd }t1t2j4t7||_t;j<| xsg|_|j>D][}d|jvs|j>jAtC|jjdd|jD ]| | b|j>jAtC| | | r:d| vr6|j>jAtC| jdd| |jG||_$||_%y) N_z illegal name z with prefix _ztype must be callableTF-r r r<)& startswith ValueErrorrDrStringcallable TypeErrortypereplacershortrsample_default positionalmetavarhelpsecretrequireddeprecated_for_removaldeprecated_reasondeprecated_since_logged_deprecation __class__rr!rrrrcopydeepcopydeprecated_optsappend DeprecatedOptr<_check_defaultmutableadvanced)rrDrrrrrrrrrdeprecated_namedeprecated_grouprrrrrrr stack_depthos rrz Opt.__init__s ??3 FG G <<<>D~34 4   )tuH < ))#s3DIDI  ,$     &<#!2 0#( >>S KK)  ! ! { +  $}}_=C%% $Aaff}$$++MFFNN3,''-#$ $  &*:*F  ' ' o $,,'/ % >')O6:ll26))+=)=>> >s </A+c<tt|}d|vr|d=|S)Nr)dictvars)rvs r _vars_for_cmpzOpt._vars_for_cmpjs) d  a /"rcD|j|jk7Srrranothers r__ne__z Opt.__ne__z!!#w'<'<'>>>rcD|j|jk(Srrrs r__eq__z Opt.__eq__}rrc||jfg}||jf}|jD]D}|j|j}}|s|s |j |r|n||r|n |jfF|j ||j |j|\}} |jra|jsUd|_ |xsd} |jrdj|j} nd} d} |j| | d} t| | || fS)zRetrieves the option value from a _Namespace object. :param namespace: a _Namespace object :param group_name: a group name )multir current_nameTr@z ({})rzOption "%(option)s" from group "%(group)s" is deprecated for removal%(reason)s. Its value may be silently ignored in the future.)optionr<reason) rrDrr<r _get_valuerrrrrformatr)r namespacerFnamesrrdnamedgroupvalueloc pretty_group pretty_reasonrrs r_get_from_namespacezOpt._get_from_namespaces dii()"DII. '' >CHHcii6E fJ',e$))=> > )) \*C s  & &t/G/G'+D $%2L%% 't/E/E F " ?J&*YY$0%24K K 8s|rc |j||}|j|}|jd|r |jnd}g}|jD]<}|j |j|j }|,|j|>|j|||j|j|||j|y)a}Makes the option available in the command line interface. This is the method ConfigOpts uses to add the opt to the CLI interface as appropriate for the opt type. Some opt types may extend this method, others may just extend the helper methods it uses. :param parser: the CLI option parser :param group: an optional OptGroup object rN) _get_argparse_container_get_argparse_kwargs_get_argparse_prefixrDr_get_deprecated_cli_namer<r_add_to_argparserr rparserr< containerrprefixdeprecated_namesrrs r _add_to_clizOpt._add_to_clis00? **51**2UuzzM'' 9C";;CHH.hyphens(3 0b 0rrrz--N)rradd_parser_argument) rrrrDrrrrr r%argsrs ` rrzOpt._add_to_argparses 1 ^^C-F<<S)Dt v%,-  KKs e+ ,/ 8O KKt 6 7 8 #""9>t>v>rc,||j|S|S)zReturns an argparse._ArgumentGroup. :param parser: an argparse.ArgumentParser :param group: an (optional) OptGroup object :returns: an argparse._ArgumentGroup if group is given, else parser )_get_argparse_group)rrr<s rrzOpt._get_argparse_containers   ,,V4 4Mrc |js&|j}||jdz|z}||d<n|jsd|d<|j d|j |j d|S)aPBuild a dict of keyword arguments for argparse's add_argument(). Most opt types extend this method to customize the behaviour of the options added to argparse. :param group: an optional group :param \*\*kwargs: optional keyword arguments to add to :returns: a dict of keyword arguments Nrr?nargsrrr)rrrDrupdaterr)rr<rrs rrzOpt._get_argparse_kwargssn99D zzC'$.!F6N!F7O $"&,,#yy, - rc||dz|zS|S)aBuild a prefix for the CLI option name, if required. CLI options in a group are prefixed with the group's name in order to avoid conflicts between similarly named options in different groups. :param prefix: an existing prefix to append to (for example 'no' or '') :param group_name: an optional group name :returns: a CLI option prefix including the group name, if appropriate rr )rrrFs rrzOpt._get_argparse_prefixs  !#f, ,Mrc`|dk(rd}||y| |j}|j|||zS)a&Build a CLi arg name for deprecated options. Either a deprecated name or a deprecated group or both or neither can be supplied: dname, dgroup -> dgroup + '-' + dname dname -> dname dgroup -> dgroup + '-' + self.name neither -> None :param dname: a deprecated name, which can be None :param dgroup: a deprecated group, which can be None :param prefix: an prefix to append to (for example 'no' or '') :returns: a CLI argument name r@N)rDr)rrrrs rrzOpt._get_deprecated_cli_name sC Y F =V^ =IIE((85@@rc0t|t|kSr)hashrs r__lt__z Opt.__lt__(sDzDM))r)NNNNFNNFNNNNNFNNFFr)rFNr)rrrr-rrrrrrrobject__hash__rr!rrrrrr3r rrrrseL E9=DH(,8<6:AE@E A!F > ??H"HA0HL?< , A6*rrc*eZdZdZddZdZdZdZy)ra*Represents a Deprecated option. Here's how you can use it:: oldopts = [cfg.DeprecatedOpt('oldopt1', group='group1'), cfg.DeprecatedOpt('oldopt2', group='group2')] cfg.CONF.register_group(cfg.OptGroup('group1')) cfg.CONF.register_opt(cfg.StrOpt('newopt', deprecated_opts=oldopts), group='group1') For options which have a single value (like in the example above), if the new option is present ("[group1]/newopt" above), it will override any deprecated options present ("[group1]/oldopt1" and "[group2]/oldopt2" above). If no group is specified for a DeprecatedOpt option (i.e. the group is None), lookup will happen within the same group the new option is in. For example, if no group was specified for the second option 'oldopt2' in oldopts list:: oldopts = [cfg.DeprecatedOpt('oldopt1', group='group1'), cfg.DeprecatedOpt('oldopt2')] cfg.CONF.register_group(cfg.OptGroup('group1')) cfg.CONF.register_opt(cfg.StrOpt('newopt', deprecated_opts=oldopts), group='group1') then lookup for that option will happen in group 'group1'. If the new option is not present and multiple deprecated options are present, the option corresponding to the first element of deprecated_opts will be chosen. Multi-value options will return all new and deprecated options. So if we have a multi-value option "[group1]/opt1" whose deprecated option is "[group2]/opt2", and the conf file has both these options specified like so:: [group1] opt1=val10,val11 [group2] opt2=val21,val22 Then the value of "[group1]/opt1" will be ['val10', 'val11', 'val21', 'val22']. .. versionadded:: 1.2 Nc ||_||_y)zConstructs an DeprecatedOpt object. :param name: the name of the option :param group: the group of the option NrDr<)rrDr<s rrzDeprecatedOpt.__init___s   rc2|j|jfSrr9r*s r__keyzDeprecatedOpt.__keyhs 4::&&rcD|j|jk(Sr)_DeprecatedOpt__key)rothers rrzDeprecatedOpt.__eq__kszz|u{{},,rc4t|jSr)r2r=r*s rr6zDeprecatedOpt.__hash__nsDJJL!!rr)rrrr-rr=rr6r rrrr,s/b'-"rrc8eZdZdZ dfd ZdZfdZxZS)StrOptaOption with String type Option with ``type`` :class:`oslo_config.types.String` :param name: the option's name :param choices: Optional sequence of either valid values or tuples of valid values with descriptions. :param quotes: If True and string is enclosed with single or double quotes, will strip those quotes. :param regex: Optional regular expression (string or compiled regex) that the value must match on an unanchored search. :param ignore_case: If True case differences (uppercase vs. lowercase) between 'choices' or 'regex' will be ignored. :param max_length: If positive integer, the value must be less than or equal to this parameter. :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` .. versionchanged:: 2.7 Added *quotes* parameter .. versionchanged:: 2.7 Added *regex* parameter .. versionchanged:: 2.7 Added *ignore_case* parameter .. versionchanged:: 2.7 Added *max_length* parameter .. versionchanged:: 5.2 The *choices* parameter will now accept a sequence of tuples, where each tuple is of form (*choice*, *description*) c btt| |fdtj|||||i|y)Nr)choicesquotesregex ignore_case max_length)superrArrr) rrDrCrDrErFrGrrs rrzStrOpt.__init__s? fd$T /*/,,1806/45@4> +@ /(. /rc*|y|dk(ryt|S)Nzrz'')r)rchoices r_get_choice_textzStrOpt._get_choice_texts > r\6{rc Ftt| |}t|jddrpdj |jj Dcgc]}|j|c}}|dd|d<|djd|dxxd|zz cc<|Scc}w)AExtends the base argparse keyword dict for the config dir option.rCNz, rr z Allowed values: %s ) rHrArgetattrrrcrCrKrstrip)rr<rrJ choices_textrs rrzStrOpt._get_argparse_kwargssvt9%@ 499i .9948II4E4E&G*0'+&;&;F&C&GHLf~%!#v 6N ! !$ ' 6N7,F FN &GsB)NNNFN)rrrr-rrKr __classcell__rs@rrArArs%!F37;? /  rrAc@eZdZdZfdZdfd ZdZdfd ZxZS)BoolOpta1Boolean options. Bool opts are set to True or False on the command line using --optname or --nooptname respectively. In config files, boolean values are cast with Boolean type. :param name: the option's name :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` c td|vr tdtt||fdt j i|y)Nrz%positional boolean args not supportedr)rrHrUrrBooleanrrDrrs rrzBoolOpt.__init__s6 6 !DE E gt%dKKFKrcRtt| |||j||y)z}|j |j|j d}|.|j|@d|jz|d<|j|||jd|||j|y)z0Add the --nooptname option to the option parser. store_false)actionnoN)rzThe inverse of --r) rrrrDrrr<rrrrs rrZz BoolOpt._add_inverse_to_argparses00? **5*G**4u$O'' 9C";;CHHOption for a TCP/IP port number. Ports can range from 0 to 65535. Option with ``type`` :class:`oslo_config.types.Integer` :param name: the option's name :param min: minimum value the port can take :param max: maximum value the port can take :param choices: Optional sequence of either valid values or tuples of valid values with descriptions. :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` .. versionadded:: 2.6 .. versionchanged:: 3.2 Added *choices* parameter. .. versionchanged:: 3.4 Allow port number with 0. .. versionchanged:: 3.16 Added *min* and *max* parameters. .. versionchanged:: 5.2 The *choices* parameter will now accept a sequence of tuples, where each tuple is of form (*choice*, *description*) c dtj|||d}tt||fd|i|y)Nz port value)rdrerC type_namer)rPortrHrr)rrDrdrerCrrrs rrzPortOpt.__init__xs3zzcsG$02 gt%d@@@rrgrhrSs@rrr_s.AArrc"eZdZdZfdZxZS) HostnameOptaOption for a hostname. Only accepts valid hostnames. Option with ``type`` :class:`oslo_config.types.Hostname` :param name: the option's name :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` .. versionadded:: 3.8 c Vtt| |fdtji|yrl)rHrrrHostnamerXs rrzHostnameOpt.__init__s* k4)$ 4U^^5E 4,2 4rrhrSs@rrr~s44rrc$eZdZdZdfd ZxZS)HostAddressOptaOption for either an IP or a hostname. Accepts valid hostnames and valid IP addresses. Option with ``type`` :class:`oslo_config.types.HostAddress` :param name: the option's name :param version: one of either ``4``, ``6``, or ``None`` to specify either version. :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` .. versionadded:: 3.22 c Xtt| |fdtj|i|yrl)rHrrr HostAddressr}s rrzHostAddressOpt.__init__s/ nd,T 7272C2CG2L 7/5 7rrrhrSs@rrrs 77rrc$eZdZdZdfd ZxZS) HostDomainOptaOption for either an IP or a hostname. Like HostAddress with the support of _ character. Option with ``type`` :class:`oslo_config.types.HostDomain` :param name: the option's name :param version: one of either ``4``, ``6``, or ``None`` to specify either version. :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` .. versionadded:: 8.6 c Xtt| |fdtj|i|yrl)rHrrr HostDomainr}s rrzHostDomainOpt.__init__s/ mT+D 6161A1A'1J 6.4 6rrrhrSs@rrrs 66rrc$eZdZdZdfd ZxZS)URIOptaOpt with URI type Option with ``type`` :class:`oslo_config.types.URI` :param name: the option's name :param max_length: If positive integer, the value must be less than or equal to this parameter. :param schemes: list of valid URI schemes, e.g. 'https', 'ftp', 'git' :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` .. versionadded:: 3.12 .. versionchanged:: 3.14 Added *max_length* parameter .. versionchanged:: 3.18 Added *schemes* parameter c `tj||}tt||fd|i|y)N)rGschemesr)rURIrHrr)rrDrGrrrrs rrzURIOpt.__init__s,yyJ@ fd$T???rrnrhrSs@rrrs$@@rrc0eZdZdZdZfdZfdZxZS)MultiOptaMulti-value option. Multi opt values are typed opts which may be specified multiple times. The opt value is a list containing all the values specified. :param name: the option's name :param item_type: Type of items (see :class:`oslo_config.types`) :param \*\*kwargs: arbitrary keyword arguments passed to :class:`Opt` For example:: cfg.MultiOpt('foo', item_type=types.Integer(), default=None, help="Multiple foo option") The command line ``--foo=1 --foo=2`` would result in ``cfg.CONF.foo`` containing ``[1,2]`` .. versionadded:: 1.3 Tc 0tt| ||fi|yr)rHrr)rrDrrrrs rrzMultiOpt.__init__s h&tYA&Arc ^tt| |}|jsd|d<|Sd|d<|S)z?Extends the base argparse keyword dict for multi value options.rr]*r,)rHrrrrr<rrs rrzMultiOpt._get_argparse_kwargss<x;EB'F8  "F7O r)rrrr-rrrrRrSs@rrrs* EBrrc"eZdZdZfdZxZS) MultiStrOptzMultiOpt with a MultiString ``item_type``. MultiOpt with a default :class:`oslo_config.types.MultiString` item type. :param name: the option's name :param \*\*kwargs: arbitrary keyword arguments passed to :class:`MultiOpt` c Vtt| |fdtji|y)Nrr)rHrrr MultiStringrXs rrzMultiStrOpt.__init__s- k4)$ 4494E4E4G 4,2 4rrhrSs@rrrs44rrc0eZdZdZ dfd ZddZxZS) SubCommandOptaSub-command options. Sub-command options allow argparse sub-parsers to be used to parse additional command line arguments. The handler argument to the SubCommandOpt constructor is a callable which is supplied an argparse subparsers object. Use this handler callable to add sub-parsers. The opt value is SubCommandAttr object with the name of the chosen sub-parser stored in the 'name' attribute and the values of other sub-parser arguments available as additional attributes. :param name: the option's name :param dest: the name of the corresponding :class:`.ConfigOpts` property :param handler: callable which is supplied subparsers object when invoked :param title: title of the sub-commands group in help output :param description: description of the group in help output :param help: a help string giving an overview of available sub-commands ctt| |tj||||_||_||_y)a\Construct an sub-command parsing option. This behaves similarly to other Opt sub-classes but adds a 'handler' argument. The handler is a callable which is supplied an subparsers object when invoked. The add_parser() method on this subparsers object can be used to register parsers for sub-commands. )rrrN)rHrrrrhandlertitle description)rrDrrrrrrs rrzSubCommandOpt.__init__"s? mT+Du||~15D , B  &rc|j}||jdz|z}|j||j|j|j }d|_|j|j|yy)z7Add argparse sub-parsers and invoke the handler method.Nr)rrrrT)rrDadd_subparsersrrrrr)rrr<r subparserss rr!zSubCommandOpt._add_to_cli2swyy  ::#d*D**157;7G7G04 +; #  << # LL $ $r)NNNNNr)rrrr-rr!rRrSs@rrr s*1548' %rrcVeZdZdZGddej ZfdZfdZxZ S)_ConfigFileOptaThe --config-file option. This is an private option type which handles the special processing required for --config-file options. As each --config-file option is encountered on the command line, we parse the file and store the parsed values in the _Namespace object. This allows us to properly handle the precedence of --config-file options over previous command line arguments, but not over subsequent arguments. .. versionadded:: 1.2 ceZdZdZddZy)_ConfigFileOpt.ConfigFileActiona/An argparse action for --config-file. As each --config-file option is encountered, this action adds the value to the config_file attribute on the _Namespace object but also parses the configuration file and stores the values found also in the _Namespace object. Nct||jdt||jgt||j}|j|tj ||y)z{Handle a --config-file command line argument. :raises: ConfigFileParseError, ConfigFileValueError N)rOrsetattrr ConfigParser _parse_file)rrr values option_stringitemss r__call__z(_ConfigFileOpt.ConfigFileAction.__call__^sS y$))T2: 499b1Ityy1E LL  $ $VY 7rrrrrr-rr rrConfigFileActionrTs   8rrc 2tt| |dfi|y)Nc|Srr rs rz)_ConfigFileOpt.__init__..ksQr)rHrrrXs rrz_ConfigFileOpt.__init__js nd,T;I&Irc Ltt| |}|j|d<|S)z?Extends the base argparse keyword dict for the config file opt.r])rHrrrrs rrz#_ConfigFileOpt._get_argparse_kwargsms)~tA%H00x r) rrrr-argparseActionrrrrRrSs@rrrDs( 88??8,JrrcVeZdZdZGddej ZfdZfdZxZ S) _ConfigDirOptaThe --config-dir option. This is an private option type which handles the special processing required for --config-dir options. As each --config-dir option is encountered on the command line, we parse the files in that directory and store the parsed values in the _Namespace object. This allows us to properly handle the precedence of --config-dir options over previous command line arguments, but not over subsequent arguments. .. versionadded:: 1.2 ceZdZdZddZy)_ConfigDirOpt.ConfigDirActiona An argparse action for --config-dir. As each --config-dir option is encountered, this action sets the config_dir attribute on the _Namespace object but also parses the configuration files and stores the values found also in the _Namespace object. Nc|jj|t||j|tj j |}tj j|s t|tj j|d}ttj|D]}tj||y)zHandle a --config-dir command line argument. :raises: ConfigFileParseError, ConfigFileValueError, ConfigDirNotFoundError *.confN) _config_dirsrrrr}r~rrrjrcsortedglobrr)rrr rrconfig_dir_globrss rrz&_ConfigDirOpt.ConfigDirAction.__call__s  " " ) )& 1 Ityy& 1WW''/F77>>&),V44 ggll68    ' B#)#<#tt| |||||_yr)rHrrfilename)rr(linenolinerrs rrzParseError.__init__s j$(fd;  rcdd|j|j|j|jfzS)Nzat %s:%d, %s: %r)rrr(rr*s rr+zParseError.__str__s-!T]]DKK%)XXtyy%:: :r)rrrrr+rRrSs@rrrs !:rrc\eZdZdZfdZdZfdZdZdZd dZ dZ e d Z xZ S) rzParses a single config file, populating 'sections' to look like:: {'DEFAULT': {'key': [value, ...], ...}, ...} Also populates self._normalized which looks the same but with normalized section names. cbtt| ||_||_d|_d|_yr)rHrrrsections _normalizedsection)rrrrs rrzConfigParser.__init__,s- lD*,     rc||_yr)r)r normalizeds r_add_normalizedzConfigParser._add_normalized3s %rct|j5}tt||j cdddS#1swYyxYwr)openrrHrparse readlines)rfrs rrzConfigParser.parse6s? $--  BAt21;;=A B B Bs !AA c||_|jj|ji|j0|jjt |jiyyr)rr setdefaultrr)rrs r new_sectionzConfigParser.new_section:sU    r2    '    ' '(=dll(K(* , (rc|js|jdjfd}||j|j|j'||jt |jyy)NrNc^||jg||jyr)rr)rrkeyrs rrz'ConfigParser.assignment..appendHs0 W  ( (b 1 W c " ) )% 0r)rerror_no_sectionrcrrr)rrrrs `` r assignmentzConfigParser.assignmentBsk||'') ) %  1 t}}dll+    ' 4##%:4<<%H I (rc2t||||jSr)rr)rr(rrs r parse_exczConfigParser.parse_excPs#vtT]];;rc:|jd|jS)Nz)Section must be started before assignment)rrr*s rrzConfigParser.error_no_sectionSs~~I"kk+ +rct|}i}i}|||}|j| |j|j||||j|||y#tj$r$}t |j t|d}~wt$rl}|jtjk(r|j|Yd}~y|jtjk(r|j|Yd}~yd}~wwxYw)zParse a config file and store any values in the namespace. :raises: ConfigFileParseError, ConfigFileValueError N)rrrrrrprrIOErrorerrnoENOENT_file_not_foundEACCES_file_permission_denied_add_parsed_config_file _parse_cli_opts_from_config_file)clsrsr rrrpeerrs rrzConfigParser._parse_fileWs {+  [(+z*  LLN ))+xL22 : /## =&r{{CG< < yyELL())+6yyELL(11+>  s/A""D 5B D  .D.DDD r)rrrr-rrrrrrr classmethodrrRrSs@rrr"sA&B, J<+//rrc\eZdZdZdZdZdZdZdZdZ ddZ dd Z d Z dd Z d Zy ) _NamespaceaeAn argparse namespace which also stores config file values. As we parse command line arguments, the values get set as attributes on a namespace object. However, we also want to parse config files as they are specified on the command line and collect the values alongside the option values parsed from the command line. Note, we don't actually assign values from config files as attributes on the namespace because config file options be registered after the command line has been parsed, so we may not know how to properly parse or convert a config file value at this point. zqOption "%(dep_option)s" from group "%(dep_group)s" is deprecated. Use option "%(option)s" from group "%(group)s".c||_g|_g|_t|_g|_g|_g|_i|_yr) _conf_parsedrset_emitted_deprecations_files_not_found_files_permission_deniedr_sections_to_file)rconfs rrz_Namespace.__init__sB  %(U" "(*%!#rc Ft|j}|j||||jjD]\}}| |jnd} |j ||\}} | |j} n|dz|jz} |jr8t|| d t|| gt|| } | j|t|| |y#t $rYt$r)} td|jdt| d} ~ wwxYw)aParse CLI options from a config file. CLI options are special - we require they be registered before the command line is parsed. This means that as we parse config files, we can go ahead and apply the appropriate option-type specific conversion to the values in config files for CLI options. We can't do this for non-CLI options, because the schema describing those options may not be registered until after the config files are parsed. This method relies on that invariant in order to enforce proper priority of option values - i.e. that the order in which an option value is parsed, whether the value comes from the CLI or a config file, determines which value specified for a given option wins. The way we implement this ordering is that as we parse each config file, we look for values in that config file for CLI options only. Any values for CLI options found in the config file are treated like they had appeared on the command line and set as attributes on the namespace objects. Values in later config files or on the command line will override values found in this file. NValue for option  is not valid: r)rrr  _all_cli_optsrDrKeyErrorrryrrrrOrextend) rrsrrr rr<rFrrverrs rr z+_Namespace._parse_cli_opts_from_config_files.tzz* ))+xL**224 +JC','8dJ + 44Y K s!xx!C'#((2yy4t,4D$+ t, e$dE*- +  +*xxR*++ +sC$$ D /D 7$DD c|D]}||j|<|jjd||jjd|y)a?Add a parsed config file to the list of parsed files. :param filename: the full name of the file that was parsed :param sections: a mapping of section name to dicts of config values :param normalized: sections mapping with section names normalized :raises: ConfigFileValueError rN)rrinsertr)rrrrrs rr z"_Namespace._add_parsed_config_filesM 1A(0D " "1 % 1 Ax( :.rc:|jj|y)zsRecord that we were unable to open a config file. :param config_file: the path to the failed file N)rrrrss rrz_Namespace._file_not_founds $$[1rc:|jj|y)zzRecord that we have no permission to open a config file. :param config_file: the path to the failed file N)rrr%s rr z"_Namespace._file_permission_denieds %%,,[9rcj|D])\}}||n|dz|z}t||d}|"|r|s'|cSt)aFetch a CLI option value. Look up the value of a CLI option. The value itself may have come from parsing the command line or parsing config files specified on the command line. Type conversion have already been performed for CLI options at this point. :param names: a list of (section, name) tuples :param positional: whether this is a positional option Nr)rOr)rrrrFrDrs r_get_cli_valuez_Namespace._get_cli_valuesV!&  J%-4:3Cd3JDD$-E e  rNc g}fd}|Dcgc]\}}|||f}}}d} r |jn |jD]} |D]\}}|| vr || |vs|xs|d}|j||f||dd| ||} | 4ttj |j j|d} |r| |z}z| | fccS|r |gk7r|| fStcc}}w)aHFetch a config file value from the parsed files. :param names: a list of (section, name) tuples :param multi: a boolean indicating whether to return multiple values :param normalized: whether to normalize group names to lowercase :param current_name: current name in tuple being checked c*|d}r t|S|Sr)r)rDrs r normalizez-_Namespace._get_file_value..normalizes | 2<(. F$ FrNrr r) rr_check_deprecatedr!rrrrr) rrrrrrvaluer+rrDrrvals ` r_get_file_valuez_Namespace._get_file_values" G BGG )G$d+GG-7))T\\ *H!& * (*8G,,#/#;58L**GT?L+096"7+D1C{*%NN 2266wC!$v #Sz)! * *$ Vr\C= /HsCc||vrb||jvrS|jj||dxsd|df}|d|d|d|dd}t|j|yyy)aSCheck for usage of deprecated names. :param name: A tuple of the form (group, name) representing the group and name where an opt value was found. :param current: A tuple of the form (group, name) representing the current name for an option. :param deprecated: A list of tuples with the same format as the name param which represent any deprecated names for an option. If the name param matches any entries in this list a deprecation warning will be logged. rr@r  dep_option dep_groupr r<N)raddr_deprecated_opt_message)rrDcurrent deprecatedrs rr,z_Namespace._check_deprecateds : $d.H.H"H  & & * *4 0qz.Y ;G)-atAw%,QZ'!*FK  < 'A-- A;:A;> B  B c#DK|jD] }|D]}|ywr)r)rrrs r _sectionsz_Namespace._sectionses-  H#    s r)FFN)FFNT)rrrr-r5rr r rr r(r/r,r r>r rrrrvsU  F$0+d /2:0FJ'RK&9>1516frrcTeZdZdZdfd ZdZdZdfd Zd fd Zd fd Z xZ S) _CachedArgumentParseraZclass for caching/collecting command line arguments. It also sorts the arguments before initializing the ArgumentParser. We need to do this since ArgumentParser by default does not sort the argument options and the only way to influence the order of arguments in '--help' is to ensure they are added in the sorted order. c >tt| ||fi|i|_yr)rHr@r _args_cache)rrusagerrs rrz_CachedArgumentParser.__init__vs" #T3D%J6Jrcg}||jvr|j|}|j||d||j|<y)N)r'r)rBr)rrr'rrs rr&z)_CachedArgumentParser.add_parser_argumentzsF (( (%%i0F tv67&,#rc|jjD]z\}}d}d}t|D] \}}|ddjdrd}n|r|n t |}t |d|d|d||D]} |j |di|d|i|_y#tj$r d j|d}t|wxYw) NrFr'rTc |dS)Nr'r rs rrzC_CachedArgumentParser.initialize_parser_arguments..s & rrrra) rBr enumeraterlenr add_argumentr ArgumentErrorrcrN)rrrindexhas_positionalargumentsizeoptionss rinitialize_parser_argumentsz1_CachedArgumentParser.initialize_parser_argumentss  "&!1!1!7!7!9 5 IvE"N#,V#4 x'*55c:%)N +5F D"6%4=6IJF5DM" 55*I**HV,<A-5h-?A 5 5  --5!hhx'78G+G445s <B  3CcL|jtt|||Sr)rQrHr@ parse_args)rr'r rs rrSz _CachedArgumentParser.parse_argss$ ((**Dd=Z?d>Z@eed?ZAd@ZBdAZCdBZDdCZEdDZFdMdEZGGdFdGeHjZJGdHdIZKGdJdKZLy)Q ConfigOptsatConfig options which may be set on the command line or in config files. ConfigOpts is a configuration option manager with APIs for registering option schemas, grouping options, parsing option values and retrieving the values of options. It has built-in support for :oslo.config:option:`config_file` and :oslo.config:option:`config_dir` options. )rrr~rCdefault_config_filesdefault_config_dirs config_sourceSOURCEzLists configuration groups that provide more details for accessing configuration settings from locations other than local files.rrrci|_i|_i|_d|_d|_d|_d|_tg|_i|_ i|_ g|_ tj|_d|_g|_d|_d|_t'j(|_|j-|j.y)zConstruct a ConfigOpts object.NFT)r_groups_deprecated_opts_args_oparser _namespace _mutable_nsr _mutate_hooks_ConfigOpts__cache_ConfigOpts__drivers_cache _config_opts collectionsdeque _cli_opts_validate_default_values_sources_ext_mgr_use_env _environmentEnvironmentConfigurationSource _env_driver register_opt_config_source_optr*s rrzConfigOpts.__init__s  "   W !$**,(-%   'FFH $112rc R|Ftjjtjd}|j dr|dd}| t ||}| t||}t|||||_ |)|jj|jdd||||fS) z7Initialize a ConfigCliParser object for option parsing.Nrrr)rrCrepilogz --versionr~)r]r~) r}r~rrrrrrr@rer&) rrrr~rCrryr\r]s r _pre_setupzConfigOpts._pre_setups <77##CHHQK0D}}U#CRy  '#4Wd#C  &"27D"A -U FL    MM - -dmm.95>6= . ? )+>>>rc>td|ddtdd|dgS) Nz config-filePATHzPath to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to %(default)s. This option must be set from the command-line.r-z config-dirDIRaaPath to a config directory to pull `*.conf` files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence over-ridden options in the directory take precedence. This option must be set from the command-line.r`)rr)r\r]s r_make_config_optionszConfigOpts._make_config_optionss: =#7#)": < ,"'"5 3 4  rc`|j||}|j|j|S)zBReturn options to be used by list_opts() for the sample generator.)r~rrw)r r\r]rPs r_list_options_for_discoveryz&ConfigOpts._list_options_for_discovery s2 **+?+>@s--.rc|j|||_|j|j||_||_||_||_||_||_||_ y)z2Initialize a ConfigOpts object for option parsing.N) r~rkregister_cli_optsrrr~rCr\r]rr)rrrr~rCr\r]use_envs r_setupzConfigOpts._setupse!556J6IK t001    $8!#6  rcBtjfd}|S)Nc|jddr(|g|i|}|jj|S|g|i|S)N clear_cacheT)popriclearrr'rresultrs r__innerz)ConfigOpts.__clear_cache..__inner%sOzz-.41$1&1 ""$ ////r functoolswrapsr_ConfigOpts__inners` r __clear_cachezConfigOpts.__clear_cache$%   0  0rcBtjfd}|S)Nc|jddr(|g|i|}|jj|S|g|i|S)Nclear_drivers_cacheT)rrjrrs rrz1ConfigOpts.__clear_drivers_cache..__inner1sRzz/641$1&1$$**, ////rrrs` r__clear_drivers_cachez ConfigOpts.__clear_drivers_cache0rrNc |j||_|j||||| | ||\}}}|j||||||| |j ||nt j dd|_|jjrt|jj|jjrt|jj|j|jy)aParse command line arguments and config files. Calling a ConfigOpts object causes the supplied command line arguments and config files to be parsed, causing opt values to be made available as attributes of the object. The object may be called multiple times, each time causing the previous set of values to be overwritten. Automatically registers the --config-file option with either a supplied list of default config files, or a list from find_config_files(). If the --config-dir option is set, any *.conf files from this directory are pulled in, after all the file(s) specified by the --config-file option. :param args: command line arguments (defaults to sys.argv[1:]) :param project: the toplevel project name, used to locate config files :param prog: the name of the program (defaults to sys.argv[0] basename, without extension .py) :param version: the program version (for --version) :param usage: a usage string (%prog will be expanded) :param description: A description of what the program does :param epilog: Text following the argument descriptions :param default_config_files: config files to use by default :param default_config_dirs: config dirs to use by default :param validate_default_values: whether to validate the default values :param use_env: If True (the default) look in the environment as one source of option values. :raises: SystemExit, ConfigFilesNotFoundError, ConfigFileParseError, ConfigFilesPermissionDeniedError, RequiredOptError, DuplicateOptError Nr )rrorzr_parse_cli_optsrrrfrrZrrf_load_alternative_sources_check_required_opts) rr'rrr~rCr\r]validate_default_valuesrryrs rrzConfigOpts.__call__<sZ (?%:>// T7E; "5;77"$7 GT7E3G' 2..t7Gt47HHQRLB ?? + +*4??+K+KL L ?? 3 3288: : &&( !!#rc|jD]1}|j|}||jj|3yr)r^_open_source_from_opt_grouprpr)rsource_group_namesources rrz$ConfigOpts._load_alternative_sourcessA!%!3!3 - 556GHF! $$V, -rcj|jstjdd|_|jt d|jj t | ||j}|tjd|ytjd |||j|j} |j||S#t$r+}tjd||jYd}~yd}~wwxYw#t$r"}tjd |||Yd}~yd}~wwxYw) Nzoslo.config.driverT)invoke_on_loaddriver)rCrrz(could not load configuration from %r. %sz9could not load configuration from %r, no 'driver' is set.z&loading configuration from %r using %rz8could not load configuration from %r using %s driver: %s)rq stevedoreExtensionManagerrvrAr_SOURCE_DRIVER_OPTION_HELPrryrerrorr(infoobjopen_source_from_opt_groupr)rrF driver_namerrs rrz&ConfigOpts._open_source_from_opt_groups)}}%66$#%DM  8==..02 4    z*11K   IIK  9[ *{+// 44T:F F%$  II:CGG %  &  IIJK .  s0%C>D D!C??D D2D--D2ch |j|S#t$rt$r t|wxYw)zLook up an option value and perform string substitution. :param name: the opt name (or 'dest', more precisely) :returns: the option value (after string substitution) or a GroupAttr :raises: ValueError or NoSuchOptError )_getrrr8rrDs r __getattr__zConfigOpts.__getattr__s: '99T? "   ' & & 's1c$|j|Sz8Look up an option value and perform string substitution.rrrs r __getitem__zConfigOpts.__getitem__s$$rc>||jvxs||jvSz CI sA#A%cXt|jt|jzSz/Return the number of options and option groups.)rIrrbr*s r__len__zConfigOpts.__len__s4::T\\!222rcD|j|jy)z8Clear the object state and unset overrides and defaults.N)_unset_defaults_and_overridesrr*s rresetzConfigOpts.resets **, rcd|_d|_d|_d|_d|_|j |j |jjD]}|jy)aEReset the state of the object to before options were registered. This method removes all registered options and discards the data from the command line and configuration files. Any subparsers added using the add_cli_subparsers() will also be removed as a side-effect of this method. NF) rdrerfrgrounregister_optsrkrbrrrr<s rrzConfigOpts.clearsb  (-% T../\\((* E LLN rc||d|jvry|jr|jj||dy|jj||dy)Nrr<)rnrr appendleftrrr<s r _add_cli_optzConfigOpts._add_cli_optsK '4>> 9  >> NN ! !#"> ? NN % %cE&B Crct|drz|jD]j}|jxsd}|j}|r|j dd}||j vr|||di|j |<V||d|j ||<lyy)Nrr@rrr)hasattrrr<rDrrc)rrr<dep_optr3dep_dests r_track_deprecated_optsz!ConfigOpts._track_deprecated_optss 3) *.. #MM6Y "<<'//S9HD$9$99 #&%*#8D)))4 #!&BD)))4X>  +rc|L|j|d}|r|j|||j|||j||S|0|j|j vrt d|jz|r|j|dt|j|ry||d|j|j<|j|y)aRegister an option schema. Registering an option schema makes any option value which is previously or subsequently parsed from the command line or config files available as an attribute of this object. :param opt: an instance of an Opt sub-class :param group: an optional OptGroup object or group name :param cli: whether this is a CLI option :return: False if the opt was already registered, True otherwise :raises: DuplicateOptError NT) autocreaterz%Name %s was reserved for oslo.config.Fr) _get_grouprrrrDdisallow_namesrrrr)rrr<rs rrvzConfigOpts.register_opt s  OOEdO;E!!#u-  ' '5 ' 9&&sC0 0 =xx4... !H#&88",--    c4 ( djj# .'*37 388 ##C(rc:|D]}|j||dy)z)Register multiple option schemas at once.FrN)rvrrr<rs r register_optszConfigOpts.register_opts* s( =C   c5e  < =rcZ|j td|j||ddS)aRegister a CLI option schema. CLI option schemas must be registered before the command line and config files are parsed. This is to ensure that all CLI options are shown in --help and option validation works as expected. :param opt: an instance of an Opt sub-class :param group: an optional OptGroup object or group name :return: False if the opt was already registered, True otherwise :raises: DuplicateOptError, ArgsAlreadyParsedError zcannot register CLI optionTF)rr)rdr3rvrs rregister_cli_optzConfigOpts.register_cli_opt0 s4 :: !()EF F  e5 IIrc:|D]}|j||dy)z-Register multiple CLI option schemas at once.FrN)rrs rrzConfigOpts.register_cli_optsB s* AC  ! !#u% ! @ Arc|j|jvrytj||j|j<y)zRegister an option group. An option group must be registered before options can be registered with the group. :param group: an OptGroup object N)rDrbrrs rregister_groupzConfigOpts.register_groupH s2 :: % #'99U#3 UZZ rc|j tdd}|jD]P}|dj|jk(s |,|j |j |dj k(sN|}n||jj ||!|j |j|y|j|jvr|j|j=yy)zUnregister an option. :param opt: an Opt object :param group: an optional OptGroup object or group name :raises: ArgsAlreadyParsedError, NoSuchGroupError Nz"reset before unregistering optionsrr<) rdr3rnrrrDremoverr)rrr<remitemitems runregister_optzConfigOpts.unregister_optU s :: !()MN NNN DU   CHH,OOE*//4=3E3EE     NN ! !' *   OOE " 2 23 7 XX # 388$$rc:|D]}|j||dy)z/Unregister multiple CLI option schemas at once.FrN)rrs rrzConfigOpts.unregister_optso s( ?C   U  > ?rc>t||j||y)aImport an option definition from a module. Import a module and check that a given option is registered. This is intended for use with global configuration objects like cfg.CONF where modules commonly register options with CONF at module load time. If one module requires an option defined by another module it can use this method to explicitly declare the dependency. :param name: the name/dest of the opt :param module_str: the name of a module to import :param group: an option OptGroup object or group name :raises: NoSuchOptError, NoSuchGroupError N) __import__ _get_opt_info)rrD module_strr<s r import_optzConfigOpts.import_optu s : 4'rc<t||j|y)aYImport an option group from a module. Import a module and check that a given option group is registered. This is intended for use with global configuration objects like cfg.CONF where modules commonly register options with CONF at module load time. If one module requires an option group defined by another module it can use this method to explicitly declare the dependency. :param group: an option OptGroup object or group name :param module_str: the name of a module to import :raises: ImportError, NoSuchGroupError N)rr)rr<rs r import_groupzConfigOpts.import_group s : rc|j||}|j|d||d<ttjt d|d<y)aIOverride an opt value. Override the command line, config file and default values of a given option. :param name: the name/dest of the opt :param override: the override value :param group: an option OptGroup object or group name :raises: NoSuchOptError, NoSuchGroupError roverrider r"N)r_get_enforced_type_valuer!rrr)rrDrr<opt_infos rrzConfigOpts.set_override sT%%dE2#<< UOX '+  " " q ! rc|j||}|j|d||d<ttjt d|d<y)aOverride an opt's default value. Override the default value of given option. A command line or config file value will still take precedence over this default. :param name: the name/dest of the opt :param default: the default value :param group: an option OptGroup object or group name :raises: NoSuchOptError, NoSuchGroupError rrr r"N)rrr!rrr)rrDrr<rs rrzConfigOpts.set_default sT%%dE2";; UOW&+  ! ! q ! rc,|y|j||Sr)_convert_value)rrrs rrz#ConfigOpts._get_enforced_type_value s =""5#..rcL|j||}|jddy)a?Clear an override an opt value. Clear a previously set override of the command line, config file and default values of a given option. :param name: the name/dest of the opt :param group: an option OptGroup object or group name :raises: NoSuchOptError, NoSuchGroupError rNrrrrDr<rs rclear_overridezConfigOpts.clear_override s$%%dE2 Z&rcL|j||}|jddy)a Clear an override an opt's default value. Clear a previously set override of the default value of given option. :param name: the name/dest of the opt :param group: an option OptGroup object or group name :raises: NoSuchOptError, NoSuchGroupError rNrrs r clear_defaultzConfigOpts.clear_default s$%%dE2 Y%rc#K|jjD]}|df |jjD]'}|jjD]}||f )yw)z-A generator function for iteration opt infos.N)rrrbrrr<s r_all_opt_infoszConfigOpts._all_opt_infos snJJ%%' D*  \\((* "E **, "Ek! " "sA+A-c#FK|jD]}|d|dfyw)z,A generator function for iterating CLI opts.rr<N)rn)rrs rrzConfigOpts._all_cli_opts s,NN -Du+tG}, , -s!c||jD])\}}|jdd|jdd+y)z-Unset any default or override on all options.rNr)rrrs rrz(ConfigOpts._unset_defaults_and_overrides s:..0 'KD% HHY % HHZ & 'rcJ|jgS|jjSr)rfrr*s r config_dirszConfigOpts.config_dirs s! ?? "I+++rc|js tg}|jjr5|jjD]}|jt |t |j D]9}|jtjjt |;|jt|jt||S)aLocate a file located alongside the config files. Search for a file with the supplied basename in the directories which we have already loaded config files from and other known configuration directories. The directory, if any, supplied by the config_dir option is searched first. Then the config_file option is iterated over and each of the base directories of the config_files values are searched. Failing both of these, the standard directories searched by the module level find_config_files() function is used. The first matching file is returned. :param name: the filename, for example 'policy.json' :returns: the path to a matching file, or None )rfr/rrrreversedrsr}r~dirnamer rrr)rrDr directorycfs r find_filezConfigOpts.find_file s"%' ' ?? ' '!__99 1  HY/0 14++, 7B KK 5 6 7 $T\\23D$''rc|j|d|j|d|j|d|j|j|dt|dxr |jxsg|j|dd}t |j D];}|j |d}|j|d |||t||=t|jD]}|j||j|}t |j|j D]A}|j ||d}|j|d |d |||t||C|j|dy ) aLog the value of all registered opts. It's often useful for an app to log its configuration to a log file at startup for debugging. This method dumps to the entire config state to the supplied logger at a given log level. :param logger: a logging.Logger object :param lvl: the log level (for example logging.DEBUG) arg to logger.log() zP********************************************************************************z$Configuration options gathered from:zcommand line args: %szconfig files: %srszP================================================================================c"|js|SdS)z,Obfuscate values of options declared secret.z****)r)rrs r _sanitizez,ConfigOpts.log_opt_values.._sanitize/ s # 5 7 7rrz %-30s = %srN) logrdrrsrrrrOrrb GroupAttrr)rloggerlvlrr;rrF group_attrs rlog_opt_valueszConfigOpts.log_opt_values su  3! 3>? 3/< 3*4/DD4D4DJ L 3! 8tzz* @H$$X.u5C JJsL( gdH&=> @ @ t||, JJdooj.IJJ"4<< #;#A#AB J((:>uE 3 &0(;$S'*h*GHJ J J  3!rcf|js t|jj|y)atPrint the usage message for the current program. This method is for use after all CLI options are known registered using __call__() method. If this method is called before the __call__() is invoked, it throws NotInitializedError :param file: the File object (if None, output is on sys.stdout) :raises: NotInitializedError N)rer/rYrrWs rrYzConfigOpts.print_usageB s&}}%' ' !!$'rcf|js t|jj|y)asPrint the help message for the current program. This method is for use after all CLI options are known registered using __call__() method. If this method is called before the __call__() is invoked, it throws NotInitializedError :param file: the File object (if None, output is on sys.stdout) :raises: NotInitializedError N)rer/rUrs rrUzConfigOpts.print_helpP s&}}%' '   &rct|tr|j|f}n||f}| |j|S|j |||\}}||j|<|S#t$rY2wxYwr)rrrDrir_do_get)rrDr<r rrrs rrzConfigOpts._get^ s| eX &::t$C$-C   ||C((\\$y9 s! S   sA A)(A)c V1|jvr#jj|dfSj|}|dd|vr|d}n j}t t rjjdfSd|vrj|d|fSfd}r jnd}||f}tjdf} jrjj||} j r j" j$ d} j'|\} } | tjk7r'| j(t*j,k(r || | fS| dtjk7r|| d| dfS| tjk7r || | fS j@|S#t.$r_t1t*j2jj5||} | dtjk7r|| d| dfcYSYwwxYw#t6$rV} djd  d t9| } | j(t*j:k(r t=| t?| d} ~ wwxYw#t.$rYnwxYwjBD]N}|j||} | dtjk7s-|| d| df}|j@|<|cSd |vrj|d |fSjDrUjFI |jFn5#t6$r)}t=d jd t9|d}~wwxYwjF|jF|fSy )aLook up an option value. :param name: the opt name (or 'dest', more precisely) :param group: an OptGroup :param namespace: the namespace object to get the option value from :returns: 2-tuple of the option value or a GroupAttr object and LocationInfo or None :raises: NoSuchOptError, NoSuchGroupError, ConfigFileValueError, TemplateSubstitutionError Nrr"rcJjj|Sr)r _substitute)rr<r rrs rconvertz#ConfigOpts._do_get..convert s,&&  y93@ @rrr rz from rrzDefault value for option rn)$rbr rrrrrSubCommandAttrrrrDr_NoValuerrrurrrgrfrr"rrrr!rget_namerrrryrvrjrpror)rrDr<r rrrrFrenv_valalt_locr.r!messagerrers` `` @rrzConfigOpts._do_getl s =TT\\1NN4)>?F F!!$.5k  z"C##C c= )''eSXX>E E  $$T*%56< < @$)UZZd 4 ##T* ==&&**:tSAG ;;9,((I  I   6A#&#:#:9;E$GLCw/// ' 0 0I4J4J J ' g66qzW%5%55 ' 3WQZ@@g... ' g66/( '', ,' A*!--((11*dCG qzW%5%55 ' 3WQZ@@6A 6HHgs2w0##y~~5.w77,W55 6   mm F**Zs3C1v)))!#a&/3q62,2$$S)    $$T)_5s; ;  ( ({{&.CKK(!..88SV-... ;; "CKK(#. .s{0I3AG%G(GIJ#A#H>9I;I=H>>I J  AJJ # J/.J/M N$NNc t|tr"|Dcgc]}|j|||c}St|trLd|vr|j dd}|j |}|j |j|||}|St|trH|jDcic],\}}|j||||j|||.c}}S|Scc}wcc}}w)aPerform string template substitution. Substitute any template variables (for example $foo, ${bar}) in the supplied string value(s) with opt values. :param value: the string value, or list of string values :param group: the group that retrieves the option value from :param namespace: the namespace object that retrieves the option value from :returns: the substituted string(s) r<r rr) rrrrrTemplatesafe_substitute StrSubWrapperrr) rrr<r irr6rr.s rrzConfigOpts._substitute s eT ""$$$Qey$I$ $ s #~ eT2=='D&&""4u "JLCJ t $%*KKM3 S$$S$K$$S$KL3 3L%$3s C)21C.ceZdZdZy)ConfigOpts.Templatez[_a-z][\._a-z0-9]*N)rrr idpatternr rrr!r& s) rr!c|jr|Dcgc]}|j|c}S|j|Scc}w)aePerform value type conversion. Converts values using option's type. Handles cases when value is actually a list of values (for example for multi opts). :param value: the string value, or list of string values :param opt: option definition (instance of Opt class or its subclasses) :returns: converted value )rr)rrrrs rrzConfigOpts._convert_value s7 99)./ACHHQK/ /88E? "0s=ct|tr|nd}|r |jn|}||jvr,|s t ||j |xs t||j|S)aLooks up a OptGroup object. Helper function to return an OptGroup given a parameter which can either be the group's name or an OptGroup object. The OptGroup object returned is from the internal dict of OptGroup objects, which will be a copy of any OptGroup object that users of the API have access to. If autocreate is True, the group will be created if it's not found. If group is an instance of OptGroup, that same instance will be registered, otherwise a new instance of OptGroup will be created. :param group_or_name: the group's name or the OptGroup object itself :param autocreate: whether to auto-create the group if it's not found :raises: NoSuchGroupError Nr)rrrDrbrHr)r group_or_namerr<rFs rrzConfigOpts._get_group sb$",M8!D $#(UZZm T\\ )&z22    Bz)B C||J''rcd}d}|xsd}t|dr |j}|jj|}|r6|j|}|r#|dj}|dr|dj}||fS)Nr@rDrr<)rrDrcr)rr;r< real_opt_namereal_group_namerFr3 real_opt_dicts r_find_deprecated_optsz ConfigOpts._find_deprecated_opts' s 'i :v &#J))--j9 %MM(3M -e 4 9 9  )&3G&<&A&AOo--rc<| |j}n|j|}|j}||vrh|j||\}}|s t|||xsd}d}tj |||||d|}|r|j|}|j}||S)zReturn the (opt, override, default) dict for an opt. :param opt_name: an opt name/dest :param group: an optional group name or OptGroup object :raises: NoSuchOptError, NoSuchGroupError rr@zcConfig option %(dep_group)s.%(dep_option)s is deprecated. Use option %(group)s.%(option)s instead.r1)rrr/r8rr)rr;r<rr,r-log_real_group_name dep_messages rrzConfigOpts._get_opt_info6 s =::DOOE*E;;D 4 -1-G-G.H.' *M? $Xu55"1">Y 1K KK H380=/B&D E%H8{{H~rc|jD]S\}}|d}|jsd|vsd|vr!|j|j||?t |j |y)zCheck that all opts marked as required have values specified. :param namespace: the namespace object be checked the required options :raises: RequiredOptError rrrN)rrrrrSrD)rr rr<rs rrzConfigOpts._check_required_optsW sj  ..0 . sqtyyrrGr z argument --z : Invalid z value: rN)rrrDrrrrrrstderrwriterreprr SystemExit)rr rr<rFrrs rr7z ConfigOpts._validate_cli_options s !3!3!5%8: !JC',$J  44Y K s$$U%9$ME !##E3/ !    !   HHd388ne"56   !sA3B3 A?>A?ACc|j}|jrt|j|jrt |j|j ||Sr)r5rrZrrfr)rr s r_reload_config_fileszConfigOpts._reload_config_files s],,.  % %*9+E+EF F  - -2224 4 !!),rc |j}||_y#t$r*}tj d|j Yd}~yd}~wt $r }tj d|Yd}~yd}~wwxYw)zReload configure files and parse all options :return: False if reload configure files failed or else return True TzDCaught SystemExit while reloading configure files with exit code: %dNFz0Caught Error while reloading configure files: %s)r?rfr=rrcoder%)rr excrs rreload_config_fileszConfigOpts.reload_config_files sn 113I(DO  KK347HH >  KK! # s  A4 A A4A//A4c:|jj|y)zRegisters a hook to be called by mutate_config_files. :param hook: a function accepting this ConfigOpts object and a dict of config mutations, as returned by mutate_config_files. :return: None N)rhr4)rhooks rregister_mutate_hookzConfigOpts.register_mutate_hook s t$rc |jj|jxs |j}|j |_|j |j ||j}d}t|j|}|D],\\}}\}}|r|nd}tjd||||d.|jD] } | || |S)awReload configure files and parse all options. Only options marked as 'mutable' will appear to change. Hooks are called in a NON-DETERMINISTIC ORDER. Do not expect hooks to be called in the same order as they were added. :return: {(None or 'group', 'optname'): (old_value, new_value), ... } :raises: Error if reloading fails c(|d\}}|r|dSd|fS)Nr r )r groupnameoptnames rkey_fnz.ConfigOpts.mutate_config_files..key_fn s'$(7 Y'47  = ekkm8 0< ' , Y*3%. II HH6( '!$!$& ' '&& D u   rc|jD]\}}|d}|jr|r |jnd} |j|j|\}} |j|j |\}}||k7sntjd||jdy#t $rd}YYwxYw#t $rd}YJwxYw)zCheck immutable opts have not changed. _do_get won't return the new values but presumably someone changed the config file expecting them to change so we should warn them they won't. rr@Nz8Ignoring change to immutable option %(group)s.%(option)s)r<r ) rrrDrrfrrgrr)rrr<rrJrTrrUs rrOzConfigOpts._warn_immutability s  ..0 FKD%u+C{{&+ I 00)LQ 001A1A9MQcz 3&/388DF F    s#B%B6% B32B36 CCcLi}|jD]l\}}|d}|js|r |jnd} |j||\}} |j||\} } || k7sZ|| f|||jf<n|S#t$rd}Y@wxYw#t$rd} Y;wxYw)zCompare mutable option values between two namespaces. This can be used to only reconfigure stateful sessions when necessary. :return {(None or 'group', 'optname'): (old_value, new_value), ... } rN)rrrDrr) rold_nsnew_nsdiffrr<rrJrTrrUs rrPzConfigOpts._diff_ns s..0 9KD%u+C;;&+ I 00CQ 00CQcz/2Cji*+ 9     s#BB BB B#"B#ctg}|jr&|t|jjz}|jr&|t|jjz}t |S)zList all sections from the configuration. Returns a sorted list of all section names found in the configuration files, whether declared beforehand or not. )rrgr>rfr)rrs rlist_all_sectionszConfigOpts.list_all_sections1 sa G    T%%//12 2A ?? T__..01 1AayrcP| t|nd}|j||d\}}|S)aReturn the location where the option is being set. :param name: The name of the option. :type name: str :param group: The name of the group of the option. Defaults to ``'DEFAULT'``. :type group: str :return: LocationInfo .. seealso:: :doc:`/reference/locations` .. versionadded:: 5.3.0 N)rr)rrDr< opt_grouprrs r get_locationzConfigOpts.get_location> s/ (-'8HUOd \\$ 48 s rc4eZdZdZdZdZdZdZdZdZ y) ConfigOpts.GroupAttrzdHelper class. Represents the option values of a group as a mapping and attributes. c ||_||_y)zConstruct a GroupAttr object. :param conf: a ConfigOpts object :param group: an OptGroup object N)r_group)rrr<s rrzConfigOpts.GroupAttr.__init__Y s DJDKrcN|jj||jS)z:Look up an option value and perform template substitution.)rrrdrs rrz ConfigOpts.GroupAttr.__getattr__b s::??45 5rc$|j|Srrrs rrz ConfigOpts.GroupAttr.__getitem__f s##C( (rc2||jjvSr)rdrrs rrz!ConfigOpts.GroupAttr.__contains__j s$+++++ +rc#fK|jjjD]}|ywr)rdrrrs rrzConfigOpts.GroupAttr.__iter__n s-{{((--/   s/1c@t|jjSr)rIrdrr*s rrzConfigOpts.GroupAttr.__len__s st{{(() )rN) rrrr-rrrrrrr rrr rbR s%   6 ) ,   *rr ceZdZdZdZdZy)ConfigOpts.SubCommandAttrz\Helper class. Represents the name and arguments of an argparse sub-parser. c.||_||_||_y)zConstruct a SubCommandAttr object. :param conf: a ConfigOpts object :param group: an OptGroup object :param dest: the name of the sub-parser N)rrd_dest)rrr<rs rrz"ConfigOpts.SubCommandAttr.__init__~ sDJDKDJrcX|dk(rT|j}|j|jjdz|z}t|jj |S||jvr t | t|jj |S#t$r t|wxYw)z,Look up a sub-parser name or argument value.rDr) rmrdrDrOrrfrNAttributeErrorr8rs rrz%ConfigOpts.SubCommandAttr.__getattr__ sv~zz;;*;;++c1D8Dtzz44d;;tzz!'-- +tzz44d;;! +$T** +s 4BB)N)rrrr-rrr rrrrkw s  +rrceZdZdZddZdZy)ConfigOpts.StrSubWrapperzUHelper class. Exposes opt values as a dict for string substitution. Nc.||_||_||_y)zConstruct a StrSubWrapper object. :param conf: a ConfigOpts object :param group: an OptGroup object :param namespace: the namespace object that retrieves the option value from N)rr<r )rrr<r s rrz!ConfigOpts.StrSubWrapper.__init__ sDIDJ&DNrc |jdd\}}t|} |jj |||j }t||jjrtd|z|y|S#t$r|j}|}YuwxYw#t$r*|jj ||j }YwxYw)zLook up an opt value from the ConfigOpts object. :param key: an opt name :returns: an opt value rr rr )r z#substituting group %s not supportedr) splitrrr<rrr r8rr rW)rrrFr r<rs rrz$ConfigOpts.StrSubWrapper.__getitem__ s  2%(YYsA%6" F !j1 F vU15'A%!4!45/9C?AA}L   " F sdnnE Fs"A?(B?BB0CCrn)rrrr-rrr rrr#rq s ' rr#) NNNNNNNFNNTr)NFrnr)Mrrrr-rrprwrrz staticmethodr~rrr_ConfigOpts__clear_cache _ConfigOpts__clear_drivers_cacherrrrrrrrrrrrrvrrrrrrrrrrrrrrrrpropertyrrrrYrUrrrstringr!rrr/rrrr5r7r?rCrFrVrOrPr]r`rMappingr rr#r rrr[r[s NN!7 32?4  0    &*%)).!B$H-%N '%8 3 &D($$L== JJ"AA 4%%2?? (&$  (  (/  ' ' & &"- ' ,, (>#"J ( ' iVB*6??* #(: .B< *$&P!$(%"HF02 (#*CKK#*J + +D**rr[rr4)NNz.conf)NNz.conf.d)r )`r-rrlrrenumrrrrrloggingr}ryrr ImportError oslo_configrr oslo_config.sources._environmentrsrr getLoggerrrrEnumr namedtupler!rr%r/r3ror8rHrNrSrWrZrfrjrprrvryr{rrrrrrrboolrrrrrrrtotal_orderingrrrArUrbrjrprvrzrrrrrrrrrrrr BaseParserr NamespacerArgumentParserr@rzr[CONFr rrrsS   "77g! 5 5&{%%nz86LM I@%@U OUN O6u666 Ku K<<-u--u-NUNG5G UJ  1 EzE2 "&J" *8>8<(BJJNN%'(2C -* ~*~*~*B C"C"LCSCL6c6r/S/@1s1*0c0, Ic I .C.&AcA>4#4"7S7,6C6,@S@2#s#L4(4"6%C6%r-S-`5C5piiX:%%:Q/9''Q/hr##rj8=H338=v]]@)|AeHsK''K21K2