[Python-checkins] cpython (merge 3.5 -> default): Issue 20567: Revise idle_test/README.txt and some tests to match new advice.

Fri Jun 3 22:28:21 EDT 2016

https://hg.python.org/cpython/rev/d8e5e3da4d57
changeset: 101676:d8e5e3da4d57
parent: 101674:5dcc52d6829f
parent: 101675:813bb6a4c693
user: Terry Jan Reedy <tjreedy at udel.edu>
date: Fri Jun 03 22:28:05 2016 -0400
summary:
 Issue 20567: Revise idle_test/README.txt and some tests to match new advice.
files:
 Lib/idlelib/idle_test/README.txt | 28 +++++----
 Lib/idlelib/idle_test/test_autocomplete.py | 3 +-
 Lib/idlelib/idle_test/test_autoexpand.py | 2 +-
 Lib/idlelib/idle_test/test_paragraph.py | 3 +-
 Lib/idlelib/idle_test/test_percolator.py | 4 +-
 Lib/idlelib/idle_test/test_redirector.py | 24 ++++----
 Lib/idlelib/idle_test/test_replace.py | 3 +-
 Lib/idlelib/idle_test/test_textview.py | 3 +-
 Lib/idlelib/idle_test/test_undo.py | 3 +-
 9 files changed, 39 insertions(+), 34 deletions(-)

diff --git a/Lib/idlelib/idle_test/README.txt b/Lib/idlelib/idle_test/README.txt
--- a/Lib/idlelib/idle_test/README.txt
+++ b/Lib/idlelib/idle_test/README.txt
@@ -56,40 +56,44 @@
 
 To guard a test class, put "requires('gui')" in its setUpClass function.
 
-To avoid interfering with other GUI tests, all GUI objects must be
-destroyed and deleted by the end of the test. Widgets, such as a Tk
-root, created in a setUpX function, should be destroyed in the
-corresponding tearDownX. Module and class widget attributes should also
-be deleted.
+To avoid interfering with other gui tests, all gui objects must be destroyed and
+deleted by the end of the test. The Tk root created in a setUpX function should
+be destroyed in the corresponding tearDownX and the module or class attribute
+deleted. Others widgets should descend from the single root and the attributes
+deleted BEFORE root is destroyed. See https://bugs.python.org/issue20567.
 
 @classmethod
 def setUpClass(cls):
 requires('gui')
 cls.root = tk.Tk()
+ cls.text = tk.Text(root)
 
 @classmethod
 def tearDownClass(cls):
+ del cls.text
 cls.root.destroy()
 del cls.root
 
 
 Requires('gui') causes the test(s) it guards to be skipped if any of
-a few conditions are met:
- 
+these conditions are met:
+
 - The tests are being run by regrtest.py, and it was started without
 enabling the "gui" resource with the "-u" command line option.
- 
+
 - The tests are being run on Windows by a service that is not allowed
 to interact with the graphical environment.
- 
+
+ - The tests are being run on Linux and X Windows is not available.
+
 - The tests are being run on Mac OSX in a process that cannot make a
 window manager connection.
- 
+
 - tkinter.Tk cannot be successfully instantiated for some reason.
- 
+
 - test.support.use_resources has been set by something other than
 regrtest.py and does not contain "gui".
- 
+
 Tests of non-GUI operations should avoid creating tk widgets. Incidental
 uses of tk variables and messageboxes can be replaced by the mock
 classes in idle_test/mock_tk.py. The mock text handles some uses of the
diff --git a/Lib/idlelib/idle_test/test_autocomplete.py b/Lib/idlelib/idle_test/test_autocomplete.py
--- a/Lib/idlelib/idle_test/test_autocomplete.py
+++ b/Lib/idlelib/idle_test/test_autocomplete.py
@@ -33,9 +33,8 @@
 
 @classmethod
 def tearDownClass(cls):
+ del cls.editor, cls.text
 cls.root.destroy()
- del cls.text
- del cls.editor
 del cls.root
 
 def setUp(self):
diff --git a/Lib/idlelib/idle_test/test_autoexpand.py b/Lib/idlelib/idle_test/test_autoexpand.py
--- a/Lib/idlelib/idle_test/test_autoexpand.py
+++ b/Lib/idlelib/idle_test/test_autoexpand.py
@@ -25,10 +25,10 @@
 
 @classmethod
 def tearDownClass(cls):
+ del cls.text, cls.auto_expand
 if hasattr(cls, 'tk'):
 cls.tk.destroy()
 del cls.tk
- del cls.text, cls.auto_expand
 
 def tearDown(self):
 self.text.delete('1.0', 'end')
diff --git a/Lib/idlelib/idle_test/test_paragraph.py b/Lib/idlelib/idle_test/test_paragraph.py
--- a/Lib/idlelib/idle_test/test_paragraph.py
+++ b/Lib/idlelib/idle_test/test_paragraph.py
@@ -276,10 +276,9 @@
 
 @classmethod
 def tearDownClass(cls):
+ del cls.text, cls.formatter
 cls.root.destroy()
 del cls.root
- del cls.text
- del cls.formatter
 
 def test_short_line(self):
 self.text.insert('1.0', "Short line\n")
diff --git a/Lib/idlelib/idle_test/test_percolator.py b/Lib/idlelib/idle_test/test_percolator.py
--- a/Lib/idlelib/idle_test/test_percolator.py
+++ b/Lib/idlelib/idle_test/test_percolator.py
@@ -40,9 +40,9 @@
 
 @classmethod
 def tearDownClass(cls):
- cls.text.destroy()
+ del cls.text
 cls.root.destroy()
- del cls.text, cls.root
+ del cls.root
 
 def setUp(self):
 self.percolator = Percolator(self.text)
diff --git a/Lib/idlelib/idle_test/test_redirector.py b/Lib/idlelib/idle_test/test_redirector.py
--- a/Lib/idlelib/idle_test/test_redirector.py
+++ b/Lib/idlelib/idle_test/test_redirector.py
@@ -14,14 +14,14 @@
 @classmethod
 def setUpClass(cls):
 requires('gui')
- cls.tk = Tk()
- cls.text = Text(cls.tk)
+ cls.root = Tk()
+ cls.text = Text(cls.root)
 
 @classmethod
 def tearDownClass(cls):
- cls.text.destroy()
- cls.tk.destroy()
- del cls.text, cls.tk
+ del cls.text
+ cls.root.destroy()
+ del cls.root
 
 def test_init(self):
 redir = WidgetRedirector(self.text)
@@ -43,14 +43,15 @@
 @classmethod
 def setUpClass(cls):
 requires('gui')
- cls.tk = Tk()
- cls.text = Text(cls.tk)
+ cls.root = Tk()
+ cls.text = Text(cls.root)
 
 @classmethod
 def tearDownClass(cls):
 cls.text.destroy()
- cls.tk.destroy()
- del cls.text, cls.tk
+ del cls.text
+ cls.root.destroy()
+ del cls.root
 
 def setUp(self):
 self.redir = WidgetRedirector(self.text)
@@ -108,14 +109,13 @@
 def test_command_dispatch(self):
 # Test that .__init__ causes redirection of tk calls
 # through redir.dispatch
- self.tk.call(self.text._w, 'insert', 'hello')
+ self.root.call(self.text._w, 'insert', 'hello')
 self.assertEqual(self.func.args, ('hello',))
 self.assertEqual(self.text.get('1.0', 'end'), '\n')
 # Ensure that called through redir .dispatch and not through
 # self.text.insert by having mock raise TclError.
 self.func.__init__(TclError())
- self.assertEqual(self.tk.call(self.text._w, 'insert', 'boo'), '')
-
+ self.assertEqual(self.root.call(self.text._w, 'insert', 'boo'), '')
 
 
 if __name__ == '__main__':
diff --git a/Lib/idlelib/idle_test/test_replace.py b/Lib/idlelib/idle_test/test_replace.py
--- a/Lib/idlelib/idle_test/test_replace.py
+++ b/Lib/idlelib/idle_test/test_replace.py
@@ -31,8 +31,9 @@
 @classmethod
 def tearDownClass(cls):
 se.tkMessageBox = orig_mbox
+ del cls.text, cls.dialog, cls.engine
 cls.root.destroy()
- del cls.text, cls.dialog, cls.engine, cls.root
+ del cls.root
 
 def setUp(self):
 self.text.insert('insert', 'This is a sample sTring')
diff --git a/Lib/idlelib/idle_test/test_textview.py b/Lib/idlelib/idle_test/test_textview.py
--- a/Lib/idlelib/idle_test/test_textview.py
+++ b/Lib/idlelib/idle_test/test_textview.py
@@ -22,7 +22,8 @@
 root = Tk()
 
 def tearDownModule():
- global root
+ global root, TV
+ del TV
 root.destroy() # pyflakes falsely sees root as undefined
 del root
 
diff --git a/Lib/idlelib/idle_test/test_undo.py b/Lib/idlelib/idle_test/test_undo.py
--- a/Lib/idlelib/idle_test/test_undo.py
+++ b/Lib/idlelib/idle_test/test_undo.py
@@ -23,8 +23,9 @@
 @classmethod
 def tearDownClass(cls):
 cls.percolator.redir.close()
+ del cls.percolator, cls.text
 cls.root.destroy()
- del cls.percolator, cls.text, cls.root
+ del cls.root
 
 def setUp(self):
 self.delegator = UndoDelegator()
-- 
Repository URL: https://hg.python.org/cpython
