JeD.dZddlZddlZddlZddlZddlZddlmZ ddl Z ddl Z ddl Z ddl mZmZddlmZmZddlmZGddZGdd ej,eZGd d eZGd d eZGddeZGddeZGddeZy)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_versionc eZdZy) NoDefaultN)__name__ __module__ __qualname__4/usr/lib/python3/dist-packages/spyder/config/user.pyr r !srr cDeZdZdZfdZdZfdZdZdZdZ xZ S)DefaultsConfigzM Class used to save defaults to a file and as UserConfig base class. ctt| d||_||_t j t j|js3tjt j|jyy)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,@  yyTZZ01 KK DJJ/ 02rc|jr|jdjtj|jj D]A\}}t |jdd}|jdj||C|jd|jD]}|jdj||j|j D]v\}}|dk(r ||j|jk(r0t|}|jdd}dj||f}|jdj|x|jdy) zu Write method for Python 2. The one from configparser fails for non-ascii Windows accounts. z[{}]  z z{} = {} r Nz = z{} ) _defaultswriteformatcp DEFAULTSECTitemsstrreplace _sections_optcreOPTCRErjoin)rfpkeyvaluevalue_plus_end_of_linesections r_writezDefaultsConfig._write9sB >> HHX__R^^4 5 $ 4 4 6 J e),U););D&)I&++C1GHI J HHTN~~ G HHX__W- . $w 7 = = ? - e*$%4<<4;;+F*51E-2]]4-H***c+A%BCCs+, - HHTN rc|j|s|j|t|s t|}|rdj |||}t |t t|#|||y)z Set method.z [{}][{}] = {}N) has_section add_sectionrreprr%printrrset)rr3optionr1verbosetextr s r_setzDefaultsConfig._setVsa(   W %e$KE "))'65AD $K nd'?rcJj}fd} ||y#t$rx tj|rt j |t jd||Yy#t$r!}tdt|Yd}~Yyd}~wwxYwwxYw)z*Save config into the associated .ini file.ctj|dd5}j|dddy#1swYyxYw)Nwutf-8encoding)ioopenr$)fpath configfilers r _write_filez)DefaultsConfig._save.._write_filehs6g6 '* :& ' ' 's5>g?zOFailed to write user configuration file to disk, with the exception shown belowN) get_config_fpathEnvironmentErrorrisfilerremovetimesleep Exceptionr9)rrGrIes` r_savezDefaultsConfig._saveds%%' '      ::e$IIe$ 4 E" 23a  s-! B"AA44 B=BB"BB"c||j}tj|dj|j}|S)z7Return the ini file where this configuration is stored.z{}.ini)rrr.r%r)rr config_files rrJzDefaultsConfig.get_config_fpath~s.zzhhtX__TZZ%@A rcZ|D]&\}}|D]}||}|j|||d(y)z8Set default values and save to defaults folder location.F)r<N)r>)rdefaultsr3optionsr; new_values r set_defaultszDefaultsConfig.set_defaultssF ( E GW! E#FO  '69e D E Er) r r r __doc__rr4r>rRrJrY __classcell__r s@rrr(s( 1: @4 Errc"eZdZdZdZ d fd ZedZedZedZ dZ e dZ d!d Z d Zd Zd Zd"d ZdZdZd#dZd!dZd#dZd#dZd$dZd%dZd&dZdZdZeffd ZdZd'dZ fdZ!fdZ"dZ#dZ$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. mainc tt| ||||_|j ||_||_|rdnd|_||_| |_ td|_ d|_ d|_ d|_d|_|j!||_|r|j%|r|j'} |j)| |j+|} | |_|j/|j"|j1||j1| k7rL|r|j%| |j3| |r|j5| |j7|d ||j9y y y ) 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(> ++G4  !Aq / /#9(#C *'$%/",,X6      !;;=N    /**73K +D   # #DMM 2''0..{;<%%k%:00[0I#33K@  u 5$$& 5 rc*|d|jdS)z3Return the 'major.minor' components of the version.N.)rfindres rr}zUserConfig._get_minor_versions* c*++rc*|d|jdS)z,Return the 'major' component of the version.Nr)findres r_get_major_versionzUserConfig._get_major_versions) S)**rcntjd|}||tdj||S)z'Check version is compliant with format.z^(\d+).(\d+).(\d+)$zDVersion number {} is incorrect - must be in major.minor.micro format)rematch ValueErrorr%)rf regex_checks rrkzUserConfig._check_versionsDhh5w?  ;#688>wI Irct||jifg}nt|tr|j|fg}njt|trO|D]I\}}t |sJt|tsJ|j D]\}}t |rJKn t d||_||jd|S)z7Check if defaults are valid and update defaults values.z.`defaults` must be a dict or a list of tuples!Frh) DEFAULT_SECTION_NAME isinstancedictlistrr(rrVreset_to_defaults)rrVsecrWopt_s rrvzUserConfig._check_defaultss  22B78H $ '22H=>H $ ' ( / W%c***!'4000%mmo/FC)#.../ / MN N!    " " " .rc|| |j}nt|s tdt|s td|S)zCheck section and option types.z#Argument 'section' must be a stringz"Argument 'option' must be a string)rr RuntimeError)clsr3r;s r_check_section_optionz UserConfig._check_section_optionsA ?..G(DE Ef%CD Drc(|j}|j||}tjj |}t j |stj| tj||y#t$rYywxYw)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"sz%%'99:6 ww|,yy KK   OOE< 0   s.B BBcx |j|dy#tj$rd}t|YywxYw)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_ini7s9  IIegI .++ EJ *  s  99ctj}|j|\}}|jt 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?sE( ==kJ d#((478rc|j\}}t||}tj|j s"|j ||j yy)zSave new defaults.raN)rrrrLrJrYrR)rrVrr new_defaultss rr|zUserConfig._save_new_defaultsFsT==? d%4d; zz,779:  % %h /    ;rc|j|}|D]I\}}|D]?}||} |j||} | t || k7s,|j ||||AKy#tjtjf$rd} YQwxYw)z*Update defaults after a change in version.N)rgetr&NoSectionError NoOptionErrorrr>) rrVrgr<rr3rWr;rXold_vals r_update_defaultszUserConfig._update_defaultsNs..{; ( C GW! C#FO #*..w?G?nY&?7&JIIgvy'B C C ))2+;+;<#"G#sA!!%B B c|j|}|jD]}|j||jD]k\}}|j ||t us |j ||t|j||jdk(r|j|my#tj$r|j|YwxYw)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..{; #,,. 5G)//TYY/G 5 ##GV4 A5**7F;tzz'tyyzABaG //8  5 5,,5++G45s"A B33$CCc"|jS)z1Return the last configuration file used if found.rJrs rrxz$UserConfig.get_previous_config_fpathms$$&&rc"|jS)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 $$&&rcX|j}tjtj||j}tj|tj |}|dj ||j}|Sdj |||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. {}{}{}-{}{})rJrr.rrsbasenamer%rt)rrfrgrGr new_fpath backup_fpaths rrz(UserConfig.get_backup_fpath_from_versionys%%'xx E*D,?,?@HHT3<<#67 ?!==D4G4GHL%++Iw,0,?,?ALrcN|r|n |j}tjtj|j |j }dj |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!E!%!6!68    & & JJ   yy' KK &d""rcy)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 rc<|j|jd|S)z0Return configuration (not application!) version.rf)rrrs rrzzUserConfig.get_versionsxx119gFFrcd|j|}|j|jd||y)z-Set configuration (not application!) version.rfrhN)rkr:r)rrfris rrzUserConfig.set_versions,%%g. **IwTJrc|jD]0\}}|dk(s||k(s|D]}||}|j||||2|r|jyy)zReset config to Default values.N)rVr>rR)rrir<r3rrWr;r1s rrzUserConfig.reset_to_defaultssc MM ;LC$'S.%;F#FOEIIc65':; ;  JJL rc$g|_|jD]a}i}|j||jD] \}} t j |}|||<"|jj||fcy#t tf$rY8wxYw)z%Set defaults from the current config.rN) rVrr(rnast literal_eval SyntaxErrorrappend)rr3secdictr;r1s rrzUserConfig.set_as_defaultss }} 5GG!%G!C ( ,,U3E#(  ( MM '7!3 4 5 $Z0sA==BBc|j||}|jD]\}}||k(s ||vs||}|St}|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= MM LCg~W$#FOE   E rc|j||}|j|s.|turtj||j ||j ||s3|turtj|||j||||Stt|/|||j}|j||}t|trt!j"|}|St|t$r t%|}|St|t&r t'|}|St)|r |S t!j"|}|S#t*t,f$rY|SwxYw)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=()#''00  )w/)#&&vw77&'2j$+GV+K((&9 mT *$$U+E  u -%LE  s +JE M *   ((/  ,   s:EE$#E$cf|j||}|jD]\}}||k(s |||<y)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 s=,,Wf= MM 0LCg~"/ 0rc|j||}|j||}|tur|}|j|||t |t r t |}nNt |t r t |}n2t |tr t|}nt|s t|}|j|||||r|jyy) 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=((&9 I %!M   Wfm < mT *KE  u -%LE  s +JE .KE '65'2  JJL rcLtt| ||jyz+Remove `section` and all options within it.N)rr^rrR)rr3r s rrzUserConfig.remove_section2s j$.w7 rcNtt| |||jyzRemove `option` from `section`.N)rr^rrR)rr3r;r s rrzUserConfig.remove_option7s j$-gv> rcJtj|jy)z&Remove .ini file associated to config.N)rrMrJrs rcleanupzUserConfig.cleanup<s $'')*rcg}|j|j|jD]E}i}|j|D]\}}|j ||||<|j ||fG|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  D1134~~ 5GH#zz'2 = #'88GV#<  =   ( 3 4  5 rNTNFFFFNN)FN)0.0.0)rT)TFNFT)&r r r rZrr staticmethodr}rrkrv classmethodrrwryrr|rrrxrrrr~rzrrrrr rrr:rrrrr[r\s@rr^r^s<"EI?D!&5'r,,++0  *! C 5"''&#& GK  5",5/b 04  +rr^cBeZdZdZddZdfd Zdfd ZddZxZS)SpyderUserConfigc|j}|jr|g}n*|tjj t dg}|D]}t j|s|S|S)z] Override method. Return the last configuration file used if found. spyder.ini)rJrprrr.rrrL)rrGprevious_pathss rrxz*SpyderUserConfig.get_previous_config_fpathTsp %%'  #WN ]_l; N$ Ezz%    rc| |jr|j}|St|ddr tjt d}|S|j}|S)z Override method. Return the configuration path for given version. If no version is provided, it returns the current file path. 51.0.0dj|j|}tjt d}||fSt t|}|j|\}}||fSt t|}|j\}}||fS)zS Override method. Get defaults location based on version. rrz{}-{}rV) rr%rurr.rrrr)rrgrrrr s rrz4SpyderUserConfig.get_defaults_path_name_from_versions [(C8~~d&@&@+Nxx <Tz$$4d; (LL! d Tz 0$7K$HHJJD$Tzrc |j|j||jry|rXt|ddrJt |j dd}|t ur&|jdd}|jdd|yyyy)zg Override method. Apply any patch to configuration values on version changes. Nz44.1.0ripython_consolezstartup/run_lines,z; ) rrVrprrrr r*r:)rrg run_liness rr~z,SpyderUserConfig.apply_configuration_patchess dmm[9   =hD&txx0A0C(EFI )%--c48 *,?K*E;rrr) r r r rxrrrr~r[r\s@rrrRs8"*(LrrceZdZdZdZ ddZdZdZedZ edZ ed Z ed Z dd Z ed Zd ZdZdZdZdZefdZddZddZdZdZdZy)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. rcNc |j||_||_||_||_||_||_|rdnd|_||_| |_ i|_ |j|||_ ||||||d| d|_ |D]r} |jj| }| |d} |jj} | j!| |j#} | di| |j| <t|jj|j$}|j'|}|j'|j(}|s||k7r>|jj+D] \}}|j-|j("yy)z2Multi user config class based on UserConfig class.rbrF)rrVrrfrrrr)rrVNr )_check_name_map _name_maprr#rjrlrm _raw_moderorp _configs_map_get_defaults_for_name_map_config_defaults_map_config_kwargsrcopyupdateget_config_classDEFAULT_FILE_NAMErr{r(r)rname_maprrVrrfrrrrr mod_kwargs new_kwargs config_classdefault_config major_ver major_old_verrconfigs rrzMultiUserConfig.__init__s--h7 !   &A / /$($C$CHDL%N!  $.   AD0044T:H$J,,113J   j )002L&2&@Z&@D  d # A**..t/E/EF"55g> &99  ' ')  i=8!..446 G 611&2E2EF G9rc|j||}|jj|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_configsP&&w7((,,T48  ,,T-C-CDLrcg}|jD]L\}}|D]B\}}|D]8}||f}||vr|j|dj||} t| DN|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#>>+ 4KAx$, 4 % 4F&/G&66(//877=vgv7N")33 4 4 4rc^|D]\}}||k(s |}|Stdj|)z+Get the section contents from the defaults.zsection "{}" not found!)rr%)rVr3rrWr1s r_get_section_from_defaultsz*MultiUserConfig._get_section_from_defaultssH% HLC#~  H 6==gFG Grcbt}|D]#\}}||k(s |j|t}|S|S)z/Get the section,option value from the defaults.)r r)rVr3r;r1rrWs r_get_option_from_defaultsz)MultiUserConfig._get_option_from_defaults"sB$ LC#~ FI6   rcnd}t|D]\}\}}||k(s|}n||jyy)zRemove section from defaults.N) enumeratepop)rVr3 idx_removeidxrrs r_remove_section_from_defaultsz-MultiUserConfig._remove_section_from_defaults,sM &x0 MC#q#~    ! LL  "rcR|D]"\}}||k(s ||vs|j|yy)z$Remove section,option from defaults.N)r')rVr3r;rrWs r_remove_option_from_defaultsz,MultiUserConfig._remove_option_from_defaults8s5% LC#~W$KK'  rc|jjD]h\}}|jj|j}||k(r1|D]3\}}||k(s t |dk(r|ccS|D]}||k(s |cccS5jy)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#nn224 ,ND(#0044T:OO '' ( , W'>7|q(# #*,C"f}'+ ,  , ,rci}tj|}|jD]\}}g}t|dk(r|||<|D]\}} t| dk(r%|j ||} |j ||n&&t'='=>F   g &<<<0 0rcJ|j|d}|j|S)z-Return all the options for the given section.Nr:)rrWr;s rrWzMultiUserConfig.optionss%!!'40~~g~..rc|j||}||j|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 !!'62 >&&t'='=>F!!'622rc|j||}||j|j}|j|||S)z Get an `option` on a given `section`. If section is None, the `option` is requested from default section. )r3r;r)rrrr)rr3r;rrs rrzMultiUserConfig.getsF !!'62 >&&t'='=>Fzz'&'zJJrcT|j||}|j|||||y)r)r3r;r1r<riN)rr:)rr3r;r1r<rirs rr:zMultiUserConfig.sets2 !!'62 76"  /rcl|jjD]\}}|j|y)z&Reset configuration to Default values.r:N)rr(r)rr3rrs rrz!MultiUserConfig.reset_to_defaultss5**002 6IAv  $ $W $ 5 6rcJ|j|d}|j|yr)rrr;s rrzMultiUserConfig.remove_sections"!!'40g&rcL|j||}|j||yr)rrr>s rrzMultiUserConfig.remove_options$!!'62Wf-rc|jjD](\}}tj|j *y)z/Remove .ini files associated to configurations.N)rr(rrMrJ)rrrs rrzMultiUserConfig.cleanups9**002 1IAv IIf--/ 0 1rrrrr)r r r rZrrrrrr"r$r*r,rrr rrr(rWrr rr:rrrrr rrrrs!IM?D!&0Gd$    ,$&&P & / 3,5 K/6 ' . 1rrceZdZdZy) PluginConfigzPlugin configuration handler.N)r r r rZr rrrFrFs'rrFceZdZdZdZy)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   E;/   aER__faEN@@FgLzgLTQ1fQ1h(:(r