gh-63075: IDLE editor - Auto insertion of the closers

Lib/idlelib/ParenClose.py

@@ -0,0 +1,115 @@
+"""
+Parens and Ticks Closing Extension
+
+When you hit left paren or tick,
+automatically creates the closing paren or tick.
+
+Author: Charles M. Wohlganger
+        charles.wohlganger@gmail.com
+
+Last Updated: 13-Aug-2017 by Charles Wohlganger
+
+Add to the end of config-extensions.def :
+
+    [ParenClose]
+    enable = True
+    paren_close = True
+    tick_close = True
+    skip_closures = True
+    mutual_delete = True
+    [ParenClose_cfgBindings]
+    p-open = <Key-parenleft> <Key-bracketleft> <Key-braceleft>
+    t-open = <Key-quotedbl> <Key-quoteright>
+    p-close = <Key-parenright> <Key-bracketright> <Key-braceright>
+    back = <Key-BackSpace>
+    delete = <Key-Delete>
+"""
+
+from idlelib.config import idleConf
+
+
+class ParenClose:
+    '''
+    When loaded as an extension to IDLE, and paren_close is True, the symbols
+    ([{ will have their closures printed after them and the insertion cursor
+    moved between the two.  The same is true for tick closures and the symbols
+    ' and ".  When \'\'\' or """ are typed and tick_close is True, it will also
+    produce the closing symbols. If skip_closures is True, then when a closure
+    symbol is typed and the same one is to the right of it, that symbols is
+    deleted before the new one is typed, effectively skipping over the closure.
+    If the cursor is between two closures and mutual_delete or mutual_backspace
+    is True, when the respective command is given, both closures are deleted.
+    '''
+
+    closers = {'(': ')', '[': ']', '{': '}', "'": "'", '"': '"'}
+
+    def __init__(self, editwin=None):
+        # Setting default to none makes testing easier.
+        if editwin:
+            self.text = editwin.text
+        else:
+            self.text = None
+        self.paren_close = idleConf.GetOption(
+            'extensions', 'ParenClose', 'paren_close',
+            type='bool', default=True)
+        self.tick_close = idleConf.GetOption(
+            'extensions', 'ParenClose', 'tick_close',
+            type='bool', default=True)
+        self.skip_closures = idleConf.GetOption(
+            'extensions', 'ParenClose', 'skip_closures',
+            type='bool', default=True)
+        self.mutual_delete = idleConf.GetOption(
+            'extensions', 'ParenClose', 'mutual_delete',
+            type='bool', default=True)
+        self.mutual_backspace = idleConf.GetOption(
+            'extensions', 'ParenClose', 'mutual_backspace',
+            type='bool', default=True)
+
+    def delcheck(self, pos):
+        symbol1 = self.text.get(pos + '-1c', pos)
+        symbol2 = self.text.get(pos, pos + '+1c')
+        return (symbol1 in self.closers
+                and self.closers[symbol1] == symbol2)
+
+    def back_event(self, event):
+        if self.mutual_backspace:
+            pos = self.text.index('insert')
+            if self.delcheck(pos):
+                self.text.delete(pos, pos + '+1c')
+
+    def delete_event(self, event):
+        if self.mutual_delete:
+            pos = self.text.index('insert')
+            if self.delcheck(pos):
+                self.text.delete(pos + '-1c', pos)
+
+    def p_open_event(self, event):
+        if self.paren_close:
+            pos = self.text.index('insert')
+            self.text.insert(pos, self.closers[event.char])
+            self.text.mark_set('insert', pos)
+
+    def p_close_event(self, event):
+        pos = self.text.index('insert')
+        if self.skip_closures \
+           and self.text.get(pos, pos + ' +1c') == event.char:
+            self.text.delete(pos, pos + '+1c')
+            return True
+        return False
+
+    def t_open_event(self, event):
+        if self.tick_close:
+            pos = self.text.index('insert')
+            if self.text.get(pos + ' -2c', pos) == event.char * 2 \
+               and self.text.get(pos, pos + ' +1c') != event.char:
+                # Instead of one tick, add three ticks if there are two;
+                # user wants to make docstring or multiline.
+                self.text.insert(pos, event.char * 3)
+                self.text.mark_set('insert', pos)
+            elif not self.p_close_event(event):
+                self.p_open_event(event)
+
+
+if __name__ == '__main__':
+    import unittest
+    unittest.main('idlelib.idle_test.test_parenclose', verbosity=2)

