HR-exv*dZddlZddlZddlZddlZddlZddlZddlmZmZddlm Z ddl m Z ddlm Z ddl mZmZddlmZmZdd lmZdd lmZmZdd lmZd d lmZdZGddeZedGddeZGddeZ GddeZ!GddeZ"Gdde#Z$Gdde$Z%Gdd Z&iZ'd*d!Z(dZ)d+d#Z*d,d%Z+d*d&Z,d-d'Z-edd.d(Z.d/d)Z/dS)0aThis module contains classes and functions to standardize access to configuration files for Astropy and affiliated packages. .. note:: The configuration system makes use of the 'configobj' package, which stores configuration in a text format like that used in the standard library `ConfigParser`. More information and documentation for configobj can be found at https://configobj.readthedocs.io . N)contextmanager nullcontext)path) TextWrapper)warn) configobjvalidate)find_current_modulesilence) deprecated)AstropyDeprecationWarningAstropyWarning) resolve_name)get_config_dir)InvalidConfigurationItemWarningConfigurationMissingWarning get_config reload_configConfigNamespace ConfigItemgenerate_configcreate_config_fileceZdZdZdS)rzA Warning that is issued when the configuration value specified in the astropy configuration file does not match the type expected for that configuration value. N__name__ __module__ __qualname____doc__r!r%ceZdZdZdS)"ConfigurationDefaultMissingWarningzxA warning that is issued when the configuration defaults (which should be generated at build-time) are missing. Nrr r!r"r(r(Er&r!r(ceZdZdZdS)ConfigurationChangedWarningz@ A warning that the configuration options have changed. Nrr r!r"r*r*Kr&r!r*ceZdZdZdS)_ConfigNamespaceMetac|jdturdS|D]!\}}t|tr||_"dS)Nr) __bases__objectitems isinstancername)clsr2basesdictkeyvals r"__init__z_ConfigNamespaceMeta.__init__RsX = v % % F   HC#z**   r!N)rrrr8r r!r"r,r,Qs#r!r,c@eZdZdZdZeZ dZdZdZd dZ d dZ dS) ras A namespace of configuration items. Each subpackage with configuration items should define a subclass of this class, containing `ConfigItem` instances as members. For example:: class Conf(_config.ConfigNamespace): unicode_output = _config.ConfigItem( False, 'Use Unicode characters when outputting values, ...') use_color = _config.ConfigItem( sys.platform != 'win32', 'When True, use ANSI color escape sequences when ...', aliases=['astropy.utils.console.USE_COLOR']) conf = Conf() c#K|jjD]\}}t|tr|VdSN __class____dict__r0r1rselfr6r7s r"__iter__zConfigNamespace.__iter__nsP/5577  HC#z**    r!c#~K|jjD]}t|tr|VdS)z'Iterate over configuration item values.N)r=r>valuesr1rr@r7s r"rCzConfigNamespace.valuesvsL>*1133  C#z**    r!c#K|jjD] \}}t|tr||fV!dS)z8Iterate over configuration item ``(name, value)`` pairs.Nr<r?s r"r0zConfigNamespace.items|sT/5577  HC#z** 3h  r!ct||r%|jj||St d|d)a Temporarily set a configuration value. Parameters ---------- attr : str Configuration item name value : object The value to set temporarily. Examples -------- >>> import astropy >>> with astropy.conf.set_temp('use_color', False): ... pass ... # console output will not contain color >>> # console output contains color again... No configuration parameter '')hasattrr=r>set_tempAttributeError)r@attrvalues r"rJzConfigNamespace.set_tempsO( 4   A>*4099%@@ @CDCCCDDDr!Nc|Gt||r$|jj|St d|d|D]}|dS)a Reload a configuration item from the configuration file. Parameters ---------- attr : str, optional The name of the configuration parameter to reload. If not provided, reload all configuration parameters. NrGrH)rIr=r>reloadrKrC)r@rLitems r"rOzConfigNamespace.reloads  tT"" >~.t4;;=== !G!G!G!GHH HKKMM  D KKMMMM  r!c|Qt||r.|jj|}||jdSt d|d|D]}||jdS)a Reset a configuration item to its default. Parameters ---------- attr : str, optional The name of the configuration parameter to reload. If not provided, reset all configuration parameters. NrGrH)rIr=r>set defaultvaluerKrC)r@rLproprPs r"resetzConfigNamespace.resets  tT"" ~.t4*+++ !G!G!G!GHH HKKMM ( (D HHT& ' ' ' ' ( (r!r;) rrrrrAkeysrCr0rJrOrUr r!r"rr[s$ D0  EEE0$((((((r!r) metaclassceZdZdZejZdZ dZ ddZ dZ ddZ dZ e d Zd Zd Zd Zd ZdZdS)ra A setting and associated value stored in a configuration file. These objects should be created as members of `ConfigNamespace` subclasses, for example:: class _Conf(config.ConfigNamespace): unicode_output = config.ConfigItem( False, 'Use Unicode characters when outputting values, and writing widgets ' 'to the console.') conf = _Conf() Parameters ---------- defaultvalue : object, optional The default value for this item. If this is a list of strings, this item will be interpreted as an 'options' value - this item must be one of those values, and the first in the list will be taken as the default value. description : str or None, optional A description of this item (will be shown as a comment in the configuration file) cfgtype : str or None, optional A type specifier like those used as the *values* of a particular key in a ``configspec`` file of ``configobj``. If None, the type will be inferred from the default value. module : str or None, optional The full module name that this item is associated with. The first element (e.g. 'astropy' if this is 'astropy.config.configuration') will be used to determine the name of the configuration file, while the remaining items determine the section. If None, the package will be inferred from the package within which this object's initializer is called. aliases : str, or list of str, optional The deprecated location(s) of this configuration item. If the config item is not found at the new location, it will be searched for at all of the old locations. Raises ------ RuntimeError If ``module`` is `None`, but the module this item is created from cannot be determined. Nastropycddlm}|.td}|d}d}t||z|j}||_||_||_|||rEt|ts0d|D} dd | zd z}| d}nnt|trd }nVt|trd }n>t|trd }n&t|trd }t|}||_||||_| g|_dSt|tr |g|_dS||_dS)Nr) isiterable2Cannot automatically determine get_config module, 3because it is not called from inside a valid modulec,g|]}t|Sr )str.0vs r" z'ConfigItem.__init__..s666AQ666r!zoption(, )booleanintegerfloatstring) astropy.utilsr\r RuntimeErrorrmodule descriptionrr1rajoinboolintrjcfgtype _validate_valrSaliases) r@rSrorsrnrur\msg1msg2dvstrs r"r8zConfigItem.__init__s -,,,,, >(++F~KL"4$;/// &"  ?z,'' 1 <0M0M 166666#dii&6&66<$Qx L$// 1#L#.. 1#L%00 1!L#.. 1""<00   <(((( ?DLLL  % % ##9DLLL"DLLLr!c,||Sr;rR)r@objrMs r"__set__zConfigItem.__set__1sxxr!c||S|Sr;r )r@r{objtypes r"__get__zConfigItem.__get__4s ;Ktvv r!c ||}n<#tj$r*}td|jd|jdd}~wwxYwt |j|j}|||j<dS)a Sets the current value of this ``ConfigItem``. This also updates the comments that give the description and type information. Parameters ---------- value The value this item should be set to. Raises ------ TypeError If the provided ``value`` is not valid for this ``ConfigItem``. z&Provided value for configuration item z not valid: rNrootname) rtr ValidateError TypeErrorr2argsrrnr)r@rMesecs r"rRzConfigItem.set9s" &&u--EE%      F1I     t}===DIsA%A  Ac#K|}|| dV||dS#||wxYw)a Sets this item to a specified value only inside a with block. Use as:: ITEM = ConfigItem('ITEM', 'default', 'description') with ITEM.set_temp('newval'): #... do something that wants ITEM's value to be 'newval' ... print(ITEM) # ITEM is now 'default' after the with block Parameters ---------- value The value to set this item to inside the with block. Nrz)r@rMinitvals r"rJzConfigItem.set_tempVs`*$&&   EEE HHW     DHHW    s >Ac||jt|jd|j}|j}|}|j|ur|j}|j|utj|j d}|&||vr| |jS||}|j|vr||j||j<| |jS)zReloads the value of this ``ConfigItem`` from the relevant configuration file. Returns ------- val : object The new value loaded from the configuration file. TrF interpolation) rRrSrrnrr2parentr ConfigObjfilenameget)r@baseobjsecnamecobjnewobjs r"rOzConfigItem.reloadrs "###T[$GGG,k%%;Dk%%$T]%HHH  f$${{49---G_F 9  !' !2GDI {{49%%%r!c jd|jjd|jd|dt|dd S)N)r=rr2idr@s r"__repr__zConfigItem.__repr__sX '     DDFF  T((     r!c d|jjd|jd|jd|jd|jd|jd|fS)N z: z cfgtype=z defaultvalue=z description=z module=z value=)rpr=rr2rsrSrornrs r"__str__zConfigItem.__str__s|yy>*99di99-T\--7$"3775!155)DK))%4466%%     r!c d}g}t|j|j}|j|vr-|||j|j|jf|jD]}|dd\}}t||j}d|vr|dd\}}n|}d}||vrd|jvr"|jddd}nd}td|d||dt||jd |jd||d t|||||ft|d kr7| |j ||j d d ft|dkr|jdd\}}td|jd||dt||jd dd|Dd t|d d } || S#t j$r"} t%d| jd d } ~ wwxYw)aDReturns the value of this ``ConfigItem``. Returns ------- val : object This item's value, with a type determined by the ``cfgtype`` attribute. Raises ------ TypeError If the configuration value as stored is not this item's type. c|dkrdSd|dS)NrZzat the top-levelz in section []r )sections r" section_namez)ConfigItem.__call__..section_names""}}))0g0000r!r.rrZzConfig parameter 'z' z of the file 'z' is deprecated. Use 'z instead.rNz#' is given by more than one alias (rfcXg|]'}|d d|dd(S)rNr)rp)rcrs r"rez'ConfigItem.__call__..s5VVVQQqTEU1Q3 0 0EUEUEUr!z). Using the first.zConfiguration value not valid: )rrnrr2appendrursplitsplitrget_config_filenamer lenrRrSrprtr rrr) r@roptionsraliasrnr2r new_moduler7rs r"__call__zConfigItem.__call__s   1 1 1 t}=== 9   NNC NDKC D D D\ : :E <<Q//LFDVdm<< } tC} tE| dD]} | j#}|dd|kr*|| vr/| $|d} | %D]}| rD|j&|kr7|j&'|dd}| (d|dd} | (|)|j*dzt3|j+tXtZfrt]|j+dkr| (d|jdt]|j+dkr.| (d|jd|j+dd| (d|jdd/tat4|j+de| (d|jd|j+d d d d d S#1swxYwYd S)apGenerates a configuration file, from the list of `ConfigItem` objects for each subpackage. .. versionadded:: 4.1 Parameters ---------- pkgname : str or None The package for which to retrieve the configuration object. filename : str or file-like or None If None, the default configuration path is taken from `get_config`. ignore)categoryr)rprefix)testtests setup_package_Nz## N)initial_indentsubsequent_indentwidthwc|jSr;)r)rs r"z!generate_config..sQ\r!)r6rTrZ[z] Frz# z = , rz = z, ,z )1rr r Warning importlib import_modulewarningscatch_warnings simplefilterpkgutil walk_packages__path__r module_finderrendswithr2r startswith contextlibsuppress ImportErrorrr ExitStackr1raosPathLike enter_contextopenr__subclasses__rRsortedraddrCrnreplacewritefillrorStuplelistrrpmap)rrverbose verbosityfilter_warningspackagemodwrapperstackfp subclasses processedconf print_modulerPmodnames r"rr^ss" 3 !%g..G 22h-//22hAAAA(!'*:S*@   2 2C %../@AA SXEVEVFF x~~c""2&11#66 $[11 2 2'111 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2222222222222222222222222222222"%rRRRG&w//    0I5 hbk 2 3 3 $$T(C%8%899BBB%3355 EE :+A+ABBB% I% ID/Cyy~~a G++i c"""L  I I){g--"&+"5"5mmmR"H"H!3W!3!3!3444#(Ld&677$>???d/%?? I4,--22!9di!9!9!9::::T.//144!Odi!O!OD4Ea4H!O!O!OPPPPLLL #S$2C)D)D E ELLL HHG$)GG0AGGGHHHH+ I!% I0I0I0I0I0I0I0I0I0I0I0I0I0I0I0I0I0I0IsmE+CED; / E;D? ?ED? E E+E E+E E++E/2E/,I2P,,P03P0ct|d|}|j|ur|j}|j|u|dS)aReloads configuration settings from a configuration file for the root package of the requested package/module. This overwrites any changes that may have been made in `ConfigItem` objects. This applies for any items that are based on this file, which is determined by the *root* package of ``packageormod`` (e.g. ``'astropy.cfg'`` for the ``'astropy.config.configuration'`` module). Parameters ---------- packageormod : str or None The package or module name - see `get_config` for details. rootname : str or None Name of the root configuration directory - see `get_config` for details. TrN)rrrO)rrrs r"rrsL$ \4( ; ; ;C *C  j *C  JJLLLLLr!ctj|}tj|d}t d|D S)z Determines if a config file can be safely replaced because it doesn't actually contain any meaningful content, i.e. if it contains only comments or is completely empty. Trc3<K|]}t|dkVdS)rN)rrbs r" z*is_unedited_config_file..s,88!3q66A:888888r!)ioStringIOrranyrC)contenttemplate_contentbufferraw_cfgs r"is_unedited_config_filersR [ ! !F!&===G88w~~'7'788888 88r!c vtj|rtj||dz}n|}tj|sdSt ||j}t |d5}|}dddn #1swxYwYd}|tj|rVt |d5} | } dddn #1swxYwY| |k} | st| |}n*tjtj |rd}d} |t|d}|rEd |vrA|?tjt||d |d} tj|  } nd} |s| r| rbt | d d5}| |dddn #1swxYwY| s!|std |d |d| dt|rC| sAt |d d5}| |dddn #1swxYwYdSdS)a Checks if the configuration file for the specified package exists, and if not, copy over the default configuration. If the configuration file looks like it has already been edited, we do not write over it, but instead write a file alongside it named ``pkg.version.cfg`` as a "template" for the user. Parameters ---------- pkg : str The package to be updated. default_cfg_dir_or_fn : str The filename or directory name where the default configuration file is. If a directory name, ``'pkg.cfg'`` will be used in that directory. version : str, optional The current version of the given package. If not provided, it will be obtained from ``pkg.__version__``. rootname : str Name of the root configuration directory. Returns ------- updated : bool If the profile was updated, `True`, otherwise `False`. Raises ------ AttributeError If the version number of the package could not determined. rFrlatin-1encodingNT __version__devrrzThe configuration options in  z may have changed, your configuration file was not updated in order to preserve local changes. A new configuration template has been saved to 'z'.)risdirrpisfilerrrreadexistsrdirnamerrrrr*)pkgdefault_cfg_dir_or_fnversionr default_cfgfnrfrrdoupdatefdr identical template_pathneeds_templatefws r"update_default_configrsB z'((. "7vFF - ;} % %u sX . . . 7E mi 0 0 0%B7799%%%%%%%%%%%%%%%H  ;u   ei000 $B'')) $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ #33I N27  mS9=== +)*** + + + + + + + + + + + + + + +  X r0sm 22222222 8888888866666666//////NNNNNNNN444444!!!!!! n E.z . 4c(c(c(c(c( 4c(c(c(c(Lp8p8p8p8p8p8p8p8j QQQQh\I\I\I\I~2 9 9 9 9  E````F555555r!