mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-10 10:47:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

idlelib.configHandler: revise docstrings, add spaces, use False/True, add some

Browse source 
TODOs (mostly to do after add tests), and make a few other changes.
This commit is contained in:
Terry Jan Reedy 2014-10-06 23:26:26 -04:00
parent 57fb11b255
commit deb7bf123c
1 changed files with 233 additions and 255 deletions
Download patch file Download diff file Expand all files Collapse all files

290
Lib/idlelib/configHandler.py
View file

@ -15,8 +15,9 @@ 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 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 a requested config value, a message is printed to stderr to aid in
configuration problem notification and resolution. configuration problem notification and resolution.
""" """
# TODOs added Oct 2014, tjr
import os import os
import sys import sys
@ -53,18 +54,14 @@ class IdleConfParser(ConfigParser):
return self.get(section, option, raw=raw) return self.get(section, option, raw=raw)
def GetOptionList(self, section): def GetOptionList(self, section):
""" "Return a list of options for given section, else []."
Get an option list for given section
"""
if self.has_section(section): if self.has_section(section):
return self.options(section) return self.options(section)
else: #return a default value else: #return a default value
return [] return []
def Load(self): def Load(self):
""" "Load the configuration file from disk."
Load the configuration file from disk
"""
self.read(self.file) self.read(self.file)
class IdleUserConfParser(IdleConfParser): class IdleUserConfParser(IdleConfParser):
@ -73,60 +70,49 @@ class IdleUserConfParser(IdleConfParser):
""" """
def AddSection(self, section): def AddSection(self, section):
""" "If section doesn't exist, add it."
if section doesn't exist, add it
"""
if not self.has_section(section): if not self.has_section(section):
self.add_section(section) self.add_section(section)
def RemoveEmptySections(self): def RemoveEmptySections(self):
""" "Remove any sections that have no options."
remove any sections that have no options
"""
for section in self.sections(): for section in self.sections():
if not self.GetOptionList(section): if not self.GetOptionList(section):
self.remove_section(section) self.remove_section(section)
def IsEmpty(self): def IsEmpty(self):
""" "Return True if no sections after removing empty sections."
Remove empty sections and then return 1 if parser has no sections
left, else return 0.
"""
self.RemoveEmptySections() self.RemoveEmptySections()
if self.sections(): return not self.sections()
return 0
else:
return 1
def RemoveOption(self, section, option): def RemoveOption(self, section, option):
""" """Return True if option is removed from section, else False.
If section/option exists, remove it.
Returns 1 if option was removed, 0 otherwise. False if either section does not exist or did not have option.
""" """
if self.has_section(section): if self.has_section(section):
return self.remove_option(section, option) return self.remove_option(section, option)
return False
def SetOption(self, section, option, value): def SetOption(self, section, option, value):
""" """Return True if option is added or changed to value, else False.
Sets option to value, adding section if required.
Returns 1 if option was added or changed, otherwise 0. Add section if required. False means option already had value.
""" """
if self.has_option(section, option): if self.has_option(section, option):
if self.get(section, option) == value: if self.get(section, option) == value:
return 0 return False
else: else:
self.set(section, option, value) self.set(section, option, value)
return 1 return True
else: else:
if not self.has_section(section): if not self.has_section(section):
self.add_section(section) self.add_section(section)
self.set(section, option, value) self.set(section, option, value)
return 1 return True
def RemoveFile(self): def RemoveFile(self):
""" "Remove user config file self.file from disk if it exists."
Removes the user config file from disk if it exists.
"""
if os.path.exists(self.file): if os.path.exists(self.file):
os.remove(self.file) os.remove(self.file)
@ -150,53 +136,50 @@ class IdleUserConfParser(IdleConfParser):
self.RemoveFile() self.RemoveFile()
class IdleConf: class IdleConf:
""" """Hold config parsers for all idle config files in singleton instance.
holds config parsers for all idle config files:
default config files Default config files, self.defaultCfg --
(idle install dir)/config-main.def for config_type in self.config_types:
(idle install dir)/config-extensions.def (idle install dir)/config-{config-type}.def
(idle install dir)/config-highlight.def
(idle install dir)/config-keys.def User config files, self.userCfg --
user config files for config_type in self.config_types:
(user home dir)/.idlerc/config-main.cfg (user home dir)/.idlerc/config-{config-type}.cfg
(user home dir)/.idlerc/config-extensions.cfg
(user home dir)/.idlerc/config-highlight.cfg
(user home dir)/.idlerc/config-keys.cfg
""" """
def __init__(self): def __init__(self):
self.config_types = ('main', 'extensions', 'highlight', 'keys')
self.defaultCfg = {} self.defaultCfg = {}
self.userCfg = {} self.userCfg = {}
self.cfg={} self.cfg = {} # TODO use to select userCfg vs defaultCfg
self.CreateConfigHandlers() self.CreateConfigHandlers()
self.LoadCfgFiles() self.LoadCfgFiles()
#self.LoadCfg()
def CreateConfigHandlers(self): def CreateConfigHandlers(self):
""" "Populate default and user config parser dictionaries."
set up a dictionary of config parsers for default and user
configurations respectively
"""
#build idle install path #build idle install path
if __name__ != '__main__': # we were imported if __name__ != '__main__': # we were imported
idleDir=os.path.dirname(__file__) idleDir=os.path.dirname(__file__)
else: # we were exec'ed (for testing only) else: # we were exec'ed (for testing only)
idleDir=os.path.abspath(sys.path[0]) idleDir=os.path.abspath(sys.path[0])
userDir=self.GetUserCfgDir() userDir=self.GetUserCfgDir()
configTypes=('main','extensions','highlight','keys')
defCfgFiles = {} defCfgFiles = {}
usrCfgFiles = {} usrCfgFiles = {}
for cfgType in configTypes: #build config file names # TODO eliminate these temporaries by combining loops
defCfgFiles[cfgType]=os.path.join(idleDir,'config-'+cfgType+'.def') for cfgType in self.config_types: #build config file names
usrCfgFiles[cfgType]=os.path.join(userDir,'config-'+cfgType+'.cfg') defCfgFiles[cfgType] = os.path.join(
for cfgType in configTypes: #create config parsers idleDir, 'config-' + cfgType + '.def')
usrCfgFiles[cfgType] = os.path.join(
userDir, 'config-' + cfgType + '.cfg')
for cfgType in self.config_types: #create config parsers
self.defaultCfg[cfgType] = IdleConfParser(defCfgFiles[cfgType]) self.defaultCfg[cfgType] = IdleConfParser(defCfgFiles[cfgType])
self.userCfg[cfgType] = IdleUserConfParser(usrCfgFiles[cfgType]) self.userCfg[cfgType] = IdleUserConfParser(usrCfgFiles[cfgType])
def GetUserCfgDir(self): def GetUserCfgDir(self):
""" """Return a filesystem directory for storing user config files.
Creates (if required) and returns a filesystem directory for storing
user config files.
Creates it if required.
""" """
cfgDir = '.idlerc' cfgDir = '.idlerc'
userDir = os.path.expanduser('~') userDir = os.path.expanduser('~')
@ -221,21 +204,21 @@ class IdleConf:
userDir + '\n Check path and permissions.\n Exiting!\n') userDir + '\n Check path and permissions.\n Exiting!\n')
print(warn, file=sys.stderr) print(warn, file=sys.stderr)
raise SystemExit raise SystemExit
# TODO continue without userDIr instead of exit
return userDir return userDir
def GetOption(self, configType, section, option, default=None, type=None, def GetOption(self, configType, section, option, default=None, type=None,
warn_on_default=True, raw=False): warn_on_default=True, raw=False):
""" """Return a value for configType section option, or default.
Get an option value for given config type and given general
configuration section/option or return a default. If type is specified,
return as type. Firstly the user configuration is checked, with a
fallback to the default configuration, and a final 'catch all'
fallback to a useable passed-in default if the option isn't present in
either the user or the default configuration.
configType must be one of ('main','extensions','highlight','keys')
If a default is returned, and warn_on_default is True, a warning is
printed to stderr.
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.
""" """
try: try:
if self.userCfg[configType].has_option(section, option): if self.userCfg[configType].has_option(section, option):
@ -246,16 +229,15 @@ class IdleConf:
' invalid %r value for configuration option %r\n' ' invalid %r value for configuration option %r\n'
' from section %r: %r' % ' from section %r: %r' %
(type, option, section, (type, option, section,
self.userCfg[configType].Get(section, option, self.userCfg[configType].Get(section, option, raw=raw)))
raw=raw)))
try: try:
print(warning, file=sys.stderr) print(warning, file=sys.stderr)
except OSError: except OSError:
pass pass
try: try:
if self.defaultCfg[configType].has_option(section,option): if self.defaultCfg[configType].has_option(section,option):
return self.defaultCfg[configType].Get(section, option, return self.defaultCfg[configType].Get(
type=type, raw=raw) section, option, type=type, raw=raw)
except ValueError: except ValueError:
pass pass
#returning default, print warning #returning default, print warning
@ -272,19 +254,16 @@ class IdleConf:
return default return default
def SetOption(self, configType, section, option, value): def SetOption(self, configType, section, option, value):
"""In user's config file, set section's option to value. """Set section option to value in user config file."""
"""
self.userCfg[configType].SetOption(section, option, value) self.userCfg[configType].SetOption(section, option, value)
def GetSectionList(self, configSet, configType): def GetSectionList(self, configSet, configType):
""" """Return sections for configSet configType configuration.
Get a list of sections from either the user or default config for
the given config type.
configSet must be either 'user' or 'default' configSet must be either 'user' or 'default'
configType must be one of ('main','extensions','highlight','keys') configType must be in self.config_types.
""" """
if not (configType in ('main','extensions','highlight','keys')): if not (configType in self.config_types):
raise InvalidConfigType('Invalid configType specified') raise InvalidConfigType('Invalid configType specified')
if configSet == 'user': if configSet == 'user':
cfgParser = self.userCfg[configType] cfgParser = self.userCfg[configType]
@ -295,8 +274,8 @@ class IdleConf:
return cfgParser.sections() return cfgParser.sections()
def GetHighlight(self, theme, element, fgBg=None): def GetHighlight(self, theme, element, fgBg=None):
""" """Return individual highlighting theme elements.
return individual highlighting theme elements.
fgBg - string ('fg'or'bg') or None, if None return a dictionary fgBg - string ('fg'or'bg') or None, if None return a dictionary
containing fg and bg colours (appropriate for passing to Tkinter in, containing fg and bg colours (appropriate for passing to Tkinter in,
e.g., a tag_config call), otherwise fg or bg colour only as specified. e.g., a tag_config call), otherwise fg or bg colour only as specified.
@ -322,13 +301,12 @@ class IdleConf:
raise InvalidFgBg('Invalid fgBg specified') raise InvalidFgBg('Invalid fgBg specified')
def GetThemeDict(self, type, themeName): def GetThemeDict(self, type, themeName):
""" """Return {option:value} dict for elements in themeName.
type - string, 'default' or 'user' theme type type - string, 'default' or 'user' theme type
themeName - string, theme name themeName - string, theme name
Returns a dictionary which holds {option:value} for each element Values are loaded over ultimate fallback defaults to guarantee
in the specified theme. Values are loaded over a set of ultimate last that all theme elements are present in a newly created theme.
fallback defaults to guarantee that all theme elements are present in
a newly created theme.
""" """
if type == 'user': if type == 'user':
cfgParser = self.userCfg['highlight'] cfgParser = self.userCfg['highlight']
@ -340,6 +318,7 @@ class IdleConf:
#(apart from cursor) even though all these values are not yet used #(apart from cursor) even though all these values are not yet used
#by idle, to allow for their use in the future. Default values are #by idle, to allow for their use in the future. Default values are
#generally black and white. #generally black and white.
# TODO make theme, a constant, a module or class attribute
theme ={'normal-foreground':'#000000', theme ={'normal-foreground':'#000000',
'normal-background':'#ffffff', 'normal-background':'#ffffff',
'keyword-foreground':'#000000', 'keyword-foreground':'#000000',
@ -386,21 +365,19 @@ class IdleConf:
return theme return theme
def CurrentTheme(self): def CurrentTheme(self):
""" "Return the name of the currently active theme."
Returns the name of the currently active theme
"""
return self.GetOption('main', 'Theme', 'name', default='') return self.GetOption('main', 'Theme', 'name', default='')
def CurrentKeys(self): def CurrentKeys(self):
""" "Return the name of the currently active key set."
Returns the name of the currently active key set
"""
return self.GetOption('main', 'Keys', 'name', default='') return self.GetOption('main', 'Keys', 'name', default='')
def GetExtensions(self, active_only=True, editor_only=False, shell_only=False): def GetExtensions(self, active_only=True, editor_only=False, shell_only=False):
""" """Return extensions in default and user config-extensions files.
Gets a list of all idle extensions declared in the config files.
active_only - boolean, if true only return active (enabled) extensions If active_only True, only return active (enabled) extensions
and optionally only editor or shell extensions.
If active_only False, return all extensions.
""" """
extns = self.RemoveKeyBindNames( extns = self.RemoveKeyBindNames(
self.GetSectionList('default', 'extensions')) self.GetSectionList('default', 'extensions'))
@ -415,7 +392,7 @@ class IdleConf:
if self.GetOption('extensions', extn, 'enable', default=True, if self.GetOption('extensions', extn, 'enable', default=True,
type='bool'): type='bool'):
#the extension is enabled #the extension is enabled
if editor_only or shell_only: if editor_only or shell_only: # TODO if both, contradictory
if editor_only: if editor_only:
option = "enable_editor" option = "enable_editor"
else: else:
@ -431,38 +408,38 @@ class IdleConf:
return extns return extns
def RemoveKeyBindNames(self, extnNameList): def RemoveKeyBindNames(self, extnNameList):
#get rid of keybinding section names "Return extnNameList with keybinding section names removed."
# TODO Easier to return filtered copy with list comp
names = extnNameList names = extnNameList
kbNameIndicies = [] kbNameIndicies = []
for name in names: for name in names:
if name.endswith(('_bindings', '_cfgBindings')): if name.endswith(('_bindings', '_cfgBindings')):
kbNameIndicies.append(names.index(name)) kbNameIndicies.append(names.index(name))
kbNameIndicies.sort() kbNameIndicies.sort(reverse=True)
kbNameIndicies.reverse()
for index in kbNameIndicies: #delete each keybinding section name for index in kbNameIndicies: #delete each keybinding section name
del(names[index]) del(names[index])
return names return names
def GetExtnNameForEvent(self, virtualEvent): def GetExtnNameForEvent(self, virtualEvent):
""" """Return the name of the extension binding virtualEvent, or None.
Returns the name of the extension that virtualEvent is bound in, or
None if not bound in any extension. virtualEvent - string, name of the virtual event to test for,
virtualEvent - string, name of the virtual event to test for, without without the enclosing '<< >>'
the enclosing '<< >>'
""" """
extName = None extName = None
vEvent = '<<' + virtualEvent + '>>' vEvent = '<<' + virtualEvent + '>>'
for extn in self.GetExtensions(active_only=0): for extn in self.GetExtensions(active_only=0):
for event in self.GetExtensionKeys(extn): for event in self.GetExtensionKeys(extn):
if event == vEvent: if event == vEvent:
extName=extn extName = extn # TODO return here?
return extName return extName
def GetExtensionKeys(self, extensionName): def GetExtensionKeys(self, extensionName):
""" """Return dict: {configurable extensionName event : active keybinding}.
returns a dictionary of the configurable keybindings for a particular
extension,as they exist in the dictionary returned by GetCurrentKeySet; Events come from default config extension_cfgBindings section.
that is, where previously used bindings are disabled. Keybindings come from GetCurrentKeySet() active key dict,
where previously used bindings are disabled.
""" """
keysName = extensionName + '_cfgBindings' keysName = extensionName + '_cfgBindings'
activeKeys = self.GetCurrentKeySet() activeKeys = self.GetCurrentKeySet()
@ -476,28 +453,29 @@ class IdleConf:
return extKeys return extKeys
def __GetRawExtensionKeys(self,extensionName): def __GetRawExtensionKeys(self,extensionName):
""" """Return dict {configurable extensionName event : keybinding list}.
returns a dictionary of the configurable keybindings for a particular
extension, as defined in the configuration files, or an empty dictionary Events come from default config extension_cfgBindings section.
if no bindings are found Keybindings list come from the splitting of GetOption, which
tries user config before default config.
""" """
keysName = extensionName+'_cfgBindings' keysName = extensionName+'_cfgBindings'
extKeys = {} extKeys = {}
if self.defaultCfg['extensions'].has_section(keysName): if self.defaultCfg['extensions'].has_section(keysName):
eventNames = self.defaultCfg['extensions'].GetOptionList(keysName) eventNames = self.defaultCfg['extensions'].GetOptionList(keysName)
for eventName in eventNames: for eventName in eventNames:
binding=self.GetOption('extensions',keysName, binding = self.GetOption(
eventName,default='').split() 'extensions', keysName, eventName, default='').split()
event = '<<' + eventName + '>>' event = '<<' + eventName + '>>'
extKeys[event] = binding extKeys[event] = binding
return extKeys return extKeys
def GetExtensionBindings(self, extensionName): def GetExtensionBindings(self, extensionName):
""" """Return dict {extensionName event : active or defined keybinding}.
Returns a dictionary of all the event bindings for a particular
extension. The configurable keybindings are returned as they exist in Augment self.GetExtensionKeys(extensionName) with mapping of non-
the dictionary returned by GetCurrentKeySet; that is, where re-used configurable events (from default config) to GetOption splits,
keybindings are disabled. as in self.__GetRawExtensionKeys.
""" """
bindsName = extensionName + '_bindings' bindsName = extensionName + '_bindings'
extBinds = self.GetExtensionKeys(extensionName) extBinds = self.GetExtensionKeys(extensionName)
@ -505,32 +483,32 @@ class IdleConf:
if self.defaultCfg['extensions'].has_section(bindsName): if self.defaultCfg['extensions'].has_section(bindsName):
eventNames = self.defaultCfg['extensions'].GetOptionList(bindsName) eventNames = self.defaultCfg['extensions'].GetOptionList(bindsName)
for eventName in eventNames: for eventName in eventNames:
binding=self.GetOption('extensions',bindsName, binding = self.GetOption(
eventName,default='').split() 'extensions', bindsName, eventName, default='').split()
event = '<<' + eventName + '>>' event = '<<' + eventName + '>>'
extBinds[event] = binding extBinds[event] = binding
return extBinds return extBinds
def GetKeyBinding(self, keySetName, eventStr): def GetKeyBinding(self, keySetName, eventStr):
""" """Return the keybinding list for keySetName eventStr.
returns the keybinding for a specific event.
keySetName - string, name of key binding set keySetName - name of key binding set (config-keys section).
eventStr - string, the virtual event we want the binding for, eventStr - virtual event, including brackets, as in '<<event>>'.
represented as a string, eg. '<<event>>'
""" """
eventName = eventStr[2:-2] #trim off the angle brackets eventName = eventStr[2:-2] #trim off the angle brackets
binding = self.GetOption('keys', keySetName, eventName, default='').split() binding = self.GetOption('keys', keySetName, eventName, default='').split()
return binding return binding
def GetCurrentKeySet(self): def GetCurrentKeySet(self):
"Return CurrentKeys with 'darwin' modifications."
result = self.GetKeySet(self.CurrentKeys()) result = self.GetKeySet(self.CurrentKeys())
if sys.platform == "darwin": if sys.platform == "darwin":
# OS X Tk variants do not support the "Alt" keyboard modifier. # OS X Tk variants do not support the "Alt" keyboard modifier.
# So replace all keybingings that use "Alt" with ones that # So replace all keybingings that use "Alt" with ones that
# use the "Option" keyboard modifier. # use the "Option" keyboard modifier.
# TO DO: the "Option" modifier does not work properly for # TODO (Ned?): the "Option" modifier does not work properly for
# Cocoa Tk and XQuartz Tk so we should not use it # Cocoa Tk and XQuartz Tk so we should not use it
# in default OS X KeySets. # in default OS X KeySets.
for k, v in result.items(): for k, v in result.items():
@ -541,10 +519,10 @@ class IdleConf:
return result return result
def GetKeySet(self, keySetName): def GetKeySet(self, keySetName):
""" """Return event-key dict for keySetName core plus active extensions.
Returns a dictionary of: all requested core keybindings, plus the
keybindings for all currently active extensions. If a binding defined If a binding defined in an extension is already in use, the
in an extension is already in use, that binding is disabled. extension binding is disabled by being set to ''
""" """
keySet = self.GetCoreKeys(keySetName) keySet = self.GetCoreKeys(keySetName)
activeExtns = self.GetExtensions(active_only=1) activeExtns = self.GetExtensions(active_only=1)
@ -559,21 +537,24 @@ class IdleConf:
return keySet return keySet
def IsCoreBinding(self, virtualEvent): def IsCoreBinding(self, virtualEvent):
""" """Return True if the virtual event is one of the core idle key events.
returns true if the virtual event is bound in the core idle keybindings.
virtualEvent - string, name of the virtual event to test for, without virtualEvent - string, name of the virtual event to test for,
the enclosing '<< >>' without the enclosing '<< >>'
""" """
return ('<<'+virtualEvent+'>>') in self.GetCoreKeys() return ('<<'+virtualEvent+'>>') in self.GetCoreKeys()
# TODO make keyBindins a file or class attribute used for test above
# and copied in function below
def GetCoreKeys(self, keySetName=None): def GetCoreKeys(self, keySetName=None):
""" """Return dict of core virtual-key keybindings for keySetName.
returns the requested set of core keybindings, with fallbacks if
required. The default keySetName None corresponds to the keyBindings base
Keybindings loaded from the config file(s) are loaded _over_ these dict. If keySetName is not None, bindings from the config
defaults, so if there is a problem getting any core binding there will file(s) are loaded _over_ these defaults, so if there is a
be an 'ultimate last resort fallback' to the CUA-ish bindings problem getting any core binding there will be an 'ultimate last
defined here. resort fallback' to the CUA-ish bindings defined here.
""" """
keyBindings={ keyBindings={
'<<copy>>': ['<Control-c>', '<Control-C>'], '<<copy>>': ['<Control-c>', '<Control-C>'],
@ -644,7 +625,7 @@ class IdleConf:
return keyBindings return keyBindings
def GetExtraHelpSourceList(self, configSet): def GetExtraHelpSourceList(self, configSet):
"""Fetch list of extra help sources from a given configSet. """Return list of extra help sources from a given configSet.
Valid configSets are 'user' or 'default'. Return a list of tuples of 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 the form (menu_item , path_to_help_file , option), or return the empty
@ -676,32 +657,29 @@ class IdleConf:
return helpSources return helpSources
def GetAllExtraHelpSourcesList(self): def GetAllExtraHelpSourcesList(self):
""" """Return a list of the details of all additional help sources.
Returns a list of tuples containing the details of all additional help
sources configured, or an empty list if there are none. Tuples are of Tuples in the list are those of GetExtraHelpSourceList.
the format returned by GetExtraHelpSourceList.
""" """
allHelpSources = (self.GetExtraHelpSourceList('default') + allHelpSources = (self.GetExtraHelpSourceList('default') +
self.GetExtraHelpSourceList('user') ) self.GetExtraHelpSourceList('user') )
return allHelpSources return allHelpSources
def LoadCfgFiles(self): def LoadCfgFiles(self):
""" "Load all configuration files."
load all configuration files.
"""
for key in self.defaultCfg: for key in self.defaultCfg:
self.defaultCfg[key].Load() self.defaultCfg[key].Load()
self.userCfg[key].Load() #same keys self.userCfg[key].Load() #same keys
def SaveUserCfgFiles(self): def SaveUserCfgFiles(self):
""" "Write all loaded user configuration files to disk."
write all loaded user configuration files back to disk
"""
for key in self.userCfg: for key in self.userCfg:
self.userCfg[key].Save() self.userCfg[key].Save()
idleConf = IdleConf() idleConf = IdleConf()
# TODO Revise test output, write expanded unittest
### module test ### module test
if __name__ == '__main__': if __name__ == '__main__':
def dumpCfg(cfg): def dumpCfg(cfg):