o tBhLd@sdZddlmZmZmZddlZddlZddlZddlm Z ddl m Z ddl m Z ddl m Z dd lmZmZmZdd lmZmZmZd Zd Zd ZdZGdddeZGdddeZGdddeZGdddeZGdddeZdS)z%Worry-free YAML configuration files. )divisionabsolute_importprint_functionN) OrderedDict)util) templates) yaml_util) ConfigSource EnvSource YamlSource)ConfigTypeError NotFoundError ConfigErrorz config.yamlzconfig_default.yamlrootREDACTEDc@sFeZdZdZdZ ddZddZddZd d Zd d Z d dZ ddZ ddZ ddZ ddZddZdJddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-ZdJd.d/Zejfd0d1Zd2d3Zd4d5Zd6d7Z d8d9Z!dKd;d<Z"dLd=d>Z#d?d@Z$dAdBZ%e&dCdDZ'e'j(dEdDZ'dFdGZ)dHdIZ*dS)M ConfigViewalA configuration "view" is a query into a program's configuration data. A view represents a hypothetical location in the configuration tree; to extract the data from the location, a client typically calls the ``view.get()`` method. The client can access children in the tree (subviews) by subscripting the parent view (i.e., ``view[key]``). NcCt)zThe core (internal) data retrieval method. Generates (value, source) pairs for each source that contains a value for this view. May raise `ConfigTypeError` if a type error occurs while traversing a source. NotImplementedErrorselfrc/var/www/html/riverr-enterprise-integrations-main/venv/lib/python3.10/site-packages/confuse/core.pyresolve7szConfigView.resolvecCs4|}zt|WStytd|jw)zReturn a (value, source) pair for the first object found for this view. This amounts to the first element returned by `resolve`. If no values are available, a `NotFoundError` is raised. z {0} not found)rr iter_first ValueErrorrformatname)rpairsrrrfirst?s   zConfigView.firstcCs$z|WdStyYdSw)z@Determine whether the view has a setting in any source. FT)r rrrrrexistsKs   zConfigView.existscCr)zSet the *default* value for this configuration view. The specified value is added as the lowest-priority configuration data source. rrvaluerrraddTzConfigView.addcCr)z*Override* the value for this configuration view. The specified value is added as the highest-priority configuration data source. rr"rrrset[r%zConfigView.setcCr)z?The RootView object from which this view is descended. rrrrrrbszConfigView.rootcCsd|jj|jS)Nz<{}: {}>)r __class____name__rrrrr__repr__gszConfigView.__repr__c cs|z |D]}|VqWdSty=z|D]}|VqWYdSty<|\}}td|jt|jww)z]Iterate over the keys of a dictionary view or the *subviews* of a list view. z+{0} must be a dictionary or a list, not {1}N)keysr sequencer rrtyper()rkeysubviewitem_rrr__iter__js&      zConfigView.__iter__cCs t||S)zGet a subview of this view.)Subviewrr-rrr __getitem__s zConfigView.__getitem__cCs|||idS)zPCreate an overlay source to assign a given key under this view. N)r&)rr-r#rrr __setitem__zConfigView.__setitem__cCs ||SN)r!r3rrr __contains__s zConfigView.__contains__FcCs |tj||r dndddS)aSOverlay parsed command-line arguments, generated by a library like argparse or optparse, onto this view's value. :param namespace: Dictionary or Namespace to overlay this config with. Supports nested Dictionaries and Namespaces. :type namespace: dict or Namespace :param dots: If True, any properties on namespace that contain dots (.) will be broken down into child dictionaries. :Example: {'foo.bar': 'car'} # Will be turned into {'foo': {'bar': 'car'}} :type dots: bool .)sepN)r&r build_dict)r namespacedotsrrrset_argss zConfigView.set_argscCstjr|St|S)z5Get the value for this view as a bytestring. )rPY3 __unicode__bytesgetrrrr__str__s zConfigView.__str__cCst|S)z9Get the value for this view as a Unicode string. )rSTRINGrCrrrrrAzConfigView.__unicode__cCs|S)zDGets the value for this view as a boolean. (Python 2 only.) )__bool__rrrr __nonzero__szConfigView.__nonzero__cCs t|S)zDGets the value for this view as a boolean. (Python 3 only.) )boolrCrrrrrGs zConfigView.__bool__c Csjg}|D],\}}z|}Wnty#td|jt|jw|D] }||vr1||q&q|S)aReturns a list containing all the keys available as subviews of the current views. This enumerates all the keys in *all* dictionaries matching the current view, in contrast to ``view.get(dict).keys()``, which gets all the keys for the *first* dict matching the view. If the object for this view in any source is not a dict, then a `ConfigTypeError` is raised. The keys are ordered according to how they appear in each source. z{0} must be a dict, not {1}) rr*AttributeErrorr rrr,r(append)rr*dicr0cur_keysr-rrrr*s"     zConfigView.keysccs"|D] }|||fVqdS)zIterates over (key, subview) pairs contained in dictionaries from *all* sources at this view. If the object for this view in any source is not a dict, then a `ConfigTypeError` is raised. Nr*r3rrritemss zConfigView.itemsccs|D]}||VqdS)zIterates over all the subviews contained in dictionaries from *all* sources at this view. If the object for this view in any source is not a dict, then a `ConfigTypeError` is raised. NrNr3rrrvaluess  zConfigView.valuesccsnz|\}}Wn tyYdSwt|ttfs'td|jt|j t t |D]}||Vq-dS)zIterates over the subviews contained in lists from the *first* source at this view. If the object for this view in the first source is not a list or tuple, then a `ConfigTypeError` is raised. Nz{0} must be a list, not {1}) r r isinstancelisttupler rrr,r(rangelen)r collectionr0indexrrrr+s   zConfigView.sequencec cs\|D]&\}}zt|}Wnty"td|jt|jw|D]}|Vq%qdS)a_Iterates over all subviews from collections at this view from *all* sources. If the object for this view in any source is not iterable, then a `ConfigTypeError` is raised. This method is intended to be used when the view indicates a list; this method will concatenate the contents of the list from all sources. z {0} must be an iterable, not {1}N)riter TypeErrorr rrr,r()rrVr0itr#rrr all_contentss   zConfigView.all_contentsc Csbt}|D]'\}}|r|jrt||<qz |j|d||<Wqty.|||<Yqw|S)aCreate a hierarchy of OrderedDicts containing the data from this view, recursively reifying all views to get their represented values. If `redact` is set, then sensitive values are replaced with the string "REDACTED". redact)rrOr]REDACTED_TOMBSTONEflattenr rC)rr]odr-viewrrrr_s   zConfigView.flattencCst|||S)aRetrieve the value for this view according to the template. The `template` against which the values are checked can be anything convertible to a `Template` using `as_template`. This means you can pass in a default integer or string value, for example, or a type to just check that something matches the type you expect. May raise a `ConfigValueError` (or its subclass, `ConfigTypeError`) or a `NotFoundError` when the configuration doesn't satisfy the template. )r as_templater#)rtemplaterrrrC's zConfigView.getcC|tS)zBGet the value as a path. Equivalent to `get(Filename())`. )rCrFilenamerrrr as_filename8rFzConfigView.as_filenamecCrd)zOGet the value as a `pathlib.Path` object. Equivalent to `get(Path())`. )rCrPathrrrras_path=rFzConfigView.as_pathcCs|t|S)z\Get the value from a list of choices. Equivalent to `get(Choice(choices))`. )rCrChoice)rchoicesrrr as_choiceBszConfigView.as_choicecCrd)z_Get the value as any number type: int or float. Equivalent to `get(Number())`. )rCrNumberrrrr as_numberHzConfigView.as_numberTcC|tj|dS)zbGet the value as a sequence of strings. Equivalent to `get(StrSeq(split=split))`. )split)rCrStrSeq)rrprrr as_str_seqNr6zConfigView.as_str_seqcCro)z~Get the value as a sequence of pairs of two strings. Equivalent to `get(Pairs(default_value=default_value))`. ) default_value)rCrPairs)rrsrrras_pairsTr6zConfigView.as_pairscCrd)zzGet the value as a (Unicode) string. Equivalent to `get(unicode)` on Python 2 and `get(str)` on Python 3. rCrStringrrrras_strZrnzConfigView.as_strcCs|tjddS)zgGet the value as a (Unicode) string, with env vars expanded by `os.path.expandvars()`. T) expand_varsrvrrrras_str_expanded`r6zConfigView.as_str_expandedcCs d|vS)zdWhether the view contains sensitive information and should be redacted from output. r)get_redactionsrrrrr]hs zConfigView.redactcCs|d|dS)Nr) set_redaction)rflagrrrr]oscCt)z_Add or remove a redaction for a key path, which should be an iterable of keys. rrpathr}rrrr|sszConfigView.set_redactioncCr~)zFGet the set of currently-redacted sub-key-paths at this view. rrrrrr{yszConfigView.get_redactionsF)Tr7)+r( __module__ __qualname____doc__rrr r!r$r&rr)r1r4r5r8r?rDrArHrGr*rOrPr+r[r_rREQUIREDrCrfrhrkrmrrrurxrzpropertyr]setterr|r{rrrrr)sR          rc@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS)RootViewzmThe base of a view hierarchy. This view keeps track of the sources that may be accessed by subviews. cCst||_t|_t|_dS)zCreate a configuration hierarchy for a list of sources. At least one source must be provided. The first source in the list has the highest priority. N)rRsources ROOT_NAMErr& redactions)rrrrr__init__s  zRootView.__init__cCs|jt|dSr7)rrKr of)robjrrrr$z RootView.addcCs|jdt|dSNr)rinsertr rr"rrrr&z RootView.setcCsdd|jDS)Ncss|] }t||fVqdSr7)dict.0srrr sz#RootView.resolve..)rrrrrrszRootView.resolvecCs|jdd=|jdS)zMRemove all sources (and redactions) from this configuration. N)rrclearrrrrrs zRootView.clearcCs|Sr7rrrrrrsz RootView.rootcCs2|r |j|dS||jvr|j|dSdSr7)rr$removerrrrr|s  zRootView.set_redactioncCs|jSr7)rrrrrr{szRootView.get_redactionsN) r(rrrrr$r&rrrr|r{rrrrrs  rc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)r2z4A subview accessed via a subscript of a parent view.cCs||_||_t|jtrd|_n|jj|_t|jts"|jd7_t|jtr5|jd|j7_dSt|jtrH|j|jd7_dSt|jt j rY|j|j7_dS|jt |j7_dS)zCMake a subview of a parent view for a given subscript key. r:r9z#{0}utf-8N) parentr-rQrrintrrBdecoderrErepr)rrr-rrrrs     zSubview.__init__c cs||jD]5\}}z||j}Wn$tyYqty"Yqty5td|jjt |j w||fVqdS)Nz!{0} must be a collection, not {1}) rrr- IndexErrorKeyErrorrYr rrr,r()rrVsourcer#rrrrs"    zSubview.resolvecC|j|j|idSr7)rr&r-r"rrrr&rz Subview.setcCrr7)rr$r-r"rrrr$rz Subview.addcCs |jSr7)rrrrrrrs z Subview.rootcCs|j|jf||dSr7)rr|r-rrrrr|szSubview.set_redactioncsfddjDS)Nc3s.|]}|r|djkr|ddVqdS)rrN)r-)rkprrrrs z)Subview.get_redactions..)rr{rrrrr{rzSubview.get_redactionsN) r(rrrrrr&r$rr|r{rrrrr2s r2csveZdZddejffdd ZddZddZd d Zdd d Z d dZ dddZ dddZ dddZ ddZZS) ConfigurationNTcsdtt|g||_||_||_|jrt|j|_nd|_d |j |_ |r0| dSdS)aMCreate a configuration object by reading the automatically-discovered config files for the application for a given name. If `modname` is specified, it should be the import name of a module whose package will be searched for a default config file. (Otherwise, no defaults are used.) Pass `False` for `read` to disable automatic reading of all discovered configuration files. Use this when creating a configuration object at module load time and then call the `read` method later. Specify the Loader class as `loader`. Nz{0}DIR) superrrappnamemodnameloaderrfind_package_path _package_pathrupper_env_varread)rrrrrr'rrrs  zConfiguration.__init__cCstj|tS)z[Points to the location of the user configuration. The file may not exist. )osrjoin config_dirCONFIG_FILENAMErrrruser_config_pathszConfiguration.user_config_pathcCs"|}|t||jdddS)zAdd the configuration options from the YAML file in the user's configuration directory (given by `config_dir`) if it exists. T)roptionalN)rr$r rrfilenamerrr_add_user_source szConfiguration._add_user_sourcecCs@|jr|jrtj|jt}|t||jddddSdSdS)zAdd the package's default configuration settings. This looks for a YAML file located inside the package for the module `modname` if it was given. T)rrdefaultN) rrrrrDEFAULT_FILENAMEr$r rrrrr_add_default_sources  z!Configuration._add_default_sourcecCs |r||r|dSdS)zFind and read the files for this configuration and set them as the sources for this configuration. To disable either discovered user configuration files or the in-package defaults, set `user` or `defaults` to `False`. N)rrruserdefaultsrrrrs  zConfiguration.readc Cs|jtjvr%tj|j}tjtj|}tj|r$td|jn(t }|D]}tj ||j }tjtj |t rBn q+tj |d|j }zt|W|Styo}z|jtjkrdWYd}~|Sd}~ww)aGet the path to the user configuration directory. The directory is guaranteed to exist as a postcondition (one may be created if none exist). If the application's ``...DIR`` environment variable is set, it is used as the configuration directory. Otherwise, platform-specific standard configuration locations are searched for a ``config.yaml`` file. If no configuration file is found, a fallback path is used. z{0} must be a directoryrN)rrenvironrabspath expanduserisfilerrr config_dirsrrrmakedirsOSErrorerrnoEEXIST)rappdir configdirsconfdirerrrr*s2     zConfiguration.config_dirFcCs|t|||jddS)aParses the file as YAML and inserts it into the configuration sources with highest priority. :param filename: Filename of the YAML file to load. :param base_for_paths: Indicates whether the directory containing the YAML file will be used as the base directory for resolving relative path values stored in the YAML file. Otherwise, by default, the directory returned by `config_dir()` will be used as the base. )base_for_pathsrN)r&r r)rrrrrrset_fileRs  zConfiguration.set_file__cCs2|dur d|j}|t|||jddS)aCreate a configuration overlay at the highest priority from environment variables. After prefix matching and removal, environment variable names will be converted to lowercase for use as keys within the configuration. If there are nested keys, list-like dicts (ie, `{0: 'a', 1: 'b'}`) will be converted into corresponding lists (ie, `['a', 'b']`). The values of all environment variables will be parsed as YAML scalars using the `self.loader` Loader class to ensure type conversion is consistent with YAML file sources. Use the `EnvSource` class directly to load environment variables using non-default behavior and to enable full YAML parsing of values. :param prefix: The prefix to identify the environment variables to use. Defaults to uppercased `self.appname` followed by an underscore. :param sep: Separator within variable names to define nested keys. Nz{0}_)r;r)rrrr&r r)rprefixr;rrrset_env_szConfiguration.set_envc Cs|r |j|d}ndd|jD}t|}|j|_|j|d}tj|tjdddd}d}|jD] }|jr8|}nq/|ra|j rat |j d } | } Wdn1sSwYt || d }|S) aDump the Configuration object to a YAML file. The order of the keys is determined from the default configuration file. All keys not in the default configuration will be appended to the end of the file. :param full: Dump settings that don't differ from the defaults as well :param redact: Remove sensitive information (views with the `redact` flag set) from the output r\cSsg|]}|js|qSr)rrrrr sz&Configuration.dump..Ni)Dumperdefault_flow_styleindentwidthrbr)r_rrryamldumpr rrropenrrestore_yaml_commentsr) rfullr]out_dictr temp_rootyaml_outdefault_sourcerfp default_datarrrrus0       zConfiguration.dumpcCs"|jD] }t|tr|qdS)zReload all sources from the file system. This only affects sources that come from files (i.e., `YamlSource` objects); other sources, such as dictionaries inserted with `add` or `set`, will remain unchanged. N)rrQr load)rrrrrreloads  zConfiguration.reloadTTr)Nr)TF)r(rrr Loaderrrrrrrrrrr __classcell__rrrrrs  ( 'rcs`eZdZdZdfdd Zdfdd Zfdd Zfd d Zfd d ZfddZ Z S) LazyConfigzA Configuration at reads files on demand when it is first accessed. This is appropriate for using as a global config object at the module level. Ncs*tt|||dd|_g|_g|_dS)NF)rrr _materialized _lazy_prefix _lazy_suffix)rrrrrrrs zLazyConfig.__init__Tcsd|_tt|||dS)NT)rrrrrrrrrszLazyConfig.readcs<|js||j|j7_|j|jdd<tt|Sr)rrrrrrrrrrrrrs zLazyConfig.resolvecs:tt|||js|j|j7_|jdd=dSdSr7)rrr$rrrr"rrrr$ zLazyConfig.addcs:tt|||js|j|jdd<|jdd=dSdSr)rrr&rrrr"rrrr&rzLazyConfig.setcstt|g|_g|_dS)z+Remove all sources from this configuration.N)rrrrrrrrrrs zLazyConfig.clearr7r) r(rrrrrrr$r&rrrrrrrs   r) r __future__rrrrrr collectionsrr:rrr rr r r exceptionsr rrrrrr^objectrrr2rrrrrrs.    X*>B