bpo-30495: IDLE: improve textview with docstrings, PEP8 names, more tests. (#2283)
Split TextViewer class into ViewWindow, ViewFrame, and TextFrame classes so that instances
of the latter two can be placed with other widgets within a multiframe window.
Patch by Cheryl Sabella.
diff --git a/Lib/idlelib/textview.py b/Lib/idlelib/textview.py
index ab653a9..de4b190 100644
--- a/Lib/idlelib/textview.py
+++ b/Lib/idlelib/textview.py
@@ -1,14 +1,59 @@
"""Simple text browser for IDLE
"""
-from tkinter import Toplevel, Frame, Button, Text
-from tkinter import DISABLED, SUNKEN, VERTICAL, WORD
-from tkinter import RIGHT, LEFT, TOP, BOTTOM, BOTH, X, Y
-from tkinter.ttk import Scrollbar
+from tkinter import Toplevel, Text
+from tkinter.ttk import Frame, Scrollbar, Button
from tkinter.messagebox import showerror
-class TextViewer(Toplevel):
+class TextFrame(Frame):
+ "Display text with scrollbar."
+
+ def __init__(self, parent, rawtext):
+ """Create a frame for Textview.
+
+ parent - parent widget for this frame
+ rawtext - text to display
+ """
+ super().__init__(parent)
+ self['relief'] = 'sunken'
+ self['height'] = 700
+ # TODO: get fg/bg from theme.
+ self.bg = '#ffffff'
+ self.fg = '#000000'
+
+ self.text = text = Text(self, wrap='word', highlightthickness=0,
+ fg=self.fg, bg=self.bg)
+ self.scroll = scroll = Scrollbar(self, orient='vertical',
+ takefocus=False, command=text.yview)
+ text['yscrollcommand'] = scroll.set
+ text.insert(0.0, rawtext)
+ text['state'] = 'disabled'
+ text.focus_set()
+
+ scroll.pack(side='right', fill='y')
+ text.pack(side='left', expand=True, fill='both')
+
+
+class ViewFrame(Frame):
+ "Display TextFrame and Close button."
+ def __init__(self, parent, text):
+ super().__init__(parent)
+ self.parent = parent
+ self.bind('<Return>', self.ok)
+ self.bind('<Escape>', self.ok)
+ self.textframe = TextFrame(self, text)
+ self.button_ok = button_ok = Button(
+ self, text='Close', command=self.ok, takefocus=False)
+ self.textframe.pack(side='top', expand=True, fill='both')
+ button_ok.pack(side='bottom')
+
+ def ok(self, event=None):
+ """Dismiss text viewer dialog."""
+ self.parent.destroy()
+
+
+class ViewWindow(Toplevel):
"A simple text viewer dialog for IDLE."
def __init__(self, parent, title, text, modal=True,
@@ -24,26 +69,19 @@
_htest - bool; change box location when running htest.
_utest - bool; don't wait_window when running unittest.
"""
- Toplevel.__init__(self, parent)
- self.configure(borderwidth=5)
+ super().__init__(parent)
+ self['borderwidth'] = 5
# Place dialog below parent if running htest.
- self.geometry("=%dx%d+%d+%d" % (750, 500,
- parent.winfo_rootx() + 10,
- parent.winfo_rooty() + (10 if not _htest else 100)))
- # TODO: get fg/bg from theme.
- self.bg = '#ffffff'
- self.fg = '#000000'
+ x = parent.winfo_rootx() + 10
+ y = parent.winfo_rooty() + (10 if not _htest else 100)
+ self.geometry(f'=750x500+{x}+{y}')
- self.create_widgets()
self.title(title)
+ self.viewframe = ViewFrame(self, text)
self.protocol("WM_DELETE_WINDOW", self.ok)
- self.parent = parent
- self.text.focus_set()
- # Bind keys for closing this dialog.
- self.bind('<Return>', self.ok)
- self.bind('<Escape>', self.ok)
- self.text.insert(0.0, text)
- self.text.config(state=DISABLED)
+ self.button_ok = button_ok = Button(self, text='Close',
+ command=self.ok, takefocus=False)
+ self.viewframe.pack(side='top', expand=True, fill='both')
if modal:
self.transient(parent)
@@ -51,31 +89,13 @@
if not _utest:
self.wait_window()
- def create_widgets(self):
- "Create Frame with Text (with vertical Scrollbar) and Button."
- frame = Frame(self, relief=SUNKEN, height=700)
- frame_buttons = Frame(self)
- self.button_ok = Button(frame_buttons, text='Close',
- command=self.ok, takefocus=False)
- self.scrollbar = Scrollbar(frame, orient=VERTICAL, takefocus=False)
- self.text = Text(frame, wrap=WORD, highlightthickness=0,
- fg=self.fg, bg=self.bg)
- self.scrollbar.config(command=self.text.yview)
- self.text.config(yscrollcommand=self.scrollbar.set)
-
- self.button_ok.pack()
- self.scrollbar.pack(side=RIGHT, fill=Y)
- self.text.pack(side=LEFT, expand=True, fill=BOTH)
- frame_buttons.pack(side=BOTTOM, fill=X)
- frame.pack(side=TOP, expand=True, fill=BOTH)
-
def ok(self, event=None):
"""Dismiss text viewer dialog."""
self.destroy()
def view_text(parent, title, text, modal=True, _utest=False):
- """Create TextViewer for given text.
+ """Create text viewer for given text.
parent - parent of this dialog
title - string which is the title of popup dialog
@@ -84,11 +104,11 @@
dialog is displayed
_utest - bool; controls wait_window on unittest
"""
- return TextViewer(parent, title, text, modal, _utest=_utest)
+ return ViewWindow(parent, title, text, modal, _utest=_utest)
def view_file(parent, title, filename, encoding=None, modal=True, _utest=False):
- """Create TextViewer for text in filename.
+ """Create text viewer for text in filename.
Return error message if file cannot be read. Otherwise calls view_text
with contents of the file.
@@ -98,7 +118,7 @@
contents = file.read()
except OSError:
showerror(title='File Load Error',
- message='Unable to load file %r .' % filename,
+ message=f'Unable to load file {filename!r} .',
parent=parent)
except UnicodeDecodeError as err:
showerror(title='Unicode Decode Error',
@@ -113,4 +133,4 @@
import unittest
unittest.main('idlelib.idle_test.test_textview', verbosity=2, exit=False)
from idlelib.idle_test.htest import run
- run(TextViewer)
+ run(ViewWindow)