a Ÿ³Ša”ã@s dZddlmZmZddlZddlZddlZddlZddlm Z ddl Z ddl Z ddl Z ddlmZmZddlmZddlmZmZmZddlmZGdd „d ƒZGd d „d ejeƒZGd d „d eƒZGdd„deƒZGdd„deƒZGdd„deƒZ Gdd„deƒZ!dS)z— This module provides user configuration file management features for Spyder. It is based on the ConfigParser module present in the standard library. é)Úprint_functionÚunicode_literalsN)Ú get_conf_pathÚget_module_source_path)Ú configparser)Úis_text_stringÚPY2Úto_text_string)Ú check_versionc@s eZdZdS)Ú NoDefaultN)Ú__name__Ú __module__Ú __qualname__©rrú1lib/python3.9/site-packages/spyder/config/user.pyr #sr csLeZdZdZ‡fdd„Zdd„Z‡fdd„Zdd „Zd d „Zd d „Z ‡Z S)ÚDefaultsConfigzM Class used to save defaults to a file and as UserConfig base class. csZtrtt|ƒ ¡ntt|ƒjdd||_||_t t |j¡¡sVt   t |j¡¡dS)zU Class used to save defaults to a file and as UserConfig base class. N)Z interpolation) rÚsuperrÚ__init__Ú_nameÚ_pathÚospÚisdirÚdirnameÚosÚmakedirs)ÚselfÚnameÚpath©Ú __class__rrr/szDefaultsConfig.__init__cCsê|jrX| d tj¡¡|j ¡D]*\}}t|ƒ dd¡}| d ||¡¡q"| d¡|jD]†}| d |¡¡|j| ¡D]X\}}|dkr’q€|dus¦|j |j krÈt |ƒ}| dd¡}d  ||f¡}| d |¡¡q€| d¡q^dS) zu Write method for Python 2. The one from configparser fails for non-ascii Windows accounts. z[{}] Ú z z{} = {} r Nz = z{} ) Ú _defaultsÚwriteÚformatÚcpZ DEFAULTSECTÚitemsÚstrÚreplaceÚ _sectionsZ_optcreZOPTCREr Újoin)rÚfpÚkeyÚvalueZvalue_plus_end_of_lineÚsectionrrrÚ_write>s"   zDefaultsConfig._writecsV| |¡s| |¡t|ƒs$t|ƒ}|r>d |||¡}t|ƒtt|ƒ |||¡dS)z Set method.z [{}][{}] = {}N) Ú has_sectionÚ add_sectionrÚreprr#ÚprintrrÚset)rr-Úoptionr,ÚverboseÚtextrrrÚ_set[s  zDefaultsConfig._setc s˜ˆ ¡}‡fdd„}z ||ƒWnrty’z*t |¡rDt |¡t d¡||ƒWn4tyŒ}zt dƒt |ƒWYd}~n d}~00Yn0dS)z*Save config into the associated .ini file.csNtj|ddd*}tr"ˆ |¡n ˆ |¡Wdƒn1s@0YdS)NÚwúutf-8©Úencoding)ÚioÚopenrr.r")ÚfpathÚ configfile©rrrÚ _write_filems z)DefaultsConfig._save.._write_filegš™™™™™©?zOFailed to write user configuration file to disk, with the exception shown belowN) Úget_config_fpathÚEnvironmentErrorrÚisfilerÚremoveÚtimeÚsleepÚ Exceptionr2)rr>rAÚerr@rÚ_saveis       zDefaultsConfig._savecCs|j}t |d |j¡¡}|S)z7Return the ini file where this configuration is stored.z{}.ini)rrr)r#r)rrZ config_filerrrrB†szDefaultsConfig.get_config_fpathcCs6|D],\}}|D]}||}|j|||ddqqdS)z8Set default values and save to defaults folder location.F)r5N)r7)rÚdefaultsr-Úoptionsr4Ú new_valuerrrÚ set_defaultsŒs zDefaultsConfig.set_defaults) r r rÚ__doc__rr.r7rJrBrNÚ __classcell__rrrrr*s  rcs:eZdZdZdZdA‡fdd„ Zedd „ƒZed d „ƒZed d „ƒZ dd„Z e dd„ƒZ dBdd„Z dd„Zdd„Zdd„ZdCdd„Zdd„Zdd„ZdDd d!„ZdEd"d#„ZdFd$d%„ZdGd&d'„ZdHd)d*„ZdId+d,„ZdJd-d.„Zd/d0„Zd1d2„Zef‡fd3d4„ Zd5d6„ZdKd7d8„Z ‡fd9d:„Z!‡fd;d<„Z"d=d>„Z#d?d@„Z$‡Z%S)LÚ UserConfigaB UserConfig class, based on ConfigParser. Parameters ---------- name: str Name of the config path: str Configuration file will be saved in path/%name%.ini defaults: {} or [(str, {}),] Dictionary containing options *or* list of tuples (sec_name, options) load: bool If a previous configuration file is found, load will take the values from this existing file, instead of using default values. version: str version of the configuration file in 'major.minor.micro' format. backup: bool A backup will be created on version changes and on initial setup. raw_mode: bool If `True` do not apply any automatic conversion on values read from the configuration. remove_obsolete: bool If `True`, values that were removed from the configuration on version change, are removed from the saved configuration file. Notes ----- The 'get' and 'set' arguments number and type differ from the overriden methods. 'defaults' is an attribute and not a method. ÚmainNTFc stt|ƒj||d||_| |¡|_||_|r4dnd|_||_| |_ t dƒ|_ d|_ d|_ d|_d|_| |¡|_|r€| ¡|r| ¡} | | ¡| |¡} | |_| |j¡| |¡| | ¡kr|rÚ|j| d|j| d |rô| | ¡|j|d d |d ur| ¡d S) z(UserConfig class, based on ConfigParser.©rrérÚspyderrKZbackupsz.bak©Úversion)Ú old_versionF©ÚsaveN)rrQrÚ_loadÚ_check_versionÚ_versionÚ_backupÚ_rawÚ_remove_obsoleteÚ_external_pluginrZ_module_source_pathÚ_defaults_folderÚ_backup_folderÚ_backup_suffixÚ_defaults_name_prefixÚ_check_defaultsrKÚ _make_backupÚget_previous_config_fpathÚ_load_from_iniÚ get_versionÚ _old_versionÚ_save_new_defaultsÚ_get_minor_versionÚapply_configuration_patchesÚ_remove_deprecated_optionsÚ set_versionÚset_as_defaults) rrrrKÚloadrWÚbackupÚraw_modeÚremove_obsoleteÚexternal_pluginZprevious_fpathrXrrrr¸s@      ÿ    zUserConfig.__init__cCs|d| d¡…S)z3Return the 'major.minor' components of the version.NÚ.)ÚrfindrVrrrrmñszUserConfig._get_minor_versioncCs|d| d¡…S)z,Return the 'major' component of the version.Nrw)ÚfindrVrrrÚ_get_major_versionöszUserConfig._get_major_versioncCs.t d|¡}|dur*|dur*td |¡ƒ‚|S)z'Check version is compliant with format.z^(\d+).(\d+).(\d+)$NzDVersion number {} is incorrect - must be in major.minor.micro format)ÚreÚmatchÚ ValueErrorr#)rWZ regex_checkrrrr\ûs  ÿzUserConfig._check_versioncCs¦|dur|jifg}nrt|tƒr.|j|fg}nZt|tƒr€|D]@\}}t|ƒsPJ‚t|tƒs^J‚| ¡D]\}}t|ƒsfJ‚qfqZ fpath_backuprrrrrg*sÿ    zUserConfig._make_backupcCs¨z‚trrt |¡r€zr?Z error_textrrrri?s , zUserConfig._load_from_inicCs0t ¡}| |¡\}}| t ||d¡¡|S)zRead old defaults.z.ini)r$Ú ConfigParserÚ#get_defaults_path_name_from_versionrŒrr))rrXÚ old_defaultsrrrrrÚ_load_old_defaultsRszUserConfig._load_old_defaultscCs<| ¡\}}t||d}t | ¡¡s8| |¡| ¡dS)zSave new defaults.rSN)rŽrrrDrBrNrJ)rrKrrÚ new_defaultsrrrrlYs    zUserConfig._save_new_defaultsc Cs‚| |¡}|D]n\}}|D]`}||}z| ||¡} WntjtjfyTd} Yn0| dusjt|ƒ| kr| ||||¡qqdS)z*Update defaults after a change in version.N)rÚgetr$ÚNoSectionErrorÚ NoOptionErrorr r7) rrKrXr5rr-rLr4rMZold_valrrrÚ_update_defaultsas   zUserConfig._update_defaultsc Cs˜| |¡}| ¡D]€}|j||jdD]j\}}| ||¡tur&z2| ||¡t|j||jdƒdkrn| |¡Wq&t j yŽ| |¡Yq&0q&qdS)zX Remove options which are present in the .ini file but not in defaults. ©ÚrawrN) rÚsectionsr%r_Ú get_defaultr Ú remove_optionÚlenÚremove_sectionr$r“)rrXrr-r4r…rrrroos   z%UserConfig._remove_deprecated_optionscCs| ¡S)z1Return the last configuration file used if found.©rBr@rrrrh€sz$UserConfig.get_previous_config_fpathcCs| ¡S)zˆ Return the configuration path for given version. If no version is provided, it returns the current file path. r©rrWrrrÚget_config_fpath_from_version„sz(UserConfig.get_config_fpath_from_versioncCsZ| ¡}t t |¡|j¡}t |t |¡¡}|durFd ||j¡}nd |||j¡}|S)zþ Get backup location based on version. `old_version` can be used for checking compatibility whereas `version` relates to adding the version to the file name. To be overridden if versions changed backup location. Nú{}{}ú{}-{}{})rBrr)rrcÚbasenamer#rd)rrWrXr>rZ new_fpathÚ backup_fpathrrrr‰Œs ÿz(UserConfig.get_backup_fpath_from_versioncCsT|r|n|j}t t | ¡¡|j¡}d |j|j|¡}t  |¡sLt   |¡||fS)zz Get defaults location based on version. To be overridden if versions changed defaults location. z{}-{}-{}) r]rr)rrBrbr#rerrrr)rrXrWZ defaults_pathrrrrrŽŸsÿý  z.UserConfig.get_defaults_path_name_from_versioncCsdS)z– Apply any patch to configuration values on version changes. To be overridden if patches to configuration values are needed. Nr)rrXrrrrn²sz&UserConfig.apply_configuration_patchesú0.0.0cCs| |jd|¡S)z0Return configuration (not application!) version.rW)r’r~ržrrrrj¼szUserConfig.get_versioncCs"| |¡}|j|jd||ddS)z-Set configuration (not application!) version.rWrYN)r\r3r~)rrWrZrrrrpÀs zUserConfig.set_versioncCsR|jD]:\}}|dks||kr|D]}||}| ||||¡q"q|rN| ¡dS)zReset config to Default values.N)rKr7rJ)rrZr5r-rƒrLr4r,rrrr‚ÅszUserConfig.reset_to_defaultsc Cstg|_| ¡D]`}i}|j||jdD]6\}}zt |¡}WnttfyRYn0|||<q&|j ||f¡qdS)z%Set defaults from the current config.r–N) rKr˜r%r_ÚastÚ literal_evalÚ SyntaxErrorr}Úappend)rr-Zsecdictr4r,rrrrqÏs  zUserConfig.set_as_defaultscCs@| ||¡}|jD]$\}}||kr||vr||}qZprevious_pathsrrrrhysü z*SpyderUserConfig.get_previous_config_fpathNcCs@|dus|jr| ¡}n$t|ddƒr4t tƒd¡}n| ¡}|S)z¢ Override method. Return the configuration path for given version. If no version is provided, it returns the current file path. Nú51.0.0úrrrrŸ•s   z.SpyderUserConfig.get_config_fpath_from_versioncsh|rNt|ddƒrNd}tj tƒ|¡}|durr£Ú super_classrrrr‰¦sÿ ÿz.SpyderUserConfig.get_backup_fpath_from_versioncsf|rHt|ddƒr.d |j|¡}t tƒd¡}q^tt|ƒ}| |¡\}}ntt|ƒ}| ¡\}}||fS)zS Override method. Get defaults location based on version. r»r¼z{}-{}rK) r r#rerr)rrr¹rŽ)rrXrrr½rrrrŽ»s  ÿ   z4SpyderUserConfig.get_defaults_path_name_from_versioncCs^| |j|¡|jrdS|rZt|ddƒrZt| dd¡ƒ}|turZ| dd¡}| dd|¡dS)zg Override method. Apply any patch to configuration values on version changes. Nz44.1.0r¼Zipython_consolezstartup/run_linesú,z; ) r•rKrar r r’r r'r3)rrXZ run_linesrrrrnÏsÿ z,SpyderUserConfig.apply_configuration_patches)N)NN)N)N) r r rrhrŸr‰rŽrnrPrrrrr¹ws  r¹c@sÔeZdZdZdZd.dd„Zdd „Zd d „Zed d „ƒZ edd„ƒZ edd„ƒZ edd„ƒZ d/dd„Z edd„ƒZdd„Zdd„Zdd„Zdd„Zd d!„Zefd"d#„Zd0d$d%„Zd1d&d'„Zd(d)„Zd*d+„Zd,d-„ZdS)2ÚMultiUserConfigaF Multiuser config class which emulates the basic UserConfig interface. This class provides the same basic interface as UserConfig but allows splitting the configuration sections and options among several files. The `name` is now a `name_map` where the sections and options per file name are defined. rUNTFc  Cs| |¡|_||_||_||_||_||_|r2dnd|_||_| |_ i|_ |  ||¡|_ ||||||d| dœ|_ |D]J} |j  | ¡}| |dœ} |j  ¡} |  | ¡| ¡} | fi| ¤Ž|j | <qt|j  |j¡}| |¡}| |j¡}|sò||kr|j  ¡D]\}}| |j¡qüdS)z2Multi user config class based on UserConfig class.rTrF)rrKrrrWrsrtrurv)rrKN)Ú_check_name_mapÚ _name_maprr!r[r]r^Z _raw_moder`raÚ _configs_mapÚ_get_defaults_for_name_mapZ_config_defaults_mapZ_config_kwargsr’ÚcopyÚupdateÚget_config_classÚDEFAULT_FILE_NAMErzrkr%ro)rÚname_maprrKrrrWrsrtrurvrZ mod_kwargsZ new_kwargsZ config_classZdefault_configZ major_verZ major_old_verr…ÚconfigrrrrísN ÿø  þ   ÿzMultiUserConfig.__init__cCs2| ||¡}|j |d¡}|dur.|j|j}|S)z:Get the correct configuration based on section and option.N)Ú_get_name_from_maprÂr’rÇ)rr-r4rZ config_valuerrrÚ _get_configs   zMultiUserConfig._get_configc Csbg}| ¡D]P\}}|D]B\}}|D]4}||f}||vrD| |¡q$d ||¡} t| ƒ‚q$qq |S)z,Check `name_map` follows the correct format.z=Different files are holding the same section/option: "{}/{}"!)r%r¨r#r}) rrÈZsections_optionsr…Úsec_optsr-rLr4Zsec_optZ error_msgrrrrÀ)s  ÿÿzMultiUserConfig._check_name_mapcCs0|D]\}}||kr|}q,qtd |¡ƒ‚|S)z+Get the section contents from the defaults.zsection "{}" not found!)r}r#)rKr-rƒrLr,rrrÚ_get_section_from_defaults;s  z*MultiUserConfig._get_section_from_defaultscCs.t}|D] \}}||kr| |t¡}q*q|S)z/Get the section,option value from the defaults.)r r’)rKr-r4r,rƒrLrrrÚ_get_option_from_defaultsGs   z)MultiUserConfig._get_option_from_defaultscCs@d}t|ƒD]\}\}}||kr |}q*q |dur<| |¡dS)zRemove section from defaults.N)Ú enumerateÚpop)rKr-Z idx_removeÚidxrƒr…rrrÚ_remove_section_from_defaultsQsz-MultiUserConfig._remove_section_from_defaultscCs0|D]&\}}||kr||vr| |¡q,qdS)z$Remove section,option from defaults.N)rÐ)rKr-r4rƒrLrrrÚ_remove_option_from_defaults]s   z,MultiUserConfig._remove_option_from_defaultsc Cs€|j ¡D]p\}}|j |¡j}||kr*q |D]J\}}||kr.t|ƒdkrV|S|D]}||krZ|SqZq.q dS)zT Search for section and option on the name_map and return the name. rN)rÁr%rÂr’r~r›) rr-r4rrÌZdefault_sec_namerƒrLr„rrrrÊfs   z"MultiUserConfig._get_name_from_mapc CsÂi}t |¡}| ¡D]¦\}}g}t|ƒdkr8|||<q|D]v\}} t| ƒdkrj| ||¡} | ||¡n:i} | D]0} | ||| ¡} | tur”| | | <| ||| ¡qr|  || f¡q<|||<q|S)z-Split the global defaults using the name_map.r) rÄÚdeepcopyr%r›rÍrÒrÎr rÓr¨) r‡rKrÈZname_map_configZ defaults_copyrrÌZdefault_map_for_namer-rLrƒr„ÚvalrrrrÃxs6     ÿÿÿÿ z*MultiUserConfig._get_defaults_for_name_mapcCstS)z#Return the UserConfig class to use.)r¹r@rrrrÆ¡sz MultiUserConfig.get_config_classcCs>tƒ}|j ¡D] \}}| ¡D]}| |¡q qtt|ƒƒS)z.Return all sections of the configuration file.)r3rÂr%r˜ÚaddrÚsorted)rr˜r…rÉr-rrrr˜¥s  zMultiUserConfig.sectionscCs>| |d¡}|dur |j|j}| |¡r6|j|dSdSdS)z9Return all the items option/values for the given section.N©r-)rËrÂrÇr/r%©rr-rÉrrrr%®s     zMultiUserConfig.itemscCs| |d¡}|j|dS)z-Return all the options for the given section.NrØ)rËrLrÙrrrrL¹s zMultiUserConfig.optionscCs,| ||¡}|dur |j|j}| ||¡S)z‚ Get Default value for a given `section` and `option`. This is useful for type checking in `get` method. N)rËrÂrÇr™©rr-r4rÉrrrr™¾s  zMultiUserConfig.get_defaultcCs0| ||¡}|dur |j|j}|j|||dS)z„ Get an `option` on a given `section`. If section is None, the `option` is requested from default section. N)r-r4r¯)rËrÂrÇr’)rr-r4r¯rÉrrrr’És  zMultiUserConfig.getcCs$| ||¡}|j|||||ddS)r²)r-r4r,r5rZN)rËr3)rr-r4r,r5rZrÉrrrr3Ös  ÿzMultiUserConfig.setcCs$|j ¡D]\}}|j|dq dS)z&Reset configuration to Default values.rØN)rÂr%r‚)rr-r…rÉrrrr‚àsz!MultiUserConfig.reset_to_defaultscCs| |d¡}| |¡dSr³)rËrœrÙrrrrœås zMultiUserConfig.remove_sectioncCs| ||¡}| ||¡dSr´)rËršrÚrrrršês zMultiUserConfig.remove_optioncCs&|j ¡D]\}}t | ¡¡q dS)z/Remove .ini files associated to configurations.N)rÂr%rrErB)rr…rÉrrrrµïszMultiUserConfig.cleanup)NTNFFFF)NN)FT)N)r r rrOrÇrrËrÀr·rÍrÎrÒrÓrÊr¸rÃrÆr˜r%rLr™r r’r3r‚rœršrµrrrrr¿ás< þ 2       (   r¿c@seZdZdZdS)Ú PluginConfigzPlugin configuration handler.N)r r rrOrrrrrÛõsrÛc@seZdZdZdd„ZdS)ÚPluginMultiConfigz4Plugin configuration handler with multifile support.cCstS)N)rÛr@rrrrÆüsz"PluginMultiConfig.get_config_classN)r r rrOrÆrrrrrÜùsrÜ)"rOZ __future__rrr¥rÄr<rÚos.pathrrr{rŠrFZspyder.config.baserrZspyder.py3compatrr$rrr Zspyder.utils.programsr r rÚobjectrrQr¹r¿rÛrÜrrrrÚs2   mcj