bpo-35598: IDLE: Switch config_key dialog to ttk widgets (GH-11365)

miss-islington · csabella · web-flow · commit d2694d47682b · 2018-12-30T12:30:09.000-08:00
(cherry picked from commit 4bd79c3) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
diff --git a/Lib/idlelib/config_key.py b/Lib/idlelib/config_key.py
@@ -1,8 +1,8 @@
 """
 Dialog for building Tkinter accelerator key bindings
 """
-from tkinter import *
-from tkinter.ttk import Scrollbar
+from tkinter import Toplevel, Listbox, Text, StringVar, TclError
+from tkinter.ttk import Button, Checkbutton, Entry, Frame, Label, Scrollbar
 from tkinter import messagebox
 import string
 import sys
@@ -67,11 +67,11 @@ def showerror(self, *args, **kwargs):
         messagebox.showerror(*args, **kwargs)
 
     def create_widgets(self):
-        self.frame = frame = Frame(self, borderwidth=2, relief=SUNKEN)
-        frame.pack(side=TOP, expand=True, fill=BOTH)
+        self.frame = frame = Frame(self, borderwidth=2, relief='sunken')
+        frame.pack(side='top', expand=True, fill='both')
 
         frame_buttons = Frame(self)
-        frame_buttons.pack(side=BOTTOM, fill=X)
+        frame_buttons.pack(side='bottom', fill='x')
 
         self.button_ok = Button(frame_buttons, text='OK',
                                 width=8, command=self.ok)
@@ -82,20 +82,20 @@ def create_widgets(self):
 
         # Basic entry key sequence.
         self.frame_keyseq_basic = Frame(frame, name='keyseq_basic')
