Issue 27437: Add query.ModuleName and use it for file => Load Module.

terryjreedy · terryjreedy · commit 0cd6b977016a · 2016-07-03T19:11:13.000-04:00
Users can now edit bad entries instead of starting over.
diff --git a/Lib/idlelib/README.txt b/Lib/idlelib/README.txt
@@ -41,7 +41,6 @@ config.py         # Load, fetch, and save configuration (nim).
 configdialog.py   # Display user configuration dialogs.
 config_help.py    # Specify help source in configdialog.
 config_key.py     # Change keybindings.
-config_sec.py     # Spefify user config section name
 dynoption.py      # Define mutable OptionMenu widget (nim).
 debugobj.py       # Define class used in stackviewer.
 debugobj_r.py     # Communicate objects between processes with rpc (nim).
@@ -66,6 +65,7 @@ pathbrowser.py    # Create path browser window.
 percolator.py     # Manage delegator stack (nim).
 pyparse.py        # Give information on code indentation
 pyshell.py        # Start IDLE, manage shell, complete editor window
+query.py          # Query user for informtion
 redirector.py     # Intercept widget subcommands (for percolator) (nim).
 replace.py        # Search and replace pattern in text.
 rpc.py            # Commuicate between idle and user processes (nim).
@@ -192,8 +192,8 @@ Options
   Configure IDLE   # eEW.config_dialog, configdialog
     (tabs in the dialog)
     Font tab       # config-main.def
-    Highlight tab  # config_sec, config-highlight.def
-    Keys tab       # config_key, configconfig_secg-keus.def
+    Highlight tab  # query, config-highlight.def
+    Keys tab       # query, config_key, config_keys.def
     General tab    # config_help, config-main.def
     Extensions tab # config-extensions.def, corresponding .py
   ---
diff --git a/Lib/idlelib/editor.py b/Lib/idlelib/editor.py
@@ -14,6 +14,7 @@
 import webbrowser
 
 from idlelib.multicall import MultiCallCreator
+from idlelib import query
 from idlelib import windows
 from idlelib import search
 from idlelib import grep
@@ -573,46 +574,27 @@ def goto_line_event(self, event):
         text.see("insert")
 
     def open_module(self, event=None):
-        # XXX Shouldn't this be in IOBinding?
+        """Get module name from user and open it.
+
+        Return module path or None for calls by open_class_browser
+        when latter is not invoked in named editor window.
+        """
+        # XXX This, open_class_browser, and open_path_browser
+        # would fit better in iomenu.IOBinding.
         try:
-            name = self.text.get("sel.first", "sel.last")
+            name = self.text.get("sel.first", "sel.last").strip()
         except TclError:
-            name = ""
-        else:
-            name = name.strip()
-        name = tkSimpleDialog.askstring("Module",
-                 "Enter the name of a Python module\n"
-                 "to search on sys.path and open:",
-                 parent=self.text, initialvalue=name)
-        if name:
-            name = name.strip()
-        if not name:
-            return
-        # XXX Ought to insert current file's directory in front of path
-        try:
-            spec = importlib.util.find_spec(name)
-        except (ValueError, ImportError) as msg:
-            tkMessageBox.showerror("Import error", str(msg), parent=self.text)
-            return
-        if spec is None:
-            tkMessageBox.showerror("Import error", "module not found",
-                                   parent=self.text)
-            return
-        if not isinstance(spec.loader, importlib.abc.SourceLoader):
-            tkMessageBox.showerror("Import error", "not a source-based module",
-                                   parent=self.text)
-            return
-        try:
-            file_path = spec.loader.get_filename(name)
-        except AttributeError:
-            tkMessageBox.showerror("Import error",
-                                   "loader does not support get_filename",
-                                   parent=self.text)
-            return
-        if self.flist:
-            self.flist.open(file_path)
-        else:
-            self.io.loadfile(file_path)
+            name = ''
+        file_path = query.ModuleName(
+                self.text, "Open Module",
+                "Enter the name of a Python module\n"
+                "to search on sys.path and open:",
+                name).result
+        if file_path is not None:
+            if self.flist:
+                self.flist.open(file_path)
+            else:
+                self.io.loadfile(file_path)
         return file_path
 
     def open_class_browser(self, event=None):
