EFrP4dZddlmZddlZddlZddlmZddlZGddeZ GddeZ Gd d eZ Gd d eZ Gd de Z GddZeZeZdZGddeZdZedk(rddlmZedddeyy)aDidlelib.config -- Manage IDLE configuration information. The comments at the beginning of config-main.def describe the configuration files and the design implemented to update user configuration information. In particular, user configuration choices which duplicate the defaults will be removed from the user's configuration files, and if a user file becomes empty, it will be deleted. The configuration database maps options to values. Conceptually, the database keys are tuples (config-type, section, item). As implemented, there are separate dicts for default and user values. Each has config-type keys 'main', 'extensions', 'highlight', and 'keys'. The value for each key is a ConfigParser instance that maps section and item to values. For 'main' and 'extensions', user values override default values. For 'highlight' and 'keys', user sections augment the default sections (and must, therefore, have distinct names). Throughout this module there is an emphasis on returning usable defaults when a problem occurs in returning a requested configuration value back to idle. This is to allow IDLE to continue to function in spite of errors in the retrieval of config information. When a default is returned instead of a requested config value, a message is printed to stderr to aid in configuration problem notification and resolution. ) ConfigParserN)Fontc eZdZy)InvalidConfigTypeN__name__ __module__ __qualname__%/usr/lib/python3.12/idlelib/config.pyrr#r rc eZdZy)InvalidConfigSetNrr r r rr$rr rc eZdZy) InvalidThemeNrr r r rr%rr rc,eZdZdZddZddZdZdZy) IdleConfParserzI A ConfigParser specialised for idle configuration file handling NcB||_tj||dy)zK cfgFile - string, fully specified configuration file name F)defaultsstrictN)filer__init__)selfcfgFile cfgDefaultss r rzIdleConfParser.__init__+s d[Gr c|j||s|S|dk(r|j||S|dk(r|j||S|j|||S)z Get an option value for given section/option or return default. If type is specified, return as type. boolintraw) has_option getbooleangetintget)rsectionoptiontypedefaultr!s r GetzIdleConfParser.Get2s\w/N 6>??7F3 3 U];;w/ /88GV85 5r cJ|j|r|j|SgS)z4Return a list of options for given section, else [].) has_sectionoptionsrr&s r GetOptionListzIdleConfParser.GetOptionListCs$   G $<<( (Ir cT|jr|j|jyy)z&Load the configuration file from disk.N)rreadrs r LoadzIdleConfParser.LoadJs 99 IIdii  r N)NNF)rr r __doc__rr*r/r3r r r rr'sH6"!r rc4eZdZdZdZdZdZdZdZdZ y) IdleUserConfParserzG IdleConfigParser specialised for user configuration handling. c|j||r*|j|||k(ry|j|||y|j|s|j ||j|||y)zReturn True if option is added or changed to value, else False. Add section if required. False means option already had value. FT)r"r%setr, add_section)rr&r'values r SetOptionzIdleUserConfParser.SetOptionTsj ??7F +xx(E1&%0##G,  ) HHWfe ,r cJ|j|r|j||Sy)zReturn True if option is removed from section, else False. False if either section does not exist or did not have option. F)r, remove_option)rr&r's r RemoveOptionzIdleUserConfParser.RemoveOptiones(   G $%%gv6 6r cJ|j|s|j|yy)z!If section doesn't exist, add it.N)r,r:r.s r AddSectionzIdleUserConfParser.AddSectionns#(   W %)r ct|jD]%}|j|r|j|'y)z)Remove any sections that have no options.N)sectionsr/remove_sectionr.s r RemoveEmptySectionsz&IdleUserConfParser.RemoveEmptySectionsss.}}G%%g.##G,'r cD|j|j S)z9Return True if no sections after removing empty sections.)rErCr2s r IsEmptyzIdleUserConfParser.IsEmptyys   "==?""r c|j}|r|ddk7r|js* t|d}|5|j |dddytjj|jr t j|jyyyy#t$r$t j |t|d}YwxYw#1swYyxYw)zUpdate user configuration file. If self not empty after removing empty sections, write the file to disk. Otherwise, remove the file from disk if it exists. r#wN) rrGopenOSErrorosunlinkwritepathexistsremove)rfnamers r SavezIdleUserConfParser.Save~s   U1X_<<>/"5#.GJJw'W * $))$+%5/IIe$"5#.G/Ws BC *C  C  CN) rr r r5r<r?rArErGrTr r r r7r7Os%"& - # %r r7ceZdZdZd dZdZdZ d!dZdZdZ d Z d Z d Z d Z d ZedZ d"dZdZdZdZdZdZdZdZdZdZhdZd#dZdZdZdZdZ dZ!y)$IdleConfalHold config parsers for all idle config files in singleton instance. Default config files, self.defaultCfg -- for config_type in self.config_types: (idle install dir)/config-{config-type}.def User config files, self.userCfg -- for config_type in self.config_types: (user home dir)/.idlerc/config-{config-type}.cfg cd|_i|_i|_i|_|s!|j |j yy)N)main highlightkeys extensions) config_types defaultCfguserCfgcfgCreateConfigHandlers LoadCfgFiles)r_utests r rzIdleConf.__init__sAG    % % '    r c tjjt}tj rdn|j x|_}|jD]z}ttjj|d|d|j|<ttjj|xsdd|d|j|<|y)z5Populate default and user config parser dictionaries.zconfig-z.defrIz.cfgN)rMrPdirname__file__idlelibtesting GetUserCfgDiruserdirr\rjoinr]r7r^)ridledirrjcfg_types r r`zIdleConf.CreateConfigHandlerss''//(+'.D?)ADOOH %%7 W^wxj-EF&HDLL "*r cd}tjjd}|dk7rUtjj|s6tj s$d|zdz} t |tjd}|dk(rtj}tjj||}tjj|s tj||S|S#t$rYwxYw#t$rUtj s>d|zdz} t |tjt#t$rYtwxYwtwxYw)zfReturn a filesystem directory for storing user config files. Creates it if required. z.idlerc~z. Warning: os.path.expanduser("~") points to z, but the path does not exist.rz2 Warning: unable to create user config directory z( Check path and permissions. Exiting! )rMrP expanduserrQrgrhprintsysstderrrLgetcwdrkmkdir SystemExit)rcfgDiruserDirwarns r rizIdleConf.GetUserCfgDirs9 ''$$S) c>77>>'*N#$&HIDd4 c>iikG'',,w/ww~~g& !!w)# !R#$&STDd4! #     !sBC.C=. C:9C:=!EE:E E EE ENc  |j|j||r"|j|j||||S |j |j||r"|j |j||||S |rd|d|d|}t |||||S#t$r>d|d|d|d|j|j|||}t ||||YwxYw#t$rYrwxYw) aReturn a value for configType section option, or default. If type is not None, return a value of that type. Also pass raw to the config parser. First try to return a valid value (including type) from a user configuration. If that fails, try the default configuration. If that fails, return default, with a default of None. Warn if either user or default configurations have an invalid value. Warn if default is returned and warn_on_default is True. )r(r!z5 Warning: config.py - IdleConf.GetOption - invalid z value for configuration option z from section z: r zU Warning: config.py - IdleConf.GetOption - problem retrieving configuration option . returning default value: )r^r"r* ValueError_warnr]) r configTyper&r'r)r(warn_on_defaultr!warnings r GetOptionzIdleConf.GetOptions- 8||J'227FC||J/33GV9=34HHD z*55gfEz266d7==F   2G ':w 7+ 8fg||J/33GV3M OG ':w 7  8   s&AB$AC.$AC+*C+. C:9C:cD|j|j|||y)z0Set section option to value in user config file.N)r^r<)rrr&r'r;s r r<zIdleConf.SetOptions Z **7FEBr c||jvr td|dk(r|j|}|j S|dk(r|j|}|j St d)zReturn sections for configSet configType configuration. configSet must be either 'user' or 'default' configType must be in self.config_types. zInvalid configType specifieduserr)Invalid configSet specified)r\rr^r]rrC)r configSetr cfgParsers r GetSectionListzIdleConf.GetSectionLists| d///#$BC C   Z0I !!## ) #ooj1I!!####@A Ar c|jdj|rdnd}|j||}||dz}|dk(rd}||dz}||dS) zReturn dict of theme element highlight colors. The keys are 'foreground' and 'background'. The values are tkinter color strings for configuring backgrounds and tags. rYr)rz -foregroundcursornormalz -background) foreground background)r]r, GetThemeDict)rthemeelementr_ theme_dictforebacks r GetHighlightzIdleConf.GetHighlightsm !OOK8DDUKy &&sE2 'M12 h G'M12"$77r c|dk(r|jd}n |dk(r|jd}n tdiddddd dd dd dd dd dddddddddddddddddddddddddddddddddddd}|D][}|j||s-|j dsd|d|d||}t |d|||j ||||||<]|S)a)Return {option:value} dict for elements in themeName. type - string, 'default' or 'user' theme type themeName - string, theme name Values are loaded over ultimate fallback defaults to guarantee that all theme elements are present in a newly created theme. rrYr)zInvalid theme type specifiedznormal-foregroundz#000000znormal-backgroundz#ffffffzkeyword-foregroundzkeyword-backgroundzbuiltin-foregroundzbuiltin-backgroundzcomment-foregroundzcomment-backgroundzstring-foregroundzstring-backgroundzdefinition-foregroundzdefinition-backgroundzhilite-foregroundzhilite-backgroundgrayzbreak-foregroundzbreak-backgroundzhit-foreground)zhit-backgroundzerror-foregroundzerror-backgroundzcontext-foregroundzcontext-backgroundzlinenumber-foregroundzlinenumber-backgroundzcursor-foregroundzstdout-foregroundzstdout-backgroundzstderr-foregroundzstderr-backgroundzconsole-foregroundzconsole-background)zcontext-z linenumber-zL Warning: config.IdleConf.GetThemeDict - problem retrieving theme element z from theme z. returning default color: r))r^r]rr" startswithr~r*)rr( themeNamerrrrs r rzIdleConf.GetThemeDict"s 6> [1I Y  4I=> > !#I!#I!$Y!%Y!%Y ! %Y ! %Y !%Y!$I!$I!( !( !$I!$F!#9!#9! !!!""+#,#,%.%.(1(1$-$-$-$-$-%.%.A!DG((G<&&'BC $Yg @ g{Iw?&]]wg+@E'N r c$|jdS)z9Return the name of the currently active text color theme.Themecurrent_colors_and_keysr2s r CurrentThemezIdleConf.CurrentThemefs++G44r c$|jdS)z0Return the name of the currently active key set.Keysrr2s r CurrentKeyszIdleConf.CurrentKeysjs++F33r c2|dk(rdnd}|jd|ddd}d }|r|jd|d d }|s|jd|d d }|r0|r |jn |j}||j|r|S|dk(rd S|j S)aReturn the currently active name for Theme or Keys section. idlelib.config-main.def ('default') includes these sections [Theme] default= 1 name= IDLE Classic name2= [Keys] default= 1 name= name2= Item 'name2', is used for built-in ('default') themes and keys added after 2015 Oct 1 and 2016 July 1. This kludge is needed because setting 'name' to a builtin not defined in older IDLEs to display multiple error messages or quit. See https://bugs.python.org/issue25313. When default = True, 'name2' takes precedence over 'name', while older IDLEs will just use name. When default = False, 'name2' may still be set, but it is ignored. rrYrZrXr)rTr(r)rdname2rnamez IDLE Classic)rr]r^r, default_keys)rr&cfgnamer)rsources r rz IdleConf.current_colors_and_keysns0")G!3+..)&,d!< >>&'7B>GD>>&'62>FD (/T__T\\Fg**40 !(G!3~L9J9J9LLr cZtjdddk(rytjdk(ryy)NwinzIDLE Classic WindowsdarwinzIDLE Classic OSXzIDLE Modern Unix)rsplatformr r r rzIdleConf.default_keyss* << u $) \\X %%%r c |j|jdd}|j|jdd}|D]}||vs|j|dD]}|j||rhg}|D]_}|j d|ddds|s|r1|rd }nd }|j d||ddd s=|j|O|j|a|S|S) zReturn extensions in default and user config-extensions files. If active_only True, only return active (enabled) extensions and optionally only editor or shell extensions. If active_only False, return all extensions. r)r[r) AutoComplete CodeContextFormatParagraph ParenMatchenableTrr)r( enable_editor enable_shellF)r)r(r)RemoveKeyBindNamesrappendrRr) r active_only editor_only shell_onlyextns userExtnsextn activeExtnsr's r GetExtensionszIdleConf.GetExtensionss ''##I|<>++##FL9; D5  T"5D LL 5 K>>,h'-"/#j&%4F%3F>>,V26V:?*A(..t4#**40 Lr cP|Dcgc]}|jdr|c}Scc}w)z:Return extnNameList with keybinding section names removed.) _bindings _cfgBindings)endswith)r extnNameListns r rzIdleConf.RemoveKeyBindNamess&'Y>' N<<>>rr)rGetExtensionKeys)r virtualEventextNamevEventrevents r GetExtnNameForEventzIdleConf.GetExtnNameForEventsX  $t+&&1&5D..t4F?"G56r c|dz}|j}i}|jdj|r7|jdj|}|D]}d|zdz}||}|||<|S)a Return dict: {configurable extensionName event : active keybinding}. Events come from default config extension_cfgBindings section. Keybindings come from GetCurrentKeySet() active key dict, where previously used bindings are disabled. rr[rr)GetCurrentKeySetr]r,r/) r extensionNamekeysName activeKeysextKeys eventNames eventNamerbindings r rzIdleConf.GetExtensionKeyss!>1**,  ??< ( 4 4X >6DDXNJ' y(4/$U+!((r c|dz}i}|jdj|rU|jdj|}|D]2}|jd||dj }d|zdz}|||<4|S)aReturn dict {configurable extensionName event : keybinding list}. Events come from default config extension_cfgBindings section. Keybindings list come from the splitting of GetOption, which tries user config before default config. rr[rdrrr)r]r,r/rsplit)rrrrrrrrs r __GetRawExtensionKeyszIdleConf.__GetRawExtensionKeyss!/ ??< ( 4 4X >6DDXNJ' ..$h 2)GGLuwy(4/!( ( r c|dz}|j|}|jdj|rU|jdj|}|D]2}|j d||dj }d|zdz}|||<4|S)aReturn dict {extensionName event : active or defined keybinding}. Augment self.GetExtensionKeys(extensionName) with mapping of non- configurable events (from default config) to GetOption splits, as in self.__GetRawExtensionKeys. rr[rdrrr)rr]r,r/rr)rr bindsNameextBindsrrrrs r GetExtensionBindingszIdleConf.GetExtensionBindingss"K/ ((7 ??< ( 4 4Y ?6DDYOJ' ..$iB)HHMy(4/") ( r cX|dd}|jd||ddj}|S)zReturn the keybinding list for keySetName eventStr. keySetName - name of key binding set (config-keys section). eventStr - virtual event, including brackets, as in '<>'. rZrdF)r)r)rr)r keySetNameeventStrrrs r GetKeyBindingzIdleConf.GetKeyBindings< QrN ..Y16!88= r c|j|j}tjdk(rB|j D]/\}}|Dcgc]}|j dd}}||k7s+|||<1|Scc}w)z/Return CurrentKeys with 'darwin' modifications.rz>' rr)r)rrs r IsCoreBindingzIdleConf.IsCoreBinding>s" \!$&4+;+;+===r > <><><><><><><><><>c idddgdddgddd gd d d gd dgddgddgddgddgddgddgddgddgddgdd gd!d"gd#d$gid%d&gd'd(gd)d*gd+d,gd-d.gd/d0gd1d2gd3d4gd5d6gd7d8gd9d:gd;dgd?d@dAgdBdCgdDdEgdFdGgidHdIgdJdKgdLdMgdNdOdPgdQdRgdSdTgdUdVgdWdXgdYdZgd[d\gd]d^gd_d`gdadbgdcddgdedfgdgdhgdidjgdkgdlgdmgdngdogdpgdqgdr}|r|jdsj|s3|jdsj|sdt|du}t|ds||S|D]G}|j ||}|r|||<||j vs,dv|dw|dx||}t|ds||I|S)yaReturn dict of core virtual-key keybindings for keySetName. The default keySetName None corresponds to the keyBindings base dict. If keySetName is not None, bindings from the config file(s) are loaded _over_ these defaults, so if there is a problem getting any core binding there will be an 'ultimate last resort fallback' to the CUA-ish bindings defined here. z<>z z z<>z z z <>z z z<>z zz<>z z<>z z<>zz<>z<>z z<>zz<>z z<>zz<>zz<>z<>zz<>z z<>zz<>zz<>z z<>z z<>z z<>z z<>z z<>zz<>z z<>zz<>z z<>zz<>zz<>z z<>z zz<>zz<>z z<>z z <>z z <>zz<>zz<>z zz<>z z<>zz<>zz<>z z<>z z<>z z<>z z<>z z<>z z<>zz<>zrzrzzzz zzz z )rrrrrrrrZz7 Warning: config.py - IdleConf.GetCoreKeys - key set z( is not defined, using default bindings.zX Warning: config.py - IdleConf.GetCoreKeys - problem retrieving key binding for event z from key set r|)r^r,r]r~rformer_extension_events)rr keyBindingsrrrs r rzIdleConf.GetCoreKeysPs<  6<  }5< -7 < $mX%> < - < $m_<  < }o<  < x< & ~<  < #YK< & < !<" .!1#<$ %yk%<&  {'<( "M?)<* (-+<, +]O-<. /<0 1<2 #ZL3<4 ./@5<6 & {7<8  9<: yk;<< '):(;=<> ?<@ }f5A<B *C<D !>"2E<F G<H M?I<J i[K<L "$5#6M<N %~7G&HO<P  Q<R ">!?S<T "=!>U<V !=/W<X #]OY<Z -[<\ "M?]<^  _<` %}oa<b ";!z1IdleConf.GetExtraHelpSourceList..sqtr )key) r^r]rr/r*findrstriprsort) rr helpSourcesrr-r'r;menuItemhelpPaths r GetExtraHelpSourceListzIdleConf.GetExtraHelpSourceLists   V,I ) #/I"#@A A'' 4F-- VS-AEzz#"$kk#&q)q)H""Xhv$>@ ^,r cL|jd|jdz}|S)zReturn a list of the details of all additional help sources. Tuples in the list are those of GetExtraHelpSourceList. r)r)r)rallHelpSourcess r GetAllExtraHelpSourcesListz#IdleConf.GetAllExtraHelpSourcesLists- 55i@++F34r c|j||dd}|j||ddd}|j||dd d }|d k(ry)zLoad all configuration files.N)r]r3r^rr s r razIdleConf.LoadCfgFiless:??C OOC % % ' LL  " " $#r c`|jD]}|j|j!y)z2Write all loaded user configuration files to disk.N)r^rTr&s r SaveUserCfgFileszIdleConf.SaveUserCfgFiless%< `D@<4% %r rVc|f|z}|tvr2 t|tjtj |yy#t$rY"wxYw)Nrp)_warnedrrrsrtrLadd)msgr s r r~r~sO &3,C '  #CJJ '  C    sA A Ac>eZdZdZdZdZedZdZdZ dZ y) ConfigChangesaManage a user's proposed configuration option changes. Names used across multiple methods: page -- one of the 4 top-level dicts representing a .idlerc/config-x.cfg file. config_type -- name of a page. section -- a section within a page/file. option -- name of an option within a section. value -- value for the option. Methods add_option: Add option and value to changes. save_option: Save option and value to config parser. save_all: Save all the changes to the config parser and file. delete_section: If section exists, delete from changes, userCfg, and file. clear: Clear all changes by clearing each page. cg|_tjD]%}i||<|jj||'y)z)Create a page for each configuration fileN)pagesidleConfr\r)r config_types r rzConfigChanges.__init__!s: #00K "D  JJ  d;/ 01r cF||}t|}||vri||<||||<y)z0Add item/value pair for config_type and section.N)str)rr3r&itemr;pages r add_optionzConfigChanges.add_option(s4K E  $ DM#W dr c"tj|j||rItj|j|||k(r#tj|j ||Stj|j |||S)zcReturn True if the configuration value was added or changed. Helper for save_all. )r2r]r"r*r^r?r<)r3r&r6r;s r save_optionzConfigChanges.save_option0s}   { + 6 6w E"";/33GTBeK'' 4AA'4PP ,66weLLr c tjdjd}|D]}d}||}|D]]}|dk(r$tjdjdd}||j D]\}}|j ||||sd}_|sotj|jd}dD]#}tj|j%|j |S)zSave configuration changes to the user config file. Clear self in preparation for additional changes. Return changed for testing. rXFrT)rZrY)r2r^rTrDrr:clear)rchangedr3cfg_type_changedr7r&r6r;s r save_allzConfigChanges.save_all=s  %%'K$  $Dk)$$V,;;KH'+$#'=#6#6#8KD%'' WdEJ+/($9     -224 1K   [ ) . . 01 r c|||vr|||=tj|}|j||jy)zjDelete a section from self, userCfg, and file. Used to delete custom themes and keysets. N)r2r^rDrT)rr3r& configpages r delete_sectionzConfigChanges.delete_section[sF d;' '[!'*%%k2 !!'*r cF|jD]}|jy)zClear all 4 pages. Called in save_all after saving to idleConf. XXX Mark window *title* when there are changes; unmark here. N)r1r<)rr7s r r<zConfigChanges.clearfs JJD JJLr N) rr r r5rr8r)r:r?rBr<r r r r/r/s6$1$ M M< r r/cddlmd\fdfd}|tj|tjt ddd y) Nr)crc32)rrcnt|}dz |jdt|y)Nrzutf-8)encoding)r5encoderr)objtxtcrcrElines r sprintz_dump..sprintus3#h  CJJJ0#6 c r c ,td|dt|D]x}||j}|||D]N}||j|}|||D]#}|dz||j ||z%Pzy)N z = )rrsortedrCr-r*)r_r rCr&r-r'rMs r dumpCfgz_dump..dumpCfg}s dC#;C3x((*H 3K 8 #c(**73ww%F6E>CHLL&,IIJ& $ r z lines = z, crc = rd)sep)zlibrEr2r]r^rr)rQrKrErLrMs @@@@r _dumprTqsHID# K H    H   ,j#26r __main__)rXzidlelib.idle_test.test_configrF) verbosityexit)r5 configparserrrMrs tkinter.fontrrg Exceptionrrrrr7rVr2r9r+r~dictr/rTrunittestrXr r r r]s6& ( ('y'#9#&!\&!P@%@%Dm %m %` : %_D_F7< z (AEB G r