-        self.frame_keyseq_basic.grid(row=0, column=0, sticky=NSEW,
+        self.frame_keyseq_basic.grid(row=0, column=0, sticky='nsew',
                                       padx=5, pady=5)
         basic_title = Label(self.frame_keyseq_basic,
                             text=f"New keys for '{self.action}' :")
-        basic_title.pack(anchor=W)
+        basic_title.pack(anchor='w')
 
-        basic_keys = Label(self.frame_keyseq_basic, justify=LEFT,
-                           textvariable=self.key_string, relief=GROOVE,
+        basic_keys = Label(self.frame_keyseq_basic, justify='left',
+                           textvariable=self.key_string, relief='groove',
                            borderwidth=2)
-        basic_keys.pack(ipadx=5, ipady=5, fill=X)
+        basic_keys.pack(ipadx=5, ipady=5, fill='x')
 
         # Basic entry controls.
         self.frame_controls_basic = Frame(frame)
-        self.frame_controls_basic.grid(row=1, column=0, sticky=NSEW, padx=5)
+        self.frame_controls_basic.grid(row=1, column=0, sticky='nsew', padx=5)
 
         # Basic entry modifiers.
         self.modifier_checkbuttons = {}
@@ -105,51 +105,51 @@ def create_widgets(self):
             check = Checkbutton(self.frame_controls_basic,
                                 command=self.build_key_string, text=label,
                                 variable=variable, onvalue=modifier, offvalue='')
-            check.grid(row=0, column=column, padx=2, sticky=W)
+            check.grid(row=0, column=column, padx=2, sticky='w')
             self.modifier_checkbuttons[modifier] = check
             column += 1
 
         # Basic entry help text.
-        help_basic = Label(self.frame_controls_basic, justify=LEFT,
+        help_basic = Label(self.frame_controls_basic, justify='left',
                            text="Select the desired modifier keys\n"+
                                 "above, and the final key from the\n"+
                                 "list on the right.\n\n" +
                                 "Use upper case Symbols when using\n" +
                                 "the Shift modifier.  (Letters will be\n" +
                                 "converted automatically.)")
-        help_basic.grid(row=1, column=0, columnspan=4, padx=2, sticky=W)
+        help_basic.grid(row=1, column=0, columnspan=4, padx=2, sticky='w')
 
         # Basic entry key list.
         self.list_keys_final = Listbox(self.frame_controls_basic, width=15,
-                                       height=10, selectmode=SINGLE)
+                                       height=10, selectmode='single')
         self.list_keys_final.bind('<ButtonRelease-1>', self.final_key_selected)
-        self.list_keys_final.grid(row=0, column=4, rowspan=4, sticky=NS)
+        self.list_keys_final.grid(row=0, column=4, rowspan=4, sticky='ns')
         scroll_keys_final = Scrollbar(self.frame_controls_basic,
-                                      orient=VERTICAL,
+                                      orient='vertical',
                                       command=self.list_keys_final.yview)
         self.list_keys_final.config(yscrollcommand=scroll_keys_final.set)
-        scroll_keys_final.grid(row=0, column=5, rowspan=4, sticky=NS)
+        scroll_keys_final.grid(row=0, column=5, rowspan=4, sticky='ns')
         self.button_clear = Button(self.frame_controls_basic,
                                    text='Clear Keys',
                                    command=self.clear_key_seq)
         self.button_clear.grid(row=2, column=0, columnspan=4)
 
         # Advanced entry key sequence.
         self.frame_keyseq_advanced = Frame(frame, name='keyseq_advanced')
-        self.frame_keyseq_advanced.grid(row=0, column=0, sticky=NSEW,
+        self.frame_keyseq_advanced.grid(row=0, column=0, sticky='nsew',
                                          padx=5, pady=5)
-        advanced_title = Label(self.frame_keyseq_advanced, justify=LEFT,
+        advanced_title = Label(self.frame_keyseq_advanced, justify='left',
                                text=f"Enter new binding(s) for '{self.action}' :\n" +
                                      "(These bindings will not be checked for validity!)")
-        advanced_title.pack(anchor=W)
+        advanced_title.pack(anchor='w')
         self.advanced_keys = Entry(self.frame_keyseq_advanced,
                                    textvariable=self.key_string)
-        self.advanced_keys.pack(fill=X)
+        self.advanced_keys.pack(fill='x')
 
         # Advanced entry help text.
         self.frame_help_advanced = Frame(frame)
-        self.frame_help_advanced.grid(row=1, column=0, sticky=NSEW, padx=5)
-        help_advanced = Label(self.frame_help_advanced, justify=LEFT,
+        self.frame_help_advanced.grid(row=1, column=0, sticky='nsew', padx=5)
+        help_advanced = Label(self.frame_help_advanced, justify='left',
             text="Key bindings are specified using Tkinter keysyms as\n"+
                  "in these samples: <Control-f>, <Shift-F2>, <F12>,\n"
                  "<Control-space>, <Meta-less>, <Control-Alt-Shift-X>.\n"
@@ -159,12 +159,12 @@ def create_widgets(self):
                  "is the 'do-nothing' keybinding.\n\n" +
                  "Multiple separate bindings for one action should be\n"+
                  "separated by a space, eg., <Alt-v> <Meta-v>." )
-        help_advanced.grid(row=0, column=0, sticky=NSEW)
+        help_advanced.grid(row=0, column=0, sticky='nsew')
 
         # Switch between basic and advanced.
         self.button_level = Button(frame, command=self.toggle_level,
                                   text='<< Basic Key Binding Entry')
-        self.button_level.grid(row=2, column=0, stick=EW, padx=5, pady=5)
+        self.button_level.grid(row=2, column=0, stick='ew', padx=5, pady=5)
         self.toggle_level()
 
     def set_modifiers_for_platform(self):
@@ -204,7 +204,7 @@ def final_key_selected(self, event=None):
     def build_key_string(self):
         "Create formatted string of modifiers plus the key."
         keylist = modifiers = self.get_modifiers()
-        final_key = self.list_keys_final.get(ANCHOR)
+        final_key = self.list_keys_final.get('anchor')
         if final_key:
             final_key = self.translate_key(final_key, modifiers)
             keylist.append(final_key)
@@ -217,8 +217,8 @@ def get_modifiers(self):
 
     def clear_key_seq(self):
         "Clear modifiers and keys selection."
-        self.list_keys_final.select_clear(0, END)
-        self.list_keys_final.yview(MOVETO, '0.0')
+        self.list_keys_final.select_clear(0, 'end')
+        self.list_keys_final.yview('moveto', '0.0')
         for variable in self.modifier_vars:
             variable.set('')
         self.key_string.set('')
@@ -237,7 +237,7 @@ def load_final_key_list(self):
         # Make a tuple of most of the useful common 'final' keys.
         keys = (self.alphanum_keys + self.punctuation_keys + self.function_keys +
                 self.whitespace_keys + self.edit_keys + self.move_keys)
-        self.list_keys_final.insert(END, *keys)
+        self.list_keys_final.insert('end', *keys)
 
     @staticmethod
     def translate_key(key, modifiers):
@@ -282,7 +282,7 @@ def keys_ok(self, keys):
         Doesn't check the string produced by the advanced dialog because
         'modifiers' isn't set.
         """
-        final_key = self.list_keys_final.get(ANCHOR)
+        final_key = self.list_keys_final.get('anchor')
         modifiers = self.get_modifiers()
         title = self.keyerror_title
         key_sequences = [key for keylist in self.current_key_sequences
diff --git a/Lib/idlelib/idle_test/test_config_key.py b/Lib/idlelib/idle_test/test_config_key.py
@@ -196,14 +196,14 @@ def test_get_modifiers(self):
         gm = dialog.get_modifiers
         eq = self.assertEqual
 
-        # Modifiers are set by selecting/deselecting the checkbutton.
-        dialog.modifier_checkbuttons['foo'].select()
+        # Modifiers are set on/off by invoking the checkbutton.
+        dialog.modifier_checkbuttons['foo'].invoke()
         eq(gm(), ['foo'])
 
-        dialog.modifier_checkbuttons['BAZ'].select()
+        dialog.modifier_checkbuttons['BAZ'].invoke()
         eq(gm(), ['foo', 'BAZ'])
 
-        dialog.modifier_checkbuttons['foo'].deselect()
+        dialog.modifier_checkbuttons['foo'].invoke()
         eq(gm(), ['BAZ'])
 
     def test_translate_key(self):
diff --git a/Misc/NEWS.d/next/IDLE/2018-12-27-15-29-11.bpo-35598.FWOOm8.rst b/Misc/NEWS.d/next/IDLE/2018-12-27-15-29-11.bpo-35598.FWOOm8.rst
@@ -1 +1 @@
-Update config_key: use PEP 8 names and add tests.
+Update config_key: use PEP 8 names, ttk widgets, and add tests.

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-Update config_key: use PEP 8 names and add tests.`
	`1`	`+Update config_key: use PEP 8 names, ttk widgets, and add tests.`