3
fޗ @ s d Z ddlmZ ddlZddlZddlmZ ddlZG dd deZ G dd deZ
G d d
d
eZ G d d d eZ G d
d deZ
G dd de
ZG dd dZe Ze Zdd ZG dd deZdd ZedkrddlmZ edd d d dS ) aE idlelib.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 'extenstons', 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 useable 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 @ s e Zd ZdS )InvalidConfigTypeN)__name__
__module__ __qualname__ r r 3/opt/alt/python36/lib64/python3.6/idlelib/config.pyr # s r c @ s e Zd ZdS )InvalidConfigSetN)r r r r r r r r
$ s r
c @ s e Zd ZdS ) InvalidFgBgN)r r r r r r r r % s r c @ s e Zd ZdS ) InvalidThemeN)r r r r r r r r & s r c @ s4 e Zd ZdZd ddZd
ddZdd Zd
d ZdS )IdleConfParserzI
A ConfigParser specialised for idle configuration file handling
Nc C s || _ tj| |dd dS )zK
cfgFile - string, fully specified configuration file name
F)ZdefaultsstrictN)filer __init__)selfcfgFileZ cfgDefaultsr r r r , s zIdleConfParser.__init__Fc C sL | j ||s|S |dkr$| j||S |dkr8| j||S | j|||dS dS )z
Get an option value for given section/option or return default.
If type is specified, return as type.
boolint)rawN)
has_optionZ
getbooleanZgetintget)r sectionoptiontypedefaultr r r r Get3 s zIdleConfParser.Getc C s | j |r| j|S g S dS )z4Return a list of options for given section, else [].N) has_sectionoptions)r r r r r
GetOptionListD s
z IdleConfParser.GetOptionListc C s | j r| j| j dS )z&Load the configuration file from disk.N)r read)r r r r LoadK s zIdleConfParser.Load)N)NNF)r r r __doc__r r r r! r r r r r
( s
r
c @ sH e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dS )IdleUserConfParserzG
IdleConfigParser specialised for user configuration handling.
c C s^ | j ||r4| j|||kr dS | j||| dS n&| j|sH| j| | j||| dS dS )zReturn True if option is added or changed to value, else False.
Add section if required. False means option already had value.
FTN)r r setr add_section)r r r valuer r r SetOptionU s
z IdleUserConfParser.SetOptionc C s | j |r| j||S dS )zReturn True if option is removed from section, else False.
False if either section does not exist or did not have option.
F)r Z
remove_option)r r r r r r RemoveOptionf s
z IdleUserConfParser.RemoveOptionc C s | j |s| j| dS )z!If section doesn't exist, add it.N)r r% )r r r r r
AddSectiono s
z IdleUserConfParser.AddSectionc C s* x$| j D ]}| j|s
| j| q
W dS )z)Remove any sections that have no options.N)sectionsr remove_section)r r r r r RemoveEmptySectionst s
z&IdleUserConfParser.RemoveEmptySectionsc C s | j | j S )z9Return True if no sections after removing empty sections.)r, r* )r r r r IsEmptyz s zIdleUserConfParser.IsEmptyc C s t jj| jrt j| j dS )z9Remove user config file self.file from disk if it exists.N)ospathexistsr remove)r r r r
RemoveFile s z IdleUserConfParser.RemoveFilec C sr | j }|rn| j sfyt|d}W n( tk
rH tj| t|d}Y nX | | j| W dQ R X n| j dS )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.
wN)r r- openOSErrorr. unlinkwriter2 )r Zfnamer r r r Save s
zIdleUserConfParser.SaveN) r r r r" r' r( r) r, r- r2 r8 r r r r r# P s r# c @ s e Zd ZdZdEddZdd Zdd ZdFd d Zd
d Zdd Z dGddZ
dd Z dd Z dd Z
dd Zedd ZdHd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Zd+d, Zd-d. Zd/d0 Zd1d2d3d4d5d6d7d8hZdId9d:Z d;d< Z d=d> Z d?d@ Z dAdB Z dCdD Z!d S )JIdleConfal Hold 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
Fc C s0 d| _ i | _i | _i | _|s,| j | j d S )Nmain highlightkeys
extensions)r: r; r< r= ) config_types
defaultCfguserCfgcfgCreateConfigHandlers LoadCfgFiles)r Z_utestr r r r s zIdleConf.__init__c C s t dkrtjjt}ntjjtjd }| j | _}i }i }xB| j D ]8}tjj
|d| d ||< tjj
|d| d ||< qFW x2| j D ](}t || | j |< t
|| | j|< qW dS )z5Populate default and user config parser dictionaries.__main__r zconfig-z.defz.cfgN)r r. r/ dirname__file__abspathsys
GetUserCfgDirZuserdirr> joinr
r? r# r@ )r ZidleDiruserDirZ defCfgFilesZ usrCfgFilesZcfgTyper r r rB s z IdleConf.CreateConfigHandlersc C s d}t jjd}|dkr\t jj|s\d| d }yt|tjd W n tk
rV Y nX d}|dkrlt j }t jj ||}t jj|syt j
| W n8 tk
r d| d }t j st|tjd t
Y nX |S )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.)r z2
Warning: unable to create user config directory
z(
Check path and permissions.
Exiting!
)r. r/
expanduserr0 printrH stderrr5 getcwdrJ mkdiridlelibZtesting
SystemExit)r ZcfgDirrK warnr r r rI s,
zIdleConf.GetUserCfgDirNTc C s y.| j | j||r,| j | j||||dS W nD tk
rr d|||| j | j|||df }t|||| Y nX y.| j| j||r| j| j||||dS W n tk
r Y nX |rd|||f }t|||| |S )a Return 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 zn
Warning: config.py - IdleConf.GetOption -
invalid %r value for configuration option %r
from section %r: %r)r z
Warning: config.py - IdleConf.GetOption -
problem retrieving configuration option %r
from section %r.
returning default value: %r)r@ r r
ValueError_warnr? ) r
configTyper r r r warn_on_defaultr warningr r r GetOption s(
zIdleConf.GetOptionc C s | j | j||| dS )z0Set section option to value in user config file.N)r@ r' )r rW r r r& r r r r'
s zIdleConf.SetOptionc C sJ || j krtd|dkr&| j| }n |dkr:| j| }ntd|j S )zReturn sections for configSet configType configuration.
configSet must be either 'user' or 'default'
configType must be in self.config_types.
z Invalid configType specifieduserr zInvalid configSet specified)r> r r@ r? r
r* )r configSetrW cfgParserr r r GetSectionList s
zIdleConf.GetSectionListc C s | j d j|r | jd|}n | jd|}||d }|dkrH|d }n ||d }||d}|sf|S |d krv|d
S |d kr|d S td
dS )a Return individual theme element highlight color(s).
fgBg - string ('fg' or 'bg') or None.
If None, return a dictionary containing fg and bg colors with
keys 'foreground' and 'background'. Otherwise, only return
fg or bg color, as specified. Colors are intended to be
appropriate for passing to Tkinter in, e.g., a tag_config call).
r; r r[ z -foregroundZcursorznormal-backgroundz -background)
foreground
backgroundZfgr_ Zbgr` zInvalid fgBg specifiedN)r? r GetThemeDictr )r themeelementZfgBgZ themeDictZforeZbackr; r r r GetHighlight s
zIdleConf.GetHighlightc C s |dkr| j d }n |dkr(| jd }ntddddddddddddddddddddddddddddddd }xP|D ]H}|j||sd |||| f }t|d|| |j|||| d
||< qvW |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.
r[ r; r z Invalid theme type specifiedz#000000z#ffffffZgray) znormal-foregroundznormal-backgroundzkeyword-foregroundzkeyword-backgroundzbuiltin-foregroundzbuiltin-backgroundzcomment-foregroundzcomment-backgroundzstring-foregroundzstring-backgroundzdefinition-foregroundzdefinition-backgroundzhilite-foregroundzhilite-backgroundzbreak-foregroundzbreak-backgroundzhit-foregroundzhit-backgroundzerror-foregroundzerror-backgroundzcursor-foregroundzstdout-foregroundzstdout-backgroundzstderr-foregroundzstderr-backgroundzconsole-foregroundzconsole-backgroundzcontext-foregroundzcontext-backgroundz{
Warning: config.IdleConf.GetThemeDict -
problem retrieving theme element %r
from theme %r.
returning default color: %r)r )r@ r? r r rV r )r r Z themeNamer] rb rc rY r r r ra ; sT
zIdleConf.GetThemeDictc C s
| j dS )z9Return the name of the currently active text color theme.Theme)current_colors_and_keys)r r r r CurrentTheme{ s zIdleConf.CurrentThemec C s
| j dS )z0Return the name of the currently active key set.ZKeys)rf )r r r r CurrentKeys s zIdleConf.CurrentKeysc C s |dkr dnd}| j d|dddd}d }|r>| j d|d
d d }|sT| j d|d d d }|rz|rb| jn| j}|| j|rz|S |dkrd
S | j S )a Return 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.
re r; r< r: r r T)r r Zname2)r namez IDLE Classic)rZ r? r@ r default_keys)r r Zcfgnamer rj sourcer r r rf s
z IdleConf.current_colors_and_keysc C s, t jd d dkrdS t jdkr$dS dS d S )N winzIDLE Classic WindowsdarwinzIDLE Classic OSXzIDLE Modern Unix)rH platformr r r r rk s
zIdleConf.default_keysc C s | j | jdd}| j | jdd}x |D ]}||kr*|j| q*W xdD ]}|j| qJW |rg }xb|D ]Z}| jd|dd d
d rj|s|r|rd }nd
}| jd||d d
ddr|j| qj|j| qjW |S |S dS )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
ParenMatchenableTr )r r Z
enable_editorZ enable_shellF)r r rX N)rq rr rs rt )RemoveKeyBindNamesr^ appendr1 rZ ) r active_onlyZ editor_onlyZ
shell_onlyZextnsZ userExtnsextn activeExtnsr r r r
GetExtensions s4
zIdleConf.GetExtensionsc C s dd |D S )z:Return extnNameList with keybinding section names removed.c S s g | ]}|j ds|qS ) _bindings _cfgBindings)r| r} )endswith).0nr r r
s z/IdleConf.RemoveKeyBindNames..r )r Z extnNameListr r r rv s zIdleConf.RemoveKeyBindNamesc C sJ d}d| d }x4| j ddD ]$}x | j|D ]}||kr.|}q.W q W |S )zReturn the name of the extension binding virtualEvent, or None.
virtualEvent - string, name of the virtual event to test for,
without the enclosing '<< >>'
Nz<>r )rx )r{ GetExtensionKeys)r virtualEventZextNameZvEventry eventr r r GetExtnNameForEvent s z IdleConf.GetExtnNameForEventc C sb |d }| j }i }| jd j|r^| jd j|}x(|D ] }d| d }|| }|||< q:W |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.
r} r= z<>)GetCurrentKeySetr? r r ) r
extensionNamekeysNameZ
activeKeysextKeys
eventNames eventNamer bindingr r r r s
zIdleConf.GetExtensionKeysc C sh |d }i }| j d j|rd| j d j|}x6|D ].}| jd||ddj }d| d }|||< q2W |S )a Return 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.
r} r= ri )r z<>)r? r r rZ split)r r r r r r r r r r r Z__GetRawExtensionKeys s
z IdleConf.__GetRawExtensionKeysc C sn |d }| j |}| jd j|rj| jd j|}x6|D ].}| jd||ddj }d| d }|||< q8W |S )a Return 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.
r| r= ri )r z<>)r r? r r rZ r )r r Z bindsNameZextBindsr r r r r r r GetExtensionBindings s
z IdleConf.GetExtensionBindingsc C s( |dd }| j d||dddj }|S )zReturn the keybinding list for keySetName eventStr.
keySetName - name of key binding set (config-keys section).
eventStr - virtual event, including brackets, as in '<>'.
r< ri F)r rX )rZ r )r
keySetNameZeventStrr r r r r
GetKeyBinding% s zIdleConf.GetKeyBindingc C sP | j | j }tjdkrLx2|j D ]&\}}dd |D }||kr"|||< q"W |S )z/Return CurrentKeys with 'darwin' modifications.ro c S s g | ]}|j d dqS )z.) GetKeySetrh rH rp items)r resultkvZv2r r r r 0 s
zIdleConf.GetCurrentKeySetc C sh | j |}| jdd}xL|D ]D}| j|}|r x0|D ](}|| |j krPd||< || ||< q4W q W |S )zReturn event-key dict for keySetName core plus active extensions.
If a binding defined in an extension is already in use, the
extension binding is disabled by being set to ''
)rx ri ) GetCoreKeysr{ _IdleConf__GetRawExtensionKeysvalues)r r ZkeySetrz ry r r r r r r A s
zIdleConf.GetKeySetc C s d| d | j kS )zReturn True if the virtual event is one of the core idle key events.
virtualEvent - string, name of the virtual event to test for,
without the enclosing '<< >>'
z<>)r )r r r r r
IsCoreBindingS s zIdleConf.IsCoreBindingz<>z<>z<>z<>z<>z<>z<>z<>c : C s ddgddgddgddgd gd
gd gdgd gd
gdgdgdgdgdgdgdgdgdgdgdgdgdgdgdgd gd gd gd gd gd!d"gd#gd$gd%gd&gd'gd(gd)d*gd+gd,gd-gd.gd/gd0gd1gd2gd3gd4gd5gd6gd7gd8gd9gd:gd;gd9}|r| j d? j|p | jd? j|s8d@|f }t|d?| nXxV|D ]N}| j||}|r^|||< n,|| jkr>dA|||| f }t|d?|| q>W |S )Ba Return 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 zz z zz zz
zzzz zzz z z z z zz
zz zzz z zzz z z zzz zz zzz z z z z z zzzzzzz zz z )9z<>z<>z <>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z <>z<>z<>z<>z <>z<>z<>z<>z<>z<>z<>z<>z<>z<>z <>z
<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>z<>r< za
Warning: config.py - IdleConf.GetCoreKeys -
key set %r is not defined, using default bindings.z
Warning: config.py - IdleConf.GetCoreKeys -
problem retrieving key binding for event %r
from key set %r.
returning default value: %r)r@ r r? rV r former_extension_events)r r Z keyBindingsrY r r r r r r c s
zIdleConf.GetCoreKeysc C s g }|dkr| j d }n |dkr,| jd }ntd|jd}xn|D ]f}|jd|dd}|jddkrpd }d }n"|jd}|d
j }|d j }|rD|rD|j|||f qDW |j d d d
|S )a Return list of extra help sources from a given configSet.
Valid configSets are 'user' or 'default'. Return a list of tuples of
the form (menu_item , path_to_help_file , option), or return the empty
list. 'option' is the sequence number of the help resource. 'option'
values determine the position of the menu items on the Help menu,
therefore the returned list must be sorted by 'option'.
r[ r: r zInvalid configSet specified HelpFiles;)r r ri r c S s | d S )Nr r )r r r r s z1IdleConf.GetExtraHelpSourceList..)key)
r@ r? r
r r findr striprw sort) r r\ Z helpSourcesr] r r r& ZmenuItemZhelpPathr r r GetExtraHelpSourceList s&
z IdleConf.GetExtraHelpSourceListc C s | j d| j d }|S )zReturn a list of the details of all additional help sources.
Tuples in the list are those of GetExtraHelpSourceList.
r r[ )r )r ZallHelpSourcesr r r GetAllExtraHelpSourcesList s z#IdleConf.GetAllExtraHelpSourcesListc C s | j ||ddd}| j ||dddd}| j ||dd d
d }|d krtd d
|d}tj|}|d }|d }|d krvd}|d dk}|||rdndfS )a Retrieve a font from configuration (font, font-size, font-bold)
Intercept the special value 'TkFixedFont' and substitute
the actual font, factoring in some tweaks if needed for
appearance sakes.
The 'root' parameter can normally be any valid Tkinter widget.
Return a tuple (family, size, weight) suitable for passing
to tkinter.Font
ZfontZcourier)r z font-sizer Z10)r r z font-boldr r )r r Z TkFixedFontT)rj r0 rootfamilysize
ZweightboldZnormal)rZ r Zactual) r r rW r r r r fZ
actualFontr r r GetFont s
zIdleConf.GetFontc C s0 x*| j D ] }| j | j | j| j qW dS )z Load all configuration files.N)r? r! r@ )r r r r r rC s zIdleConf.LoadCfgFilesc C s" x | j D ]}| j | j qW dS )z2Write all loaded user configuration files to disk.N)r@ r8 )r r r r r SaveUserCfgFiles s zIdleConf.SaveUserCfgFiles)F)NNTF)N)TFF)N)"r r r r" r rB rI rZ r' r^ rd ra rg rh rf staticmethodrk r{ rv r r r r r r r r r r r r r rC r r r r r r9 sD
'
@&
(
_ r9 c G sH | f| }|t krDyt| tjd W n tk
r8 Y nX t j| d S )N)r )_warnedrN rH rO r5 add)msgr r r r rV s
rV c @ sD e Zd ZdZdd Zdd Zedd Zdd Zd
d Z d d
Z
dS )
ConfigChangesa Manage 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.
c C s2 g | _ x&tjD ] }i | |< | j j| | qW dS )z)Create a page for each configuration fileN)pagesidleConfr> rw )r config_typer r r r 1 s zConfigChanges.__init__c C s0 | | }t |}||kr i ||< ||| |< dS )z0Add item/value pair for config_type and section.N)str)r r r itemr& pager r r
add_option8 s
zConfigChanges.add_optionc C sN t j| j||r:t j| j|||kr:t j| j||S t j| j|||S )zcReturn True if the configuration value was added or changed.
Helper for save_all.
)r r? r r r@ r( r' )r r r r& r r r save_option@ s zConfigChanges.save_optionc C s t jd j d}x| D ]~}d}| | }xV|D ]N}|dkrNt jd jd d}x,|| j D ] \}}| j||||r\d}q\W q.W |rt j| j d}qW xdD ]}t j| j qW | j |S )zSave configuration changes to the user config file.
Clear self in preparation for additional changes.
Return changed for testing.
r: Fr Tr< r; )r< r; )r r@ r8 r+ r r clear)r Zchangedr Zcfg_type_changedr r r r& r r r save_allM s&
zConfigChanges.save_allc C s6 || | kr| | |= t j| }|j| |j dS )zjDelete a section from self, userCfg, and file.
Used to delete custom themes and keysets.
N)r r@ r+ r8 )r r r Z
configpager r r delete_sectionk s
z ConfigChanges.delete_sectionc C s x| j D ] }|j qW dS )zClear all 4 pages.
Called in save_all after saving to idleConf.
XXX Mark window *title* when there are changes; unmark here.
N)r r )r r r r r r v s zConfigChanges.clearN) r r r r" r r r r r r r r r r r r s
r c sV ddl m d \} } fddfdd}|tj |tj td| d|d d
d S ) Nr )crc32c s. t | }td7 a |jddtat| d S )Nr zutf-8)encoding)r lineencodecrcrN )objZtxt)r r r sprint s z_dump..sprintc s t d| d xt| j D ]v}| | j } | | xT|D ]L}| | j|} | | x(|D ] } |d | | j|| qhW q@W qW d S )N
z = )rN sortedr< r* r r )rA r r* r r r )r r r dumpCfg s
z_dump..dumpCfgz
lines = z, crc = ri )sep)r r )zlibr r r? r@ rN )r r r r )r r r _dump s
r rD )r: z idlelib.idle_test.test_configr F) verbosityexit)r" Z configparserr r. rH Z tkinter.fontr rR Exceptionr r
r r r
r# r9 r r$ r rV dictr r r Zunittestr: r r r r s0 (H }
c