Lib/idlelib/config-extensions.def

@@ -63,3 +63,17 @@ z-text= Z
 z-in= <Control-Shift-KeyRelease-Insert>
 [ZzDummy_bindings]
 z-out= <Control-Shift-KeyRelease-Delete>
+
+[ParenClose]
+enable = True
+paren_close = True
+tick_close = True
+skip_closures = True
+mutual_delete = True
+mutual_backspace = True
+[ParenClose_bindings]
+p-open = <Key-parenleft> <Key-bracketleft> <Key-braceleft>
+t-open = <Key-quotedbl> <Key-quoteright>
+p-close = <Key-parenright> <Key-bracketright> <Key-braceright>
+back = <Key-BackSpace>
+delete = <Key-Delete>

Lib/idlelib/idle_test/test_config.py

@@ -439,21 +439,21 @@ def test_get_extensions(self):
             ''')
         eq = self.assertEqual
         iGE = idleConf.GetExtensions
-        eq(iGE(shell_only=True), [])
-        eq(iGE(), ['ZzDummy'])
-        eq(iGE(editor_only=True), ['ZzDummy'])
-        eq(iGE(active_only=False), ['ZzDummy', 'DISABLE'])
-        eq(iGE(active_only=False, editor_only=True), ['ZzDummy', 'DISABLE'])
+        eq(iGE(shell_only=True), ['ParenClose'])
+        eq(iGE(), ['ZzDummy', 'ParenClose'])
+        eq(iGE(editor_only=True), ['ZzDummy', 'ParenClose'])
+        eq(iGE(active_only=False), ['ZzDummy', 'ParenClose', 'DISABLE'])
+        eq(iGE(active_only=False, editor_only=True), ['ZzDummy', 'ParenClose', 'DISABLE'])
         userextn.remove_section('ZzDummy')
         userextn.remove_section('DISABLE')
 
-
     def test_remove_key_bind_names(self):
         conf = self.mock_config()
 
         self.assertCountEqual(
             conf.RemoveKeyBindNames(conf.GetSectionList('default', 'extensions')),
-            ['AutoComplete', 'CodeContext', 'FormatParagraph', 'ParenMatch','ZzDummy'])
+            ['AutoComplete', 'CodeContext', 'FormatParagraph', 'ParenClose',
+             'ParenMatch','ZzDummy'])
 
     def test_get_extn_name_for_event(self):
         userextn.read_string('''

Lib/idlelib/idle_test/test_parenclose.py

