[3.13] gh-104855: Update Tkinter tests for Tcl/Tk 8.7 and 9.0 (GH-120824) (GH-120864)

The tests are now passed with the current version of Tcl/Tk under
development (8.7b1+ and 9.0b3+).

The following changes were also made to make the tests more flexible:

* Helper methods like checkParam() now interpret the expected error message
  as a regular expression instead of a literal.
* Add support of new arguments in checkEnumParam():
  - allow_empty=True skips testing with empty string;
  - fullname= specifies the name for error message if it differs from the
    option name;
  - sort=True sorts values for error message.
* Add support of the allow_empty argument in checkReliefParam():
  allow_empty=True adds an empty string to the list of accepted values.
* Attributes _clip_highlightthickness, _clip_pad and  _clip_borderwidth
  specify how negative values of options -highlightthickness, -padx, -pady
  and -borderwidth are handled.
* Use global variables for some common error messages.

(cherry picked from commit 6ad26de6e8)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
This commit is contained in:
Miss Islington (bot) 2024-06-22 09:17:55 +02:00 committed by GitHub
parent 4dc27bc0b7
commit 4fabbf9773
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 250 additions and 137 deletions

View file

@ -1,5 +1,6 @@
# Common tests for test_tkinter/test_widgets.py and test_ttk/test_widgets.py
import re
import tkinter
from test.test_tkinter.support import (AbstractTkTest, tk_version,
pixels_conv, tcl_obj_eq)
@ -9,9 +10,13 @@ import test.support
_sentinel = object()
class AbstractWidgetTest(AbstractTkTest):
_default_pixels = '' if tk_version >= (9, 0) else -1 if tk_version >= (8, 7) else ''
_conv_pixels = round
_conv_pad_pixels = None
_stringify = False
_clip_highlightthickness = True
_clip_pad = False
_clip_borderwidth = False
@property
def scaling(self):
@ -56,16 +61,13 @@ class AbstractWidgetTest(AbstractTkTest):
def checkInvalidParam(self, widget, name, value, errmsg=None):
orig = widget[name]
if errmsg is not None:
errmsg = errmsg.format(value)
with self.assertRaises(tkinter.TclError) as cm:
errmsg = errmsg.format(re.escape(str(value)))
errmsg = fr'\A{errmsg}\Z'
with self.assertRaisesRegex(tkinter.TclError, errmsg or ''):
widget[name] = value
if errmsg is not None:
self.assertEqual(str(cm.exception), errmsg)
self.assertEqual(widget[name], orig)
with self.assertRaises(tkinter.TclError) as cm:
with self.assertRaisesRegex(tkinter.TclError, errmsg or ''):
widget.configure({name: value})
if errmsg is not None:
self.assertEqual(str(cm.exception), errmsg)
self.assertEqual(widget[name], orig)
def checkParams(self, widget, name, *values, **kwargs):
@ -74,30 +76,26 @@ class AbstractWidgetTest(AbstractTkTest):
def checkIntegerParam(self, widget, name, *values, **kwargs):
self.checkParams(widget, name, *values, **kwargs)
self.checkInvalidParam(widget, name, '',
errmsg='expected integer but got ""')
self.checkInvalidParam(widget, name, '10p',
errmsg='expected integer but got "10p"')
self.checkInvalidParam(widget, name, 3.2,
errmsg='expected integer but got "3.2"')
errmsg = 'expected integer but got "{}"'
self.checkInvalidParam(widget, name, '', errmsg=errmsg)
self.checkInvalidParam(widget, name, '10p', errmsg=errmsg)
self.checkInvalidParam(widget, name, 3.2, errmsg=errmsg)
def checkFloatParam(self, widget, name, *values, conv=float, **kwargs):
for value in values:
self.checkParam(widget, name, value, conv=conv, **kwargs)
self.checkInvalidParam(widget, name, '',
errmsg='expected floating-point number but got ""')
self.checkInvalidParam(widget, name, 'spam',
errmsg='expected floating-point number but got "spam"')
errmsg = 'expected floating-point number but got "{}"'
self.checkInvalidParam(widget, name, '', errmsg=errmsg)
self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
def checkBooleanParam(self, widget, name):
for value in (False, 0, 'false', 'no', 'off'):
self.checkParam(widget, name, value, expected=0)
for value in (True, 1, 'true', 'yes', 'on'):
self.checkParam(widget, name, value, expected=1)
self.checkInvalidParam(widget, name, '',
errmsg='expected boolean value but got ""')
self.checkInvalidParam(widget, name, 'spam',
errmsg='expected boolean value but got "spam"')
errmsg = 'expected boolean value but got "{}"'
self.checkInvalidParam(widget, name, '', errmsg=errmsg)
self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
def checkColorParam(self, widget, name, *, allow_empty=None, **kwargs):
self.checkParams(widget, name,
@ -120,16 +118,24 @@ class AbstractWidgetTest(AbstractTkTest):
self.assertTrue(widget[name])
self.checkParams(widget, name, '')
def checkEnumParam(self, widget, name, *values, errmsg=None, **kwargs):
def checkEnumParam(self, widget, name, *values,
errmsg=None, allow_empty=False, fullname=None,
sort=False, **kwargs):
self.checkParams(widget, name, *values, **kwargs)
if errmsg is None:
if sort:
if values[-1]:
values = tuple(sorted(values))
else:
values = tuple(sorted(values[:-1])) + ('',)
errmsg2 = ' %s "{}": must be %s%s or %s' % (
name,
fullname or name,
', '.join(values[:-1]),
',' if len(values) > 2 else '',
values[-1])
self.checkInvalidParam(widget, name, '',
errmsg='ambiguous' + errmsg2)
values[-1] or '""')
if '' not in values and not allow_empty:
self.checkInvalidParam(widget, name, '',
errmsg='ambiguous' + errmsg2)
errmsg = 'bad' + errmsg2
self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
@ -146,20 +152,21 @@ class AbstractWidgetTest(AbstractTkTest):
conv1 = round
self.checkParam(widget, name, value, expected=expected,
conv=conv1, **kwargs)
self.checkInvalidParam(widget, name, '6x',
errmsg='bad screen distance "6x"')
self.checkInvalidParam(widget, name, 'spam',
errmsg='bad screen distance "spam"')
errmsg = '(bad|expected) screen distance ((or "" )?but got )?"{}"'
self.checkInvalidParam(widget, name, '6x', errmsg=errmsg)
self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
def checkReliefParam(self, widget, name):
self.checkParams(widget, name,
'flat', 'groove', 'raised', 'ridge', 'solid', 'sunken')
errmsg='bad relief "spam": must be '\
'flat, groove, raised, ridge, solid, or sunken'
def checkReliefParam(self, widget, name, *, allow_empty=False):
values = ('flat', 'groove', 'raised', 'ridge', 'solid', 'sunken')
if allow_empty:
values += ('',)
self.checkParams(widget, name, *values)
errmsg = 'bad relief "{}": must be %s, or %s' % (
', '.join(values[:-1]),
values[-1] or '""')
if tk_version < (8, 6):
errmsg = None
self.checkInvalidParam(widget, name, 'spam',
errmsg=errmsg)
self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
def checkImageParam(self, widget, name):
image = tkinter.PhotoImage(master=self.root, name='image1')
@ -262,9 +269,14 @@ class StandardOptionsTests:
def test_configure_borderwidth(self):
widget = self.create()
self.checkPixelsParam(widget, 'borderwidth',
0, 1.3, 2.6, 6, -2, '10p')
0, 1.3, 2.6, 6, '10p')
expected = 0 if self._clip_borderwidth else -2
self.checkParam(widget, 'borderwidth', -2, expected=expected,
conv=self._conv_pixels)
if 'bd' in self.OPTIONS:
self.checkPixelsParam(widget, 'bd', 0, 1.3, 2.6, 6, -2, '10p')
self.checkPixelsParam(widget, 'bd', 0, 1.3, 2.6, 6, '10p')
self.checkParam(widget, 'bd', -2, expected=expected,
conv=self._conv_pixels)
def test_configure_compound(self):
widget = self.create()
@ -308,7 +320,8 @@ class StandardOptionsTests:
widget = self.create()
self.checkPixelsParam(widget, 'highlightthickness',
0, 1.3, 2.6, 6, '10p')
self.checkParam(widget, 'highlightthickness', -2, expected=0,
expected = 0 if self._clip_highlightthickness else -2
self.checkParam(widget, 'highlightthickness', -2, expected=expected,
conv=self._conv_pixels)
def test_configure_image(self):
@ -343,11 +356,7 @@ class StandardOptionsTests:
def test_configure_justify(self):
widget = self.create()
self.checkEnumParam(widget, 'justify', 'left', 'right', 'center',
errmsg='bad justification "{}": must be '
'left, right, or center')
self.checkInvalidParam(widget, 'justify', '',
errmsg='ambiguous justification "": must be '
'left, right, or center')
fullname='justification')
def test_configure_orient(self):
widget = self.create()
@ -356,13 +365,19 @@ class StandardOptionsTests:
def test_configure_padx(self):
widget = self.create()
self.checkPixelsParam(widget, 'padx', 3, 4.4, 5.6, -2, '12m',
self.checkPixelsParam(widget, 'padx', 3, 4.4, 5.6, '12m',
conv=self._conv_pad_pixels)
expected = 0 if self._clip_pad else -2
self.checkParam(widget, 'padx', -2, expected=expected,
conv=self._conv_pad_pixels)
def test_configure_pady(self):
widget = self.create()
self.checkPixelsParam(widget, 'pady', 3, 4.4, 5.6, -2, '12m',
self.checkPixelsParam(widget, 'pady', 3, 4.4, 5.6, '12m',
conv=self._conv_pad_pixels)
expected = 0 if self._clip_pad else -2
self.checkParam(widget, 'pady', -2, expected=expected,
conv=self._conv_pad_pixels)
def test_configure_relief(self):
widget = self.create()
@ -415,7 +430,24 @@ class StandardOptionsTests:
def test_configure_underline(self):
widget = self.create()
self.checkIntegerParam(widget, 'underline', 0, 1, 10)
self.checkParams(widget, 'underline', 0, 1, 10)
if tk_version >= (8, 7):
is_ttk = widget.__class__.__module__ == 'tkinter.ttk'
self.checkParam(widget, 'underline', '',
expected='' if is_ttk else self._default_pixels)
self.checkParam(widget, 'underline', '5+2',
expected='5+2' if is_ttk else 7)
self.checkParam(widget, 'underline', '5-2',
expected='5-2' if is_ttk else 3)
self.checkParam(widget, 'underline', 'end', expected='end')
self.checkParam(widget, 'underline', 'end-2', expected='end-2')
errmsg = (r'bad index "{}": must be integer\?\[\+-\]integer\?, '
r'end\?\[\+-\]integer\?, or ""')
else:
errmsg = 'expected integer but got "{}"'
self.checkInvalidParam(widget, 'underline', '', errmsg=errmsg)
self.checkInvalidParam(widget, 'underline', '10p', errmsg=errmsg)
self.checkInvalidParam(widget, 'underline', 3.2, errmsg=errmsg)
def test_configure_wraplength(self):
widget = self.create()
@ -445,7 +477,8 @@ class StandardOptionsTests:
def test_configure_overrelief(self):
widget = self.create()
self.checkReliefParam(widget, 'overrelief')
self.checkReliefParam(widget, 'overrelief',
allow_empty=(tk_version >= (8, 7)))
def test_configure_selectcolor(self):
widget = self.create()