IDLE: add base Query dialog with ttk widgets

[terryjreedy]

BPO	27380
Nosy	@terryjreedy, @ned-deily, @roseman, @serhiy-storchaka
Files	query.diff query2.diff query3.diff query4.diff query-helpsource.diff query-helpsource2.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/terryjreedy'
closed_at = <Date 2016-08-10.19:39:59.202>
created_at = <Date 2016-06-24.04:15:17.216>
labels = ['expert-IDLE', 'type-feature']
title = 'IDLE: add base Query dialog with ttk widgets'
updated_at = <Date 2019-03-21.18:17:20.620>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2019-03-21.18:17:20.620>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2016-08-10.19:39:59.202>
closer = 'ned.deily'
components = ['IDLE']
creation = <Date 2016-06-24.04:15:17.216>
creator = 'terry.reedy'
dependencies = []
files = ['43526', '43554', '43570', '43618', '43651', '43658']
hgrepos = []
issue_num = 27380
keywords = ['patch']
message_count = 17.0
messages = ['269154', '269337', '269338', '269347', '269411', '269415', '269774', '269777', '269920', '269967', '269972', '269973', '272198', '272216', '272345', '272348', '272367']
nosy_count = 5.0
nosy_names = ['terry.reedy', 'ned.deily', 'markroseman', 'python-dev', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue27380'
versions = ['Python 3.6']

[terryjreedy]

The custom popup entry dialogs in config_sec and config_help have a common structure and overlapping code. When one hits OK and the entry is not valid, both display a specific message and let the user edit the entry (or Cancel).

File => Load Module, on the other hand, uses tkSimpleDialog.askstring. No error checking is done before the box disappears. If there is an error, even a simple misspelling, one must start over. It is really annoying to use. I want to replace this with a custom popup that would be the same as the one in config_sec, except for title, prompt, and validation function. If the name given has multiple conponents, such as idlelib.idelhelp.help_xyz, I would like to report which is the first invalid component (going from left to right).

I am therefore adding a new module, query.py, with a new Query class that will be the baseclass for three derived classes.

The partial patch renames config_sec.py (formerly configSectionNameDialog.py) to query.py. The corresponding test_config_sec) becomes test_query. It splits class GetCfgSectionNameDialog into a base class Query and a subclass SectionName. Query is responsible for the popup, and used ttk widgets as appropriate. SectionName overrides the entry validation function entry_ok (formerly name_ok). The test functions have been similarly split.

What remains are ModuleName and HelpSource subclasses, corresponding tests, and integration with the software that would use them.

[python-dev]

New changeset 4796d7fb00c5 by Terry Jan Reedy in branch 'default':
Issue bpo-27380: IDLE: add base Query dialog, with ttk widgets and subclass
https://hg.python.org/cpython/rev/4796d7fb00c5

[terryjreedy]

Pushed with minor changes. I decided not to wait until I added more subclasses because file renames with post rename changes do not survive shelving. Reloading from the diff requires 'rediscovering' the renames.

[serhiy-storchaka]

You can use True and False instead of TRUE and FALSE. You can import constants with "from tkinter.constants import *". The benefit of using constants instead of string literals is early failing in case of typo.

[terryjreedy]

Thanks, I will switch to True and False.

I am aware of the possibility of separately importing the constants, but like some others, I prefer the strings. Compile-time checking is a good point, especially with no run tests. In this case, test_query has 100% coverage of query.py.

Minor question: While trying to use the new widget (instead of tkSimpledialog) in (editor.EditorWindow).open_module I had problems which I am trying to pin down by taking smaller steps. As part of this, I tried this minimal code that uses Query.

from idlelib import query
from tkinter import Tk
root = Tk()
name = query.Query(root, "Open Module",
         "Enter the name of a Python module\n"
         "to search on sys.path and open:",).result
print(name)

It works fine except that entry.focus_set() is not working for me with this call (or else it is not staying set) even though it works fine when configdialog calls the SectionName subclass. I know Windows is more troublesome than *nix about focus, but do you have any idea why calling Query this way, instead of as in the committed patch, would make a difference?

[terryjreedy]

Revised load_module and new query.ModuleName work, including when invoked by open_class_browser. Tests are need for both. One problem was that using withdrawn root rather than a text as parent caused query.Query to not appear, so wait_window could not be terminated.

[terryjreedy]

Added tests for ModuleName. Will recheck and push.

[terryjreedy]

(Misdirected notice copied here)
New changeset 78a3d3700233 by Terry Jan Reedy in branch 'default':
bpo-27437: Add query.ModuleName and use it for file => Load Module.
https://hg.python.org/cpython/rev/78a3d3700233

[terryjreedy]

Next patch should finish issue except for a couple of minor questions.

[terryjreedy]

Serhiy, thank you for the review. I intend to follow PEP-8 as best as possible in the code I touch. I also fixed some of the comments.

I did a bit of refactoring that make it trivial to check for reuse of help source names. See new issue bpo-27465. All that is needed is for configdialog to pass a used_names argument. I already changed the HelpSource htest to do so.

I have tested the configdialog changes by running it with live IDLE. I intend to push after a final check.

[python-dev]

New changeset 66fe8d9eae6c by Terry Jan Reedy in branch 'default':
Issue bpo-27380: IDLE: add query.HelpSource class and tests.
https://hg.python.org/cpython/rev/66fe8d9eae6c

[terryjreedy]

Patch posted had code that belongs to bpo-27465 and was deleted before pushing.