G@dDPdZddlZddlZddlZddlZddlZddlmZ ddl Z ddl Z ddl Z ddl mZmZddlmZmZddlmZGddZGdd ejeZGd d eZGd d eZGddeZGddeZGddeZdS)z This module provides user configuration file management features for Spyder. It is based on the ConfigParser module present in the standard library. N) get_conf_pathget_module_source_path)is_text_stringto_text_string) check_versionceZdZdS) NoDefaultN)__name__ __module__ __qualname__2lib/python3.11/site-packages/spyder/config/user.pyr r !sDrr cDeZdZdZfdZdZfdZdZdZdZ xZ S)DefaultsConfigzM Class used to save defaults to a file and as UserConfig base class. c&tt|d||_||_t jt j|js-tj t j|jdSdS)zU Class used to save defaults to a file and as UserConfig base class. N) interpolation) superr__init___name_pathospisdirdirnameosmakedirs)selfnamepath __class__s rrzDefaultsConfig.__init__-s~ nd##,,4,@@@  yTZ0011 1 K DJ// 0 0 0 0 0 1 1rcJ|jr|dtj|jD]Q\}}t |dd}|d||R|d|jD]}|d||j|D]\}}|dkr ||j |j kr  HHX__R^44 5 5 5 $ 4 4 6 6 J J e),U););D&)I)I&++C1GHHIIII HHTNNN~  G HHX__W-- . . . $w 7 = = ? ? - - e*$$%4<4;+F+F*511E-2]]4-H-H***c+A%BCCCs++,,,, HHTNNNN  rc<||s||t|st|}|r&d|||}t |t t||||dS)z Set method.z [{}][{}] = {}N) has_section add_sectionrreprr%printrrset)rr3optionr1verbosetextr s r_setzDefaultsConfig._setVs(( &   W % % %e$$ KKE  "))'65AAD $KKK nd##''?????rcr}fd} ||dS#t$r tj|rt j|t jd||YdS#t$r*}tdt|Yd}~YdSd}~wwxYwwxYw)z*Save config into the associated .ini file.ctj|dd5}|ddddS#1swxYwYdS)Nwutf-8encoding)ioopenr$)fpath configfilers r _write_filez)DefaultsConfig._save.._write_filehsg666 '* :&&& ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' 's<AAg?zOFailed to write user configuration file to disk, with the exception shown belowN) get_config_fpathEnvironmentErrorrisfilerremovetimesleep Exceptionr9)rrGrIes` r_savezDefaultsConfig._saveds%%'' ' ' ' ' '   K         :e$$%Ie$$$ 4    E""""""   2333a  s- ) B6AA>> B2B-&B6-B22B6cn|j}tj|d|j}|S)z7Return the ini file where this configuration is stored.z{}.ini)rrr.r%r)rr config_files rrJzDefaultsConfig.get_config_fpath~s.zhtX__TZ%@%@AA rcb|D]+\}}|D]#}||}||||d$,dS)z8Set default values and save to defaults folder location.F)r<N)r>)rdefaultsr3optionsr; new_values r set_defaultszDefaultsConfig.set_defaultssa ( E E GW! E E#FO  '69e DDDD E E Er) r r r __doc__rr4r>rRrJrY __classcell__r s@rrr(s 1 1 1 1 1: @ @ @ @ @4 EEEEEEErrc:eZdZdZdZ d$fd ZedZedZed Z d Z e d Z d%d Z d ZdZdZd&dZdZdZd'dZd%dZd'dZd'dZd(dZd)dZd*dZdZdZeffd ZdZd+dZ fd Z!fd!Z"d"Z#d#Z$xZ%S), 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 tt|||||_|||_||_|rdnd|_||_| |_ td|_ d|_ d|_ d|_d|_|||_|r||r|} || ||} | |_||j|||| kr\|r|| || |r|| ||d ||d Sd Sd S) z(UserConfig class, based on ConfigParser.rrrspyderrVbackupsz.bakversion) old_versionFsaveN)rr^r_load_check_version_version_backup_raw_remove_obsolete_external_pluginr_module_source_path_defaults_folder_backup_folder_backup_suffix_defaults_name_prefix_check_defaultsrV _make_backupget_previous_config_fpath_load_from_ini get_version _old_version_save_new_defaults_get_minor_versionapply_configuration_patches_remove_deprecated_options set_versionset_as_defaults) rrrrVloadrfbackupraw_moderemove_obsoleteexternal_pluginprevious_fpathrgr s rrzUserConfig.__init__s j$((d(>>> ++G44  !(AAq / /#9(#C#C *'$%/",,X66         '!;;==N    / / /**733K +D   # #DM 2 2 2''00..{;;<<;%%k%:::00[0III#A33K@@@  u 555$$&&&&&9 ' '4 rc<|d|dS)z3Return the 'major.minor' components of the version.N.)rfindres rr}zUserConfig._get_minor_versions!* c***++rc<|d|dS)z,Return the 'major' component of the version.Nr)findres r_get_major_versionzUserConfig._get_major_versions!) S)))**rc|tjd|}|$|"td||S)z'Check version is compliant with format.z^(\d+).(\d+).(\d+)$NzDVersion number {} is incorrect - must be in major.minor.micro format)rematch ValueErrorr%)rf regex_checks rrkzUserConfig._check_versionsMh5w??  ;#688>wII Irc| |jifg}nt|tr |j|fg}nt|tr\|D]X\}}t |sJt|tsJ|D]\}}t |sJYnt d||_||d|S)z7Check if defaults are valid and update defaults values.Nz.`defaults` must be a dict or a list of tuples!Frh) DEFAULT_SECTION_NAME isinstancedictlistrr(rrVreset_to_defaults)rrVsecrWopt_s rrvzUserConfig._check_defaultss  2B78HH $ ' ' O2H=>HH $ ' ' O ( / / W%c*****!'400000%mmoo//FC)#....../ / MNN N!    " " " . . .rc||j}nt|stdt|std|S)zCheck section and option types.Nz#Argument 'section' must be a stringz"Argument 'option' must be a string)rr RuntimeError)clsr3r;s r_check_section_optionz UserConfig._check_section_optionsX ?.GG(( FDEE Ef%% ECDD Drc8|}|||}tj|}t j|stj| tj ||dS#t$rYdSwxYw)a Make a backup of the configuration file. If `old_version` is `None` a normal backup is made. If `old_version` is provided, then the backup was requested for minor version changes and appends the version number to the backup file. )rfrgN) rJget_backup_fpath_from_versionrrrrrrshutilcopyfileIOError)rrfrgrG fpath_backuprs rrwzUserConfig._make_backup"s%%''99:66 w|,,y  K     OE< 0 0 0 0 0    DD s4B BBc ||ddS#tj$rd}t|YdSwxYw)z;Load config from the associated .ini file found at `fpath`.rBrCz*Warning: File contains no section headers.N)readr&MissingSectionHeaderErrorr9)rrG error_texts rryzUserConfig._load_from_ini7s]  IIegI . . . . .+   EJ *       s  ??ctj}||\}}|t j||dz|S)zRead old defaults.z.ini)r& ConfigParser#get_defaults_path_name_from_versionrrr.)rrg old_defaultsrrs r_load_old_defaultszUserConfig._load_old_defaults?sP(( ==kJJ d#(477888rc|\}}t||}tj|s+|||dSdS)zSave new defaults.raN)rrrrLrJrYrR)rrVrr new_defaultss rr|zUserConfig._save_new_defaultsFs}==?? d%4d;;; z,7799:: !  % %h / / /     ! !rc*||}|D]z\}}|D]r}||} |||} n##tjtjf$rd} YnwxYw| t || kr|||||s{dS)z*Update defaults after a change in version.N)rgetr&NoSectionError NoOptionErrorrr>) rrVrgr<rr3rWr;rXold_vals r_update_defaultszUserConfig._update_defaultsNs..{;; ( C C GW! C C#FO #*..w??GG)2+;<###"GGG#?nY&?&?7&J&JIIgvy'BBB C C CsAA! A!c||}|D]}|||jD]\}}|||t ur |||t|||jdkr|||#tj $r||YwxYwdS)zX Remove options which are present in the .ini file but not in defaults. rawrN) rsectionsr(rn get_defaultr remove_optionlenremove_sectionr&r)rrgrr3r;rs rrz%UserConfig._remove_deprecated_options\s..{;; #,,.. 5 5G)//TY/GG 5 5 ##GV44 AA5**7F;;;tzz'tyzAABBaGG //888,555++G444445 B 5 5 5s+AC$C+*C+c*|S)z1Return the last configuration file used if found.rJrs rrxz$UserConfig.get_previous_config_fpathms$$&&&rc*|S)z Return the configuration path for given version. If no version is provided, it returns the current file path. rrrfs rget_config_fpath_from_versionz(UserConfig.get_config_fpath_from_versionqs $$&&&rcH|}tjtj||j}tj|tj|}|d||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{}{}{}-{}{})rJrr.rrsbasenamer%rt)rrfrgrGr new_fpath backup_fpaths rrz(UserConfig.get_backup_fpath_from_versionys%%''x E**D,?@@HT3<#6#677 ?!==D4GHHLL$++Iw,0,?AALrc.|r|n|j}tjtj||j}d|j|j|}tj |stj |||fS)zz Get defaults location based on version. To be overridden if versions changed defaults location. z{}-{}-{}) rlrr.rrJrrr%rurrrr)rrgrf defaults_pathrs rrz.UserConfig.get_defaults_path_name_from_versions "-?++$-T-B-B-D-D!E!E!%!688    & J    y'' ' K & & &d""rcdS)z Apply any patch to configuration values on version changes. To be overridden if patches to configuration values are needed. Nr )rrgs rr~z&UserConfig.apply_configuration_patchess r0.0.0c:||jd|S)z0Return configuration (not application!) version.rf)rrrs rrzzUserConfig.get_versionsxx19gFFFrcl||}||jd||dS)z-Set configuration (not application!) version.rfrhN)rkr:r)rrfris rrzUserConfig.set_versions8%%g.. *IwTJJJJJrc|jD]6\}}|dks||kr%|D]"}||}|||||#7|r|dSdS)zReset config to Default values.N)rVr>rR)rrir<r3rrWr;r1s rrzUserConfig.reset_to_defaultss M ; ;LC$'S..%;;F#FOEIIc65'::::   JJLLLLL  rc&g|_|D]t}i}|||jD]7\}} t j|}n#t tf$rYnwxYw|||<8|j||fudS)z%Set defaults from the current config.rN) rVrr(rnast literal_eval SyntaxErrorrappend)rr3secdictr;r1s rrzUserConfig.set_as_defaultss }} 5 5GG!%G!C!C ( ( ,U33EE#Z0D"' M '7!3 4 4 4 4 5 5sAA+*A+c|||}|jD]\}}||kr||vr ||}nt}|S)z Get default value for a given `section` and `option`. This is useful for type checking in `get` method. )rrVr )rr3r;rrWr1s rrzUserConfig.get_defaults[ ,,Wf== M  LCg~~W$$#FOEEE rcJ|||}||s2|turtj||||||s7|turtj|||||||Stt| |||j }| ||}t|trt!j|}nt|t$rt%|}nbt|t&rt'|}n=t)|rn- t!j|}n#t*t,f$rYnwxYw|S)ad Get an option. Parameters ---------- section: str Section name. If `None` is provide use the default section name. option: str Option name for `section`. default: Default value (if not specified, an exception will be raised if option doesn't exist). r)rr6r r&rr7 has_optionrr:rr^rrnrrboolrrfloatintrrr)rr3r;defaultr1 default_valuer s rrzUserConfig.gets,,Wf==(( *)##'000  )))w// )##&vw777&'222j$''++GV+KK((&99 mT * * $U++EE  u - - %LLEE  s + + JJEE M * *   (//,     s7F F F cb|||}|jD]\}}||kr|||<dS)z Set Default value for a given `section`, `option`. If no defaults exist, no default is created. To be able to set defaults, a call to set_as_defaults is needed to create defaults based on current values. N)rrV)rr3r;rrrWs r set_defaultzUserConfig.set_default sK,,Wf== M 0 0LCg~~"/ 0 0rc|||}|||}|tur|}||||t |t rt |}nht |t rt |}nCt |trt|}nt|st|}| |||||r| dSdS) Set an `option` on a given `section`. If section is None, the `option` is added to the default section. N) rrr rrrrrrr8r>rR)rr3r;r1r<rirs rr:zUserConfig.sets  ,,Wf==((&99 I % %!M   Wfm < < < mT * * KKEE  u - - %LLEE  s + + JJEE .. KKE '65'222   JJLLLLL  rctt|||dSz+Remove `section` and all options within it.N)rr^rrR)rr3r s rrzUserConfig.remove_section2s2 j$..w777 rctt||||dSzRemove `option` from `section`.N)rr^rrR)rr3r;r s rrzUserConfig.remove_option7s4 j$--gv>>> rcRtj|dS)z&Remove .ini file associated to config.N)rrMrJrs rcleanupzUserConfig.cleanup<s$ $''))*****rcg}|||jD]O}i}||D]\}}|||||<|||fP|S)z Return in list format. The format is [('section1', {'opt-1': value, ...}), ('section2', {'opt-2': othervalue, ...}), ...] )ryrJr+r(rr)rrr3sec_datar;rs rto_listzUserConfig.to_list@s  D1133444~ 5 5GH#zz'22 = = #'88GV#<#<    ( 3 4 4 4 4rNTNFFFFNN)FN)r)rT)TFNFT)&r r r rZrr staticmethodr}rrkrv classmethodrrwryrr|rrrxrrrr~rzrrrrr rrr:rrrrr[r\s@rr^r^s<"EI?D!&5'5'5'5'5'5'r,,\,++\+\0  [ *!!! C C C C 5 5 5"'''''''&####&    GGGGKKKK  5 5 5",5//////b 0 0 04  +++rr^cBeZdZdZddZdfd Zdfd ZddZxZS) SpyderUserConfigc|}|jr|g}n.|tjt dg}|D]}t j|rn|S)z] Override method. Return the last configuration file used if found. spyder.ini)rJrprrr.rrrL)rrGprevious_pathss rrxz*SpyderUserConfig.get_previous_config_fpathTs %%''   #WNN ]__l;; N$  Ez%     rNc||jr|}nGt|ddr"tjt d}n|}|S)z Override method. Return the configuration path for given version. If no version is provided, it returns the current file path. N51.0.0> &99  '))   Gi=88!.4466 G G 611&2EFFFF98 G Grc|||}|j|d}||j|j}|S)z:Get the correct configuration based on section and option.N)_get_name_from_maprrr)rr3r;r config_values r _get_configzMultiUserConfig._get_configsM&&w77(,,T488  ,T-CDLrcg}|D]T\}}|D]L\}}|D]D}||f}||vr|| d||} t| MU|S)z,Check `name_map` follows the correct format.z=Different files are holding the same section/option: "{}/{}"!)r(rr%r) rrsections_optionsrsec_optsr3rWr;sec_opt error_msgs rrzMultiUserConfig._check_name_maps#>>++ 4 4KAx$, 4 4 % 4 4F&/G&666(//888877=vgv7N7N")333 4 4rcn|D]\}}||kr|}n#td||S)z+Get the section contents from the defaults.zsection "{}" not found!)rr%)rVr3rrWr1s r_get_section_from_defaultsz*MultiUserConfig._get_section_from_defaultssU% H HLC#~~6==gFFGG G rcjt}|D](\}}||kr||t}n)|S)z/Get the section,option value from the defaults.)r r)rVr3r;r1rrWs r_get_option_from_defaultsz)MultiUserConfig._get_option_from_defaults"sI$  LC#~~ FI66 rcd}t|D]\}\}}||kr|}n|||dSdS)zRemove section from defaults.N) enumeratepop)rVr3 idx_removeidxrrs r_remove_section_from_defaultsz-MultiUserConfig._remove_section_from_defaults,sh &x00  MC#q#~~   ! LL      " !rcZ|D]'\}}||kr||vr||dS(dS)z$Remove section,option from defaults.N)r')rVr3r;rrWs r_remove_option_from_defaultsz,MultiUserConfig._remove_option_from_defaults8sO%  LC#~~W$$KK'''EE   rc|jD]e\}}|j|j}||kr+|D]7\}}||kr,t |dkr|ccS|D]}||kr|cccS8fdS)zT Search for section and option on the name_map and return the name. rN)rr(rrrr) rr3r;rrdefault_sec_namerrWrs rrz"MultiUserConfig._get_name_from_mapAs#n2244 , ,ND(#044T::O ''' ( , , W'>>7||q((# #*,,C"f}}'+  -  , , ,rci}tj|}|D]\}}g}t|dkr|||< |D]\}} t| dkr-|||} |||nCi} | D]>} |||| } | tur| | | <|||| ?| || f|||<|S)z-Split the global defaults using the name_map.r) r deepcopyr(rr"r*r$r r,r) rrVrname_map_config defaults_copyrrdefault_map_for_namer3rWrrvals rr z*MultiUserConfig._get_defaults_for_name_mapSsh h// &nn.. = =ND(#% 8}}!!(5%%(0@@$GW7||q((!<<]=DFF99-:ACCCC !#*KKC"%"?"? @G#N#NC")33+.C <<]=DcKKKK)//#????(<%%rctS)z#Return the UserConfig class to use.)rrs rrz MultiUserConfig.get_config_class|srct}|jD]1\}}|D]}||2t t |S)z.Return all sections of the configuration file.)r:rr(raddrsorted)rrrrr3s rrzMultiUserConfig.sectionssx55*0022 & &IAv!??,, & & W%%%% &F8$$%%%rc||d}||j|j}||r||SdS)z9Return all the items option/values for the given section.Nr3)rrrr6r(rr3rs rr(zMultiUserConfig.itemss[!!'400 >&t'=>F   g & & <<<00 04rcZ||d}||S)z-Return all the options for the given section.Nr:)rrWr;s rrWzMultiUserConfig.optionss+!!'400~~g~...rc|||}||j|j}|||S)z Get Default value for a given `section` and `option`. This is useful for type checking in `get` method. )rrrrrr3r;rs rrzMultiUserConfig.get_defaultsD !!'622 >&t'=>F!!'6222rc|||}||j|j}||||S)z Get an `option` on a given `section`. If section is None, the `option` is requested from default section. N)r3r;r)rrrr)rr3r;rrs rrzMultiUserConfig.getsF !!'622 >&t'=>Fzz'&'zJJJrcf|||}||||||dS)r)r3r;r1r<riN)rr:)rr3r;r1r<rirs rr:zMultiUserConfig.setsI !!'622 76"  / / / / /rcp|jD]\}}||dS)z&Reset configuration to Default values.r:N)rr(r)rr3rrs rrz!MultiUserConfig.reset_to_defaultssH*0022 6 6IAv  $ $W $ 5 5 5 5 6 6rc\||d}||dSr)rrr;s rrzMultiUserConfig.remove_sections1!!'400g&&&&&rc^|||}|||dSr)rrr>s rrzMultiUserConfig.remove_options3!!'622Wf-----rc|jD]+\}}tj|,dS)z/Remove .ini files associated to configurations.N)rr(rrMrJ)rrrs rrzMultiUserConfig.cleanupsM*0022 1 1IAv If--// 0 0 0 0 1 1rrrrr)r r r rZrrrrrr"r$r*r,rrr rrr(rWrr rr:rrrrr rrrrs!IM?D!&0G0G0G0Gd$  \ \  \ \,,,,$&&[&P   &&&   /// 3 3 3,5 K K K K////6666 ''' ... 11111rrceZdZdZdS) PluginConfigzPlugin configuration handler.N)r r r rZr rrrFrFs''''rrFceZdZdZdZdS)PluginMultiConfigz4Plugin configuration handler with multifile support.ctSr)rFrs rrz"PluginMultiConfig.get_config_classsrN)r r r rZrr rrrHrHs)>>rrH)rZr configparserr&r rEros.pathrrrrrNspyder.config.baserrspyder.py3compatrrspyder.utils.programsrr robjectrr^rrrFrHr rrrPs   EDDDDDDD;;;;;;;;//////         aEaEaEaEaER_faEaEaEN@@@@@@@@FgLgLgLgLgLzgLgLgLTQ1Q1Q1Q1Q1fQ1Q1Q1h(((((:(((r