gh-89520: IDLE - Make extentions use user's keys, not all defaults

Lib/idlelib/config.py

@@ -28,6 +28,7 @@
 from configparser import ConfigParser
 import os
 import sys
+from collections import ChainMap
 
 from tkinter.font import Font
 import idlelib
@@ -192,7 +193,7 @@ def GetUserCfgDir(self):
                     except OSError:
                         pass
                 userDir = '~'
-        if userDir == "~": # still no path to home!
+        if userDir == '~': # still no path to home!
             # traditionally IDLE has defaulted to os.getcwd(), is this adequate?
             userDir = os.getcwd()
         userDir = os.path.join(userDir, cfgDir)
@@ -208,7 +209,7 @@ def GetUserCfgDir(self):
                     except OSError:
                         pass
                 raise SystemExit
-        # TODO continue without userDIr instead of exit
+        # TODO continue without userDir instead of exit
         return userDir
 
     def GetOption(self, configType, section, option, default=None, type=None,
@@ -266,7 +267,7 @@ def GetSectionList(self, configSet, configType):
         if configSet == 'user':
             cfgParser = self.userCfg[configType]
         elif configSet == 'default':
-            cfgParser=self.defaultCfg[configType]
+            cfgParser = self.defaultCfg[configType]
         else:
             raise InvalidConfigSet('Invalid configSet specified')
         return cfgParser.sections()
@@ -402,7 +403,7 @@ def current_colors_and_keys(self, section):
 
     @staticmethod
     def default_keys():
-        if sys.platform[:3] == 'win':
+        if sys.platform.startswith('win'):
             return 'IDLE Classic Windows'
         elif sys.platform == 'darwin':
             return 'IDLE Classic OSX'
@@ -440,7 +441,7 @@ def GetExtensions(self, active_only=True,
                             option = "enable_editor"
                         else:
                             option = "enable_shell"
-                        if self.GetOption('extensions', extn,option,
+                        if self.GetOption('extensions', extn, option,
                                           default=True, type='bool',
                                           warn_on_default=False):
                             activeExtns.append(extn)
@@ -468,61 +469,95 @@ def GetExtnNameForEvent(self, virtualEvent):
                     extName = extn  # TODO return here?
         return extName
 
-    def GetExtensionKeys(self, extensionName):
+    def GetExtensionKeys(self, extension_name):
         """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.
         """
-        keysName = extensionName + '_cfgBindings'
-        activeKeys = self.GetCurrentKeySet()
-        extKeys = {}
-        if self.defaultCfg['extensions'].has_section(keysName):
-            eventNames = self.defaultCfg['extensions'].GetOptionList(keysName)
-            for eventName in eventNames:
-                event = '<<' + eventName + '>>'
-                binding = activeKeys[event]
-                extKeys[event] = binding
-        return extKeys
-
-    def __GetRawExtensionKeys(self,extensionName):
+        bindings_section = f'{extension_name}_cfgBindings'
+        current_keyset = idleConf.GetCurrentKeySet()
+        extension_keys = {}
+
+        event_names = set()
+        if self.userCfg['extensions'].has_section(bindings_section):
+            event_names |= set(
+                self.userCfg['extensions'].GetOptionList(bindings_section)
+            )
+        if self.defaultCfg['extensions'].has_section(bindings_section):
+            event_names |= set(
+                self.defaultCfg['extensions'].GetOptionList(bindings_section)
+            )
+
+        for event_name in event_names:
+            event = f'<<{event_name}>>'
+            binding = current_keyset.get(event, None)
+            if binding is None:
+                continue
+            extension_keys[event] = binding
+        return extension_keys
+
+    def __GetRawExtensionKeys(self, extension_name):
         """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.
         """
-        keysName = extensionName+'_cfgBindings'
-        extKeys = {}
-        if self.defaultCfg['extensions'].has_section(keysName):
-            eventNames = self.defaultCfg['extensions'].GetOptionList(keysName)
-            for eventName in eventNames:
-                binding = self.GetOption(
-                        'extensions', keysName, eventName, default='').split()
-                event = '<<' + eventName + '>>'
-                extKeys[event] = binding
-        return extKeys
-
-    def GetExtensionBindings(self, extensionName):
+        bindings_section = f'{extension_name}_cfgBindings'
+        extension_keys = {}
+
+        event_names = []
+        if self.userCfg['extensions'].has_section(bindings_section):
+            event_names.append(self.userCfg['extensions'].GetOptionList(bindings_section))
+        if self.defaultCfg['extensions'].has_section(bindings_section):
+            event_names.append(self.defaultCfg['extensions'].GetOptionList(bindings_section))
+
+        # Because chain map, favors user bindings over default bindings
+        for event_name in ChainMap(*event_names):
+            binding = self.GetOption(
+                'extensions',
+                bindings_section,
+                event_name,
+                default='',
+            ).split()
+            event = f'<<{event_name}>>'
+            extension_keys[event] = binding
+        return extension_keys
+
+    def GetExtensionBindings(self, extension_name):
         """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.
         """
-        bindsName = extensionName + '_bindings'
-        extBinds = self.GetExtensionKeys(extensionName)
-        #add the non-configurable bindings
-        if self.defaultCfg['extensions'].has_section(bindsName):
-            eventNames = self.defaultCfg['extensions'].GetOptionList(bindsName)
-            for eventName in eventNames:
-                binding = self.GetOption(
-                        'extensions', bindsName, eventName, default='').split()
-                event = '<<' + eventName + '>>'
-                extBinds[event] = binding
-
-        return extBinds
+        bindings_section = f'{extension_name}_bindings'
+        extension_keys = self.GetExtensionKeys(extension_name)
+
+        # add the non-configurable bindings
+        values = []
+        if self.userCfg['extensions'].has_section(bindings_section):
+            values.append(
+                self.userCfg['extensions'].GetOptionList(bindings_section)
+            )
+        if self.defaultCfg['extensions'].has_section(bindings_section):
+            values.append(
+                self.defaultCfg['extensions'].GetOptionList(bindings_section)
+            )
+
+        # Because chain map, favors user bindings over default bindings
+        for event_name in ChainMap(*values):
+            binding = self.GetOption(
+                'extensions',
+                bindings_section,
+                event_name,
+                default=''
+            ).split()
+            event = f'<<{event_name}>>'
+            extension_keys[event] = binding
+        return extension_keys
 
     def GetKeyBinding(self, keySetName, eventStr):
         """Return the keybinding list for keySetName eventStr.
@@ -703,7 +738,7 @@ def GetExtraHelpSourceList(self, configSet):
             cfgParser = self.defaultCfg['main']
         else:
             raise InvalidConfigSet('Invalid configSet specified')
-        options=cfgParser.GetOptionList('HelpFiles')
+        options = cfgParser.GetOptionList('HelpFiles')
         for option in options:
             value=cfgParser.Get('HelpFiles', option, default=';')
             if value.find(';') == -1: #malformed config entry with no ';'
@@ -714,7 +749,7 @@ def GetExtraHelpSourceList(self, configSet):
                 menuItem=value[0].strip()
                 helpPath=value[1].strip()
             if menuItem and helpPath: #neither are empty strings
-                helpSources.append( (menuItem,helpPath,option) )
+                helpSources.append( (menuItem, helpPath, option) )
         helpSources.sort(key=lambda x: x[2])
         return helpSources
 
@@ -757,7 +792,8 @@ def LoadCfgFiles(self):
         "Load all configuration files."
         for key in self.defaultCfg:
             self.defaultCfg[key].Load()
-            self.userCfg[key].Load() #same keys
+        for key in self.userCfg:
+            self.userCfg[key].Load()
 
     def SaveUserCfgFiles(self):
         "Write all loaded user configuration files to disk."

Lib/idlelib/configdialog.py

@@ -1960,23 +1960,33 @@ def create_page_extensions(self):
     def load_extensions(self):
         "Fill self.extensions with data from the default and user configs."
         self.extensions = {}
+
         for ext_name in idleConf.GetExtensions(active_only=False):
             # Former built-in extensions are already filtered out.
             self.extensions[ext_name] = []
 
         for ext_name in self.extensions:
-            opt_list = sorted(self.ext_defaultCfg.GetOptionList(ext_name))
+            default = set(self.ext_defaultCfg.GetOptionList(ext_name))
+            user = set(self.ext_userCfg.GetOptionList(ext_name))
+            opt_list = sorted(default | user)
 
             # Bring 'enable' options to the beginning of the list.
-            enables = [opt_name for opt_name in opt_list
-                       if opt_name.startswith('enable')]
+            enables = [
+                opt_name
+                for opt_name in opt_list
+                if opt_name.startswith('enable')
+            ]
             for opt_name in enables:
                 opt_list.remove(opt_name)
             opt_list = enables + opt_list
 
             for opt_name in opt_list:
-                def_str = self.ext_defaultCfg.Get(
-                        ext_name, opt_name, raw=True)
+                if opt_name in user_list:
+                    def_str = self.ext_userCfg.Get(
+                            ext_name, opt_name, raw=True)
+                else:
+                    def_str = self.ext_defaultCfg.Get(
+                            ext_name, opt_name, raw=True)
                 try:
                     def_obj = {'True':True, 'False':False}[def_str]
                     opt_type = 'bool'
@@ -1988,9 +1998,14 @@ def load_extensions(self):
                         def_obj = def_str
                         opt_type = None
                 try:
-                    value = self.ext_userCfg.Get(
-                            ext_name, opt_name, type=opt_type, raw=True,
-                            default=def_obj)
+                    if opt_name in user_list:
+                        value = self.ext_userCfg.Get(
+                                ext_name, opt_name, type=opt_type, raw=True,
+                                default=def_obj)
+                    else:
+                        value = self.ext_defaultCfg.Get(
+                                ext_name, opt_name, type=opt_type, raw=True,
+                                default=def_obj)
                 except ValueError:  # Need this until .Get fixed.
                     value = def_obj  # Bad values overwritten by entry.
                 var = StringVar(self)
@@ -2038,7 +2053,7 @@ def create_extension_frame(self, ext_name):
                       validatecommand=(self.is_int, '%P'), width=10
                       ).grid(row=row, column=1, sticky=NSEW, padx=7)
 
-            else:  # type == 'str'
+            else:  # opt['type'] == 'str'
                 # Limit size to fit non-expanding space with larger font.
                 Entry(entry_area, textvariable=var, width=15
                       ).grid(row=row, column=1, sticky=NSEW, padx=7)
@@ -2054,10 +2069,11 @@ def set_extension_value(self, section, opt):
         default = opt['default']
         value = opt['var'].get().strip() or default
         opt['var'].set(value)
-        # if self.defaultCfg.has_section(section):
-        # Currently, always true; if not, indent to return.
-        if (value == default):
+
+        # Only save option in user config if it differs from the default
+        if self.ext_defaultCfg.has_section(section) and value == default:
             return self.ext_userCfg.RemoveOption(section, name)
+
         # Set the option.
         return self.ext_userCfg.SetOption(section, name, value)
 
@@ -2072,8 +2088,7 @@ def save_all_changed_extensions(self):
         """
         has_changes = False
         for ext_name in self.extensions:
-            options = self.extensions[ext_name]
-            for opt in options:
+            for opt in self.extensions[ext_name]:
                 if self.set_extension_value(ext_name, opt):
                     has_changes = True
         if has_changes:

Lib/idlelib/editor.py

@@ -1,3 +1,4 @@
+import contextlib
 import importlib.abc
 import importlib.util
 import os
@@ -903,11 +904,12 @@ def RemoveKeybindings(self):
         # Called from configdialog.deactivate_current_config.
         self.mainmenu.default_keydefs = keydefs = idleConf.GetCurrentKeySet()
         for event, keylist in keydefs.items():
-            self.text.event_delete(event, *keylist)
+            with contextlib.suppress(ValueError):
+                self.text.event_delete(event, *keylist)
         for extensionName in self.get_standard_extension_names():
             xkeydefs = idleConf.GetExtensionBindings(extensionName)
-            if xkeydefs:
-                for event, keylist in xkeydefs.items():
+            for event, keylist in xkeydefs.items():
+                with contextlib.suppress(ValueError):
                     self.text.event_delete(event, *keylist)
 
     def ApplyKeybindings(self):

Misc/NEWS.d/next/IDLE/2021-10-03-21-55-34.bpo-45357.etEExa.rst

@@ -0,0 +1 @@
+Make idlelib.config.idleConf's functions GetExtensionKeys, __GetRawExtensionKeys, and GetKeyBinding look at user config files, allowing custom extensions to have key-binds defined in ~/.idlerc instead of in the default key-binds file.