Squeezer: rename "preview" to "view"

python · taleinat · Sep 25, 2018 · Jun 11, 2018 · Aug 12, 2018 · Aug 12, 2018
commit 1a1288a7019c8b12055e6014d32ae29a30f901b1
diff --git a/Lib/idlelib/idle_test/test_squeezer.py b/Lib/idlelib/idle_test/test_squeezer.py
@@ -1,4 +1,3 @@
-import os
 from collections import namedtuple
 from tkinter import Text
 import unittest
@@ -250,22 +249,22 @@ def test_expand_last_squeezed_event(self):
         self.assertEqual(retval, "break")
         self.assertEqual(squeezer.text.bell.call_count, 1)
 
-    def test_preview_last_squeezed_event_no_squeezed(self):
-        """test the preview_last_squeezed event"""
+    def test_view_last_squeezed_event_no_squeezed(self):
+        """test the view_last_squeezed event"""
         # The tested scenario: There are no squeezed texts, therefore there
-        # are no ExpandingButton instances. The preview_last_squeezed event
+        # are no ExpandingButton instances. The view_last_squeezed event
         # is called and should fail (i.e. call squeezer.text.bell()).
         editwin = self.make_mock_editor_window()
         squeezer = self.make_squeezer_instance(editwin)
 
-        retval = squeezer.preview_last_squeezed_event(event=Mock())
+        retval = squeezer.view_last_squeezed_event(event=Mock())
         self.assertEqual(retval, "break")
 
-    def test_preview_last_squeezed_event(self):
-        """test the preview_last_squeezed event"""
+    def test_view_last_squeezed_event(self):
+        """test the view_last_squeezed event"""
         # The tested scenario: There are two squeezed texts, therefore there
-        # are two ExpandingButton instances. The preview_last_squeezed event
-        # is called twice. Both times should call the preview() method of the
+        # are two ExpandingButton instances. The view_last_squeezed event
+        # is called twice. Both times should call the view() method of the
         # second ExpandingButton.
         editwin = self.make_mock_editor_window()
         squeezer = self.make_squeezer_instance(editwin)
@@ -274,17 +273,17 @@ def test_preview_last_squeezed_event(self):
         squeezer.expandingbuttons = [mock_expandingbutton1,
                                      mock_expandingbutton2]
 
-        # check that the second expanding button is previewed
-        retval = squeezer.preview_last_squeezed_event(event=SENTINEL_VALUE)
+        # check that the second expanding button is viewed
+        retval = squeezer.view_last_squeezed_event(event=SENTINEL_VALUE)
         self.assertEqual(retval, "break")
         self.assertEqual(squeezer.text.bell.call_count, 0)
-        self.assertEqual(mock_expandingbutton1.preview.call_count, 0)
-        self.assertEqual(mock_expandingbutton2.preview.call_count, 1)
-        mock_expandingbutton2.preview.assert_called_with(SENTINEL_VALUE)
+        self.assertEqual(mock_expandingbutton1.view.call_count, 0)
+        self.assertEqual(mock_expandingbutton2.view.call_count, 1)
+        mock_expandingbutton2.view.assert_called_with(SENTINEL_VALUE)
 
-        squeezer.preview_last_squeezed_event(event=SENTINEL_VALUE)
-        self.assertEqual(mock_expandingbutton1.preview.call_count, 0)
-        self.assertEqual(mock_expandingbutton2.preview.call_count, 2)
+        squeezer.view_last_squeezed_event(event=SENTINEL_VALUE)
+        self.assertEqual(mock_expandingbutton1.view.call_count, 0)
+        self.assertEqual(mock_expandingbutton2.view.call_count, 2)
 
     def test_auto_squeeze(self):
         """test that the auto-squeezing creates an ExpandingButton properly"""
@@ -565,16 +564,16 @@ def test_copy(self):
         self.assertEqual(expandingbutton.clipboard_append.call_count, 1)
         expandingbutton.clipboard_append.assert_called_with('TEXT')
 
-    def test_preview(self):
-        """test the preview event"""
+    def test_view(self):
+        """test the view event"""
         squeezer = self.make_mock_squeezer()
         expandingbutton = ExpandingButton('TEXT', 'TAGS', 50, squeezer)
         expandingbutton.selection_own = Mock()
 
         with patch('idlelib.squeezer.view_text', autospec=view_text)\
                 as mock_view_text:
-            # trigger the preview event
-            expandingbutton.preview(event=Mock())
+            # trigger the view event
+            expandingbutton.view(event=Mock())
 
             # check that the expanding button called view_text
             self.assertEqual(mock_view_text.call_count, 1)

diff --git a/Lib/idlelib/squeezer.py b/Lib/idlelib/squeezer.py
@@ -99,8 +99,8 @@ class ExpandingButton(tk.Button):
 
     These buttons are displayed inside a Tk Text widget in place of text. A
     user can then use the button to replace it with the original text, copy
-    the original text to the clipboard or preview the original text in a
-    separate window.
+    the original text to the clipboard or view the original text in a separate
+    window.
 
     Each button is tied to a Squeezer instance, and it knows to update the
     Squeezer instance when it is expanded (and therefore removed).
@@ -168,7 +168,7 @@ def expand(self, event=None):
                 message="\n\n".join([
                     "The squeezed output is very long: %d lines, %d chars.",
                     "Expanding it could make IDLE slow or unresponsive.",
-                    "It is recommended to preview or copy the output instead.",
+                    "It is recommended to view or copy the output instead.",
                     "Really expand?"
                 ]) % (self.numoflines, len(self.s)),
                 default=tkMessageBox.CANCEL,
@@ -188,8 +188,8 @@ def copy(self, event=None):
         self.clipboard_clear()
         self.clipboard_append(self.s)
 
-    def preview(self, event=None):
-        """preview event handler
+    def view(self, event=None):
+        """view event handler
 
         View the original text in a separate text viewer window.
         """
@@ -198,7 +198,7 @@ def preview(self, event=None):
     rmenu_specs = (
         # item structure: (label, method_name)
         ('copy', 'copy'),
-        ('preview', 'preview'),
+        ('view', 'view'),
     )
 
     def context_menu_event(self, event):
@@ -329,16 +329,16 @@ def expand_last_squeezed_event(self, event):
             self.text.bell()
         return "break"
 
-    def preview_last_squeezed_event(self, event):
-        """preview-last-squeezed event handler
+    def view_last_squeezed_event(self, event):
+        """view-last-squeezed event handler
 
         Preview the last squeezed text in the Text widget.
 
         If there is no such squeezed text, give the user a small warning and
         do nothing.
         """
         if len(self.expandingbuttons) > 0:
-            self.expandingbuttons[-1].preview(event)
+            self.expandingbuttons[-1].view(event)
         else:
             self.text.bell()
         return "break"