diff --git a/Lib/idlelib/idle_test/htest.py b/Lib/idlelib/idle_test/htest.py
@@ -235,8 +235,9 @@ def _wrapper(parent):  # htest #
 
 Query_spec = {
     'file': 'query',
-    'kwds': {'title':'Query',
-             'message':'Enter something',
+    'kwds': {'title': 'Query',
+             'message': 'Enter something',
+             'text0': 'Go',
              '_htest': True},
     'msg': "Enter with <Return> or [Ok].  Print valid entry to Shell\n"
            "Blank line, after stripping, is ignored\n"
diff --git a/Lib/idlelib/idle_test/test_query.py b/Lib/idlelib/idle_test/test_query.py
@@ -8,8 +8,8 @@
 from unittest import mock
 from idlelib.idle_test.mock_tk import Var, Mbox_func
 from idlelib import query
-Query, SectionName = query.Query, query.SectionName
 
+Query = query.Query
 class Dummy_Query:
     # Mock for testing the following methods Query
     entry_ok = Query.entry_ok
@@ -23,7 +23,7 @@ def destroy(self):
         self.destroyed = True
 
 # entry_ok calls modal messagebox.showerror if entry is not ok.
-# Mock showerrer returns, so don't need to click to continue.
+# Mock showerrer so don't need to click to continue.
 orig_showerror = query.showerror
 showerror = Mbox_func()  # Instance has __call__ method.
 
@@ -46,7 +46,7 @@ def test_blank_entry(self):
         dialog = self.dialog
         Equal = self.assertEqual
         dialog.entry.set(' ')
-        Equal(dialog.entry_ok(), '')
+        Equal(dialog.entry_ok(), None)
         Equal((dialog.result, dialog.destroyed), (None, False))
         Equal(showerror.title, 'Entry Error')
         self.assertIn('Blank', showerror.message)
@@ -74,58 +74,98 @@ def test_cancel(self):
 
 
 class Dummy_SectionName:
-    # Mock for testing the following method of Section_Name
-    entry_ok = SectionName.entry_ok
-    # Attributes, constant or variable, needed for tests
+    entry_ok = query.SectionName.entry_ok  # Test override.
     used_names = ['used']
     entry = Var()
 
 class SectionNameTest(unittest.TestCase):
     dialog = Dummy_SectionName()
 
-
     def setUp(self):
         showerror.title = None
 
-    def test_blank_name(self):
+    def test_blank_section_name(self):
         dialog = self.dialog
         Equal = self.assertEqual
         dialog.entry.set(' ')
-        Equal(dialog.entry_ok(), '')
+        Equal(dialog.entry_ok(), None)
         Equal(showerror.title, 'Name Error')
         self.assertIn('No', showerror.message)
 
-    def test_used_name(self):
+    def test_used_section_name(self):
         dialog = self.dialog
         Equal = self.assertEqual
         dialog.entry.set('used')
-        Equal(self.dialog.entry_ok(), '')
+        Equal(self.dialog.entry_ok(), None)
         Equal(showerror.title, 'Name Error')
         self.assertIn('use', showerror.message)
 
-    def test_long_name(self):
+    def test_long_section_name(self):
         dialog = self.dialog
         Equal = self.assertEqual
         dialog.entry.set('good'*8)
-        Equal(self.dialog.entry_ok(), '')
+        Equal(self.dialog.entry_ok(), None)
         Equal(showerror.title, 'Name Error')
         self.assertIn('too long', showerror.message)
 
-    def test_good_entry(self):
+    def test_good_section_name(self):
         dialog = self.dialog
         Equal = self.assertEqual
         dialog.entry.set('  good ')
         Equal(dialog.entry_ok(), 'good')
         Equal(showerror.title, None)
 
 
+class Dummy_ModuleName:
+    entry_ok = query.ModuleName.entry_ok  # Test override
+    text0 = ''
+    entry = Var()
+
+class ModuleNameTest(unittest.TestCase):
+    dialog = Dummy_ModuleName()
+
+    def setUp(self):
+        showerror.title = None
+
+    def test_blank_module_name(self):
+        dialog = self.dialog
+        Equal = self.assertEqual
+        dialog.entry.set(' ')
+        Equal(dialog.entry_ok(), None)
+        Equal(showerror.title, 'Name Error')
+        self.assertIn('No', showerror.message)
+
+    def test_bogus_module_name(self):
+        dialog = self.dialog
+        Equal = self.assertEqual
+        dialog.entry.set('__name_xyz123_should_not_exist__')
+        Equal(self.dialog.entry_ok(), None)
+        Equal(showerror.title, 'Import Error')
+        self.assertIn('not found', showerror.message)
+
+    def test_c_source_name(self):
+        dialog = self.dialog
+        Equal = self.assertEqual
+        dialog.entry.set('itertools')
+        Equal(self.dialog.entry_ok(), None)
+        Equal(showerror.title, 'Import Error')
+        self.assertIn('source-based', showerror.message)
+
+    def test_good_module_name(self):
+        dialog = self.dialog
+        Equal = self.assertEqual
+        dialog.entry.set('idlelib')
+        self.assertTrue(dialog.entry_ok().endswith('__init__.py'))
+        Equal(showerror.title, None)
+
+
 class QueryGuiTest(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
         requires('gui')
-        cls.root = Tk()
-        cls.dialog = Query(cls.root, 'TEST', 'test', _utest=True)
+        cls.root = root = Tk()
+        cls.dialog = Query(root, 'TEST', 'test', _utest=True)
         cls.dialog.destroy = mock.Mock()
 
     @classmethod
@@ -160,5 +200,43 @@ def test_click_cancel(self):
         self.assertTrue(dialog.destroy.called)
 
 
+class SectionnameGuiTest(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        requires('gui')
+
+    def test_click_section_name(self):
+        root = Tk()
+        dialog =  query.SectionName(root, 'T', 't', {'abc'}, _utest=True)
+        Equal = self.assertEqual
+        Equal(dialog.used_names, {'abc'})
+        dialog.entry.insert(0, 'okay')
+        dialog.button_ok.invoke()
+        Equal(dialog.result, 'okay')
+        del dialog
+        root.destroy()
+        del root
+
+
+class ModulenameGuiTest(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        requires('gui')
+
+    def test_click_module_name(self):
+        root = Tk()
+        dialog =  query.ModuleName(root, 'T', 't', 'idlelib', _utest=True)
+        Equal = self.assertEqual
+        Equal(dialog.text0, 'idlelib')
+        Equal(dialog.entry.get(), 'idlelib')
+        dialog.button_ok.invoke()
+        self.assertTrue(dialog.result.endswith('__init__.py'))
+        del dialog
+        root.destroy()
+        del root
+
+
 if __name__ == '__main__':
     unittest.main(verbosity=2, exit=False)
diff --git a/Lib/idlelib/query.py b/Lib/idlelib/query.py