@@ -0,0 +1,97 @@
+'''Test idlelib.parenclose.
+'''
+from idlelib.ParenClose import ParenClose
+import unittest
+# Can't use mock text; it doesn't handle positioning correctly.
+from tkinter import Text
+from test.support import requires
+requires('gui')
+
+class MockEvent(object):
+    def __init__(self, char):
+        self.char = char
+
+
+class ParenCloseTest(unittest.TestCase):
+    def test_parenClose(self):
+        p = ParenClose()
+        p.text = Text()
+        p_open = p.p_open_event
+        p_close = p.p_close_event
+        t_open = p.t_open_event
+        back = p.back_event
+        delete = p.delete_event
+        for paren_close_set, tick_close_set, skip_closures_set, mutual_b_set, \
+            mutual_d_set, insert, func, pos, char, result, posend in [
+              (1, 1, 1, 1, 1, 'def abuse', p_open, '1.9', '(',
+               'def abuse()', '1.10'),
+              (1, 1, 1, 1, 1, 'spam = ', p_open, '1.7', '[',
+               'spam = []', '1.8'),
+              (1, 1, 1, 1, 1, 'eggs = ', p_open, '1.7', '{',
+               'eggs = {}', '1.8'),
+              (1, 1, 1, 1, 1, 'def abuse2()', p_close, '1.11', ')',
+               'def abuse2()', '1.12'),
+              (1, 1, 1, 1, 1, 'spam2 = []', p_close, '1.9', ']',
+               'spam2 = []', '1.10'),
+              (1, 1, 1, 1, 1, 'eggs2 = {}', p_close, '1.9', '}',
+               'eggs2 = {}', '1.10'),
+              (1, 1, 1, 1, 1, "color = ", t_open, '1.8', "'",
+               "color = ''", '1.9'),
+              (1, 1, 1, 1, 1, "velocity = ", t_open, '1.11', '"',
+               'velocity = ""', '1.12'),
+              (1, 1, 1, 1, 1, "more_spam = ''", t_open, '1.14', "'",
+               "more_spam = ''''''", '1.15'),
+              (1, 1, 1, 1, 1, 'more_eggs = ""', t_open, '1.14', '"',
+               'more_eggs = """"""', '1.15'),
+              (1, 1, 1, 1, 1, "more_spam2 = ''''''", t_open, '1.16', "'",
+               "more_spam2 = ''''''", '1.17'),
+              (1, 1, 1, 1, 1, 'more_eggs2 = """"""', t_open, '1.16', '"',
+               'more_eggs2 = """"""', '1.17'),
+              (0, 1, 1, 1, 1,  'no_spam = ', p_open, '1.10', '(',
+               'no_spam = (', '1.11'),
+              (1, 0, 1, 1, 1, 'no_velocity = ', t_open, '1.14', "'",
+               "no_velocity = '", '1.15'),
+              (1, 0, 1, 1, 1, 'no_more_eggs = ""', t_open, '1.17', '"',
+               'no_more_eggs = """', '1.18'),
+              (1, 1, 0, 1, 1, 'tinny = []', p_close, '1.9', ']',
+               'tinny = []]', '1.10'),
+              (1, 1, 0, 1, 1, 'gone = ""', t_open, '1.8', '"',
+               'gone = """"', '1.9'),
+              (0, 0, 0, 0, 1, "honk = []", back, '1.8', '',
+               "honk = []", '1.8'),
+              (0, 0, 0, 1, 0, "henk = ()", delete, '1.8', '',
+               "henk = ()", '1.8'),
+              (0, 0, 0, 1, 1, 'nurb = ""', back, '1.8', '',
+               'nurb = "', '1.8'),
+              (0, 0, 0, 1, 1, 'chiz = []', delete, '1.8', '',
+               'chiz = ]', '1.7'),
+              (0, 0, 0, 1, 1, 'pink = {}', back, '1.8', '',
+               'pink = {', '1.8')
+              ]:
+            # The actual delete and backspace events do not occur in
+            # this test. We are checking to make sure everything is
+            # correct before they would delete or backspace.
+
+            # Reset text and self.
+            p.paren_close = paren_close_set
+            p.tick_close = tick_close_set
+            p.skip_closures = skip_closures_set
+            p.mutual_delete = mutual_d_set
+            p.mutual_backspace = mutual_b_set
+            p.text.delete('1.0', 'end')
+            # Write text, move to current position, write character.
+            p.text.insert('1.0', insert)
+            p.text.mark_set('insert', pos)
+            event = MockEvent(char)
+            func(event)
+            pos = p.text.index('insert')
+            p.text.insert(pos, char)
+            # Checking position and text at the same time
+            # makes it easier to spot where errors occur.
+            pos = p.text.index('insert')
+            actual = p.text.get('1.0', 'end')
+            self.assertTupleEqual((actual, pos), (result+'\n', posend))
+
+
+if __name__ == '__main__':
+    unittest.main(verbosity=2)