Debian Codegraph @

Lib/test/test_tkinter/widget_tests.py

raw
1 # Common tests for test_tkinter/test_widgets.py and test_ttk/test_widgets.py
2
3 import re
4 import tkinter
5 from test.test_tkinter.support import (AbstractTkTest, requires_tk, tk_version,
6 pixels_conv, tcl_obj_eq)
7 import test.support
8
9 _sentinel = object()
10
11 # Options which accept all values allowed by Tk_GetPixels
12 # borderwidth = bd
13
14 class AbstractWidgetTest(AbstractTkTest):
15 _default_pixels = '' if tk_version >= (9, 0) else -1 # Value for unset pixel options.
16 _rounds_pixels = (tk_version < (9, 0)) # True if some pixel options are rounded.
17 _no_round = set() # Pixel options which are not rounded nonetheless
18 _stringify = False # Whether to convert tuples to strings
19 _allow_empty_justify = False
20 _clipped_to_default = set()
21
22 @property
23 def scaling(self):
24 try:
25 return self._scaling
26 except AttributeError:
27 self._scaling = float(self.root.call('tk', 'scaling'))
28 return self._scaling
29
30 def _str(self, value):
31 if not self._stringify and self.wantobjects and tk_version >= (8, 6):
32 return value
33 if isinstance(value, tuple):
34 return ' '.join(map(self._str, value))
35 return str(value)
36
37 def assertEqual2(self, actual, expected, msg=None, eq=object.__eq__):
38 if eq(actual, expected):
39 return
40 self.assertEqual(actual, expected, msg)
41
42 def checkParam(self, widget, name, value, *, expected=_sentinel,
43 conv=False, eq=None):
44 widget[name] = value
45 if expected is _sentinel:
46 expected = value
47 if name in self._clipped:
48 if not isinstance(expected, str) and expected < 0:
49 if tk_version >= (8, 7) and name in self._clipped_to_default:
50 expected = self._default_pixels
51 else:
52 expected = 0
53 if conv:
54 expected = conv(expected)
55 if self._stringify or not self.wantobjects:
56 if isinstance(expected, tuple):
57 expected = tkinter._join(expected)
58 else:
59 expected = str(expected)
60 if eq is None:
61 eq = tcl_obj_eq
62 self.assertEqual2(widget[name], expected, eq=eq)
63 self.assertEqual2(widget.cget(name), expected, eq=eq)
64 t = widget.configure(name)
65 self.assertEqual(len(t), 5)
66 self.assertEqual2(t[4], expected, eq=eq)
67
68 def checkInvalidParam(self, widget, name, value, errmsg=None):
69 orig = widget[name]
70 if errmsg is not None:
71 errmsg = errmsg.format(re.escape(str(value)))
72 errmsg = fr'\A{errmsg}\z'
73 with self.assertRaisesRegex(tkinter.TclError, errmsg or ''):
74 widget[name] = value
75 self.assertEqual(widget[name], orig)
76 with self.assertRaisesRegex(tkinter.TclError, errmsg or ''):
77 widget.configure({name: value})
78 self.assertEqual(widget[name], orig)
79
80 def checkParams(self, widget, name, *values, **kwargs):
81 for value in values:
82 self.checkParam(widget, name, value, **kwargs)
83
84 def checkIntegerParam(self, widget, name, *values, **kwargs):
85 self.checkParams(widget, name, *values, **kwargs)
86 errmsg = 'expected integer but got "{}"'
87 self.checkInvalidParam(widget, name, '', errmsg=errmsg)
88 self.checkInvalidParam(widget, name, '10p', errmsg=errmsg)
89 self.checkInvalidParam(widget, name, 3.2, errmsg=errmsg)
90
91 def checkFloatParam(self, widget, name, *values, conv=float, **kwargs):
92 for value in values:
93 self.checkParam(widget, name, value, conv=conv, **kwargs)
94 errmsg = 'expected floating-point number but got "{}"'
95 self.checkInvalidParam(widget, name, '', errmsg=errmsg)
96 self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
97
98 def checkBooleanParam(self, widget, name):
99 for value in (False, 0, 'false', 'no', 'off'):
100 self.checkParam(widget, name, value, expected=0)
101 for value in (True, 1, 'true', 'yes', 'on'):
102 self.checkParam(widget, name, value, expected=1)
103 errmsg = 'expected boolean value but got "{}"'
104 self.checkInvalidParam(widget, name, '', errmsg=errmsg)
105 self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
106
107 def checkColorParam(self, widget, name, *, allow_empty=None, **kwargs):
108 self.checkParams(widget, name,
109 '#ff0000', '#00ff00', '#0000ff', '#123456',
110 'red', 'green', 'blue', 'white', 'black', 'grey',
111 **kwargs)
112 self.checkInvalidParam(widget, name, 'spam',
113 errmsg='unknown color name "spam"')
114
115 def checkCursorParam(self, widget, name, **kwargs):
116 self.checkParams(widget, name, 'arrow', 'watch', 'cross', '',**kwargs)
117 self.checkParam(widget, name, 'none')
118 self.checkInvalidParam(widget, name, 'spam',
119 errmsg='bad cursor spec "spam"')
120
121 def checkCommandParam(self, widget, name):
122 def command(*args):
123 pass
124 widget[name] = command
125 self.assertTrue(widget[name])
126 self.checkParams(widget, name, '')
127
128 def checkEnumParam(self, widget, name, *values,
129 errmsg=None, allow_empty=False, fullname=None,
130 sort=False, **kwargs):
131 self.checkParams(widget, name, *values, **kwargs)
132 if errmsg is None:
133 if sort:
134 if values[-1]:
135 values = tuple(sorted(values))
136 else:
137 values = tuple(sorted(values[:-1])) + ('',)
138 errmsg2 = ' %s "{}": must be %s%s or %s' % (
139 fullname or name,
140 ', '.join(values[:-1]),
141 ',' if len(values) > 2 else '',
142 values[-1] or '""')
143 if '' not in values and not allow_empty:
144 self.checkInvalidParam(widget, name, '',
145 errmsg='ambiguous' + errmsg2)
146 errmsg = 'bad' + errmsg2
147 self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
148
149 def checkPixelsParam(self, widget, name, *values, conv=None, **kwargs):
150 if conv is None:
151 if self._rounds_pixels and name not in self._no_round:
152 conv = round
153 alow_neg = tk_version < (9, 1)
154 for value in values:
155 expected = _sentinel
156 conv1 = conv
157 if isinstance(value, str):
158 if not getattr(self, '_converts_pixels', True):
159 conv1 = str
160 if conv1 and conv1 is not str:
161 expected = pixels_conv(value) * self.scaling
162 conv1 = round
163 elif not alow_neg and isinstance(value, (int, float)) and value < 0:
164 self.checkInvalidParam(widget, name, value)
165 continue
166 self.checkParam(widget, name, value, expected=expected,
167 conv=conv1, **kwargs)
168 errmsg = '(bad|expected) screen distance ((or "" )?but got )?"{}"'
169 self.checkInvalidParam(widget, name, '6x', errmsg=errmsg)
170 self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
171
172 def checkReliefParam(self, widget, name, *, allow_empty=False):
173 values = ('flat', 'groove', 'raised', 'ridge', 'solid', 'sunken')
174 if allow_empty:
175 values += ('',)
176 self.checkParams(widget, name, *values)
177 errmsg = 'bad relief "{}": must be %s, or %s' % (
178 ', '.join(values[:-1]),
179 values[-1] or '""')
180 if tk_version < (8, 6):
181 errmsg = None
182 self.checkInvalidParam(widget, name, 'spam', errmsg=errmsg)
183
184 def checkImageParam(self, widget, name):
185 image = tkinter.PhotoImage(master=self.root, name='image1')
186 self.checkParam(widget, name, image, conv=str)
187 if tk_version < (8, 7):
188 errmsg = 'image "spam" doesn\'t exist'
189 else:
190 errmsg = 'image "spam" does not exist'
191 self.checkInvalidParam(widget, name, 'spam',
192 errmsg=errmsg)
193 widget[name] = ''
194
195 def checkVariableParam(self, widget, name, var):
196 self.checkParam(widget, name, var, conv=str)
197
198 def assertIsBoundingBox(self, bbox):
199 self.assertIsNotNone(bbox)
200 self.assertIsInstance(bbox, tuple)
201 if len(bbox) != 4:
202 self.fail('Invalid bounding box: %r' % (bbox,))
203 for item in bbox:
204 if not isinstance(item, int):
205 self.fail('Invalid bounding box: %r' % (bbox,))
206 break
207
208
209 def test_keys(self):
210 widget = self.create()
211 keys = widget.keys()
212 self.assertEqual(sorted(keys), sorted(widget.configure()))
213 for k in keys:
214 widget[k]
215 # Test if OPTIONS contains all keys
216 if test.support.verbose:
217 aliases = {
218 'bd': 'borderwidth',
219 'bg': 'background',
220 'bgimg': 'backgroundimage',
221 'fg': 'foreground',
222 'invcmd': 'invalidcommand',
223 'vcmd': 'validatecommand',
224 }
225 keys = set(keys)
226 expected = set(self.OPTIONS)
227 for k in sorted(keys - expected):
228 if not (k in aliases and
229 aliases[k] in keys and
230 aliases[k] in expected):
231 print('%s.OPTIONS doesn\'t contain "%s"' %
232 (self.__class__.__name__, k))
233
234 class PixelOptionsTests:
235 """Standard options that accept all formats acceptable to Tk_GetPixels.
236
237 In addition to numbers, these options can be set with distances
238 specified as a string consisting of a number followed by a single
239 character giving the unit of distance. The allowed units are:
240 millimeters ('m'), centimeters ('c'), inches ('i') or points ('p').
241 In Tk 9 a cget call for one of these options returns a Tcl_Obj of
242 type "pixels", whose string representation is the distance string
243 passed to configure.
244 """
245 PIXEL_OPTIONS = ('activeborderwidth', 'borderwidth', 'highlightthickness',
246 'insertborderwidth', 'insertwidth', 'padx', 'pady', 'selectborderwidth')
247
248 def test_configure_activeborderwidth(self):
249 widget = self.create()
250 self.checkPixelsParam(widget, 'activeborderwidth',
251 0, 1.3, 2.9, 6, -2, '10p')
252
253 def test_configure_borderwidth(self):
254 widget = self.create()
255 self.checkPixelsParam(widget, 'borderwidth',
256 0, 1.3, 2.6, 6, -2, '10p')
257
258 if 'bd' in self.OPTIONS:
259 self.checkPixelsParam(widget, 'bd', 0, 1.3, 2.6, 6, '10p')
260 self.checkParam(widget, 'bd', -2, expected=expected)
261
262 def test_configure_highlightthickness(self):
263 widget = self.create()
264 self.checkPixelsParam(widget, 'highlightthickness',
265 0, 1.3, 2.6, 6, -2, '10p')
266
267 def test_configure_insertborderwidth(self):
268 widget = self.create()
269 self.checkPixelsParam(widget, 'insertborderwidth', 0, 1.3, 2.6, 6, -2, '10p')
270
271 def test_configure_insertwidth(self):
272 widget = self.create()
273 self.checkPixelsParam(widget, 'insertwidth', 1.3, 2.6, -2, '10p')
274
275 def test_configure_padx(self):
276 widget = self.create()
277 self.checkPixelsParam(widget, 'padx', 3, 4.4, 5.6, -2, '12m')
278
279 def test_configure_pady(self):
280 widget = self.create()
281 self.checkPixelsParam(widget, 'pady', 3, 4.4, 5.6, -2, '12m')
282
283 def test_configure_selectborderwidth(self):
284 widget = self.create()
285 self.checkPixelsParam(widget, 'selectborderwidth', 1.3, 2.6, -2, '10p')
286
287
288 class StandardOptionsTests(PixelOptionsTests):
289
290 STANDARD_OPTIONS = ( 'activebackground', 'activeforeground',
291 'anchor', 'background', 'bitmap', 'compound', 'cursor',
292 'disabledforeground', 'exportselection', 'font', 'foreground',
293 'highlightbackground', 'highlightcolor', 'image',
294 'insertbackground', 'insertofftime', 'insertontime', 'jump',
295 'justify', 'orient', 'relief', 'repeatdelay', 'repeatinterval',
296 'selectbackground', 'selectforeground', 'setgrid', 'takefocus',
297 'text', 'textvariable', 'troughcolor', 'underline', 'wraplength',
298 'xscrollcommand', 'yscrollcommand', ) + PixelOptionsTests.PIXEL_OPTIONS
299
300 def test_configure_activebackground(self):
301 widget = self.create()
302 self.checkColorParam(widget, 'activebackground')
303
304 def test_configure_activeforeground(self):
305 widget = self.create()
306 self.checkColorParam(widget, 'activeforeground')
307
308 def test_configure_activerelief(self):
309 widget = self.create()
310 self.checkReliefParam(widget, 'activerelief')
311
312 def test_configure_anchor(self):
313 widget = self.create()
314 self.checkEnumParam(widget, 'anchor',
315 'n', 'ne', 'e', 'se', 's', 'sw', 'w', 'nw', 'center')
316
317 def test_configure_background(self):
318 widget = self.create()
319 self.checkColorParam(widget, 'background')
320 if 'bg' in self.OPTIONS:
321 self.checkColorParam(widget, 'bg')
322
323 @requires_tk(8, 7)
324 def test_configure_backgroundimage(self):
325 widget = self.create()
326 self.checkImageParam(widget, 'backgroundimage')
327
328 def test_configure_bitmap(self):
329 widget = self.create()
330 self.checkParam(widget, 'bitmap', 'questhead')
331 self.checkParam(widget, 'bitmap', 'gray50')
332 filename = test.support.findfile('python.xbm', subdir='tkinterdata')
333 self.checkParam(widget, 'bitmap', '@' + filename)
334 # Cocoa Tk widgets don't detect invalid -bitmap values
335 # See https://core.tcl.tk/tk/info/31cd33dbf0
336 if not ('aqua' in self.root.tk.call('tk', 'windowingsystem') and
337 'AppKit' in self.root.winfo_server()):
338 self.checkInvalidParam(widget, 'bitmap', 'spam',
339 errmsg='bitmap "spam" not defined')
340
341 def test_configure_compound(self):
342 widget = self.create()
343 self.checkEnumParam(widget, 'compound',
344 'bottom', 'center', 'left', 'none', 'right', 'top')
345
346 def test_configure_cursor(self):
347 widget = self.create()
348 self.checkCursorParam(widget, 'cursor')
349
350 def test_configure_disabledforeground(self):
351 widget = self.create()
352 self.checkColorParam(widget, 'disabledforeground')
353
354 def test_configure_exportselection(self):
355 widget = self.create()
356 self.checkBooleanParam(widget, 'exportselection')
357
358 def test_configure_font(self):
359 widget = self.create()
360 self.checkParam(widget, 'font',
361 '-Adobe-Helvetica-Medium-R-Normal--*-120-*-*-*-*-*-*')
362 is_ttk = widget.__class__.__module__ == 'tkinter.ttk'
363 if not is_ttk:
364 errmsg = 'font "" does ?n[o\']t exist'
365 self.checkInvalidParam(widget, 'font', '', errmsg=errmsg)
366
367 def test_configure_foreground(self):
368 widget = self.create()
369 self.checkColorParam(widget, 'foreground')
370 if 'fg' in self.OPTIONS:
371 self.checkColorParam(widget, 'fg')
372
373 def test_configure_highlightbackground(self):
374 widget = self.create()
375 self.checkColorParam(widget, 'highlightbackground')
376
377 def test_configure_highlightcolor(self):
378 widget = self.create()
379 self.checkColorParam(widget, 'highlightcolor')
380
381 def test_configure_image(self):
382 widget = self.create()
383 self.checkImageParam(widget, 'image')
384
385 def test_configure_insertbackground(self):
386 widget = self.create()
387 self.checkColorParam(widget, 'insertbackground')
388
389 def test_configure_insertofftime(self):
390 widget = self.create()
391 self.checkIntegerParam(widget, 'insertofftime', 100)
392
393 def test_configure_insertontime(self):
394 widget = self.create()
395 self.checkIntegerParam(widget, 'insertontime', 100)
396
397 def test_configure_jump(self):
398 widget = self.create()
399 self.checkBooleanParam(widget, 'jump')
400
401 def test_configure_justify(self):
402 widget = self.create()
403 values = ('left', 'right', 'center')
404 if self._allow_empty_justify:
405 values += ('',)
406 self.checkEnumParam(widget, 'justify', *values,
407 fullname='justification')
408
409 def test_configure_orient(self):
410 widget = self.create()
411 self.assertEqual(str(widget['orient']), self.default_orient)
412 self.checkEnumParam(widget, 'orient', 'horizontal', 'vertical')
413
414 @requires_tk(8, 7)
415 def test_configure_placeholder(self):
416 widget = self.create()
417 self.checkParam(widget, 'placeholder', 'xxx')
418
419 @requires_tk(8, 7)
420 def test_configure_placeholderforeground(self):
421 widget = self.create()
422 self.checkColorParam(widget, 'placeholderforeground')
423
424 def test_configure_relief(self):
425 widget = self.create()
426 self.checkReliefParam(widget, 'relief')
427
428 def test_configure_repeatdelay(self):
429 widget = self.create()
430 self.checkIntegerParam(widget, 'repeatdelay', -500, 500)
431
432 def test_configure_repeatinterval(self):
433 widget = self.create()
434 self.checkIntegerParam(widget, 'repeatinterval', -500, 500)
435
436 def test_configure_selectbackground(self):
437 widget = self.create()
438 self.checkColorParam(widget, 'selectbackground')
439
440 def test_configure_selectforeground(self):
441 widget = self.create()
442 self.checkColorParam(widget, 'selectforeground')
443
444 def test_configure_setgrid(self):
445 widget = self.create()
446 self.checkBooleanParam(widget, 'setgrid')
447
448 def test_configure_state(self):
449 widget = self.create()
450 self.checkEnumParam(widget, 'state', 'active', 'disabled', 'normal')
451
452 def test_configure_takefocus(self):
453 widget = self.create()
454 self.checkParams(widget, 'takefocus', '0', '1', '')
455
456 def test_configure_text(self):
457 widget = self.create()
458 self.checkParams(widget, 'text', '', 'any string')
459
460 def test_configure_textvariable(self):
461 widget = self.create()
462 var = tkinter.StringVar(self.root)
463 self.checkVariableParam(widget, 'textvariable', var)
464
465 @requires_tk(8, 7)
466 def test_configure_tile(self):
467 widget = self.create()
468 self.checkBooleanParam(widget, 'tile')
469
470 def test_configure_troughcolor(self):
471 widget = self.create()
472 self.checkColorParam(widget, 'troughcolor')
473
474 def test_configure_underline(self):
475 widget = self.create()
476 self.checkParams(widget, 'underline', 0, 1, 10)
477 if tk_version >= (8, 7):
478 is_ttk = widget.__class__.__module__ == 'tkinter.ttk'
479 self.checkParam(widget, 'underline', '',
480 expected='' if is_ttk else self._default_pixels)
481 self.checkParam(widget, 'underline', '5+2',
482 expected='5+2' if is_ttk else 7)
483 self.checkParam(widget, 'underline', '5-2',
484 expected='5-2' if is_ttk else 3)
485 self.checkParam(widget, 'underline', 'end', expected='end')
486 self.checkParam(widget, 'underline', 'end-2', expected='end-2')
487 errmsg = (r'bad index "{}": must be integer\?\[\+-\]integer\?, '
488 r'end\?\[\+-\]integer\?, or ""')
489 else:
490 errmsg = 'expected integer but got "{}"'
491 self.checkInvalidParam(widget, 'underline', '', errmsg=errmsg)
492 self.checkInvalidParam(widget, 'underline', '10p', errmsg=errmsg)
493 self.checkInvalidParam(widget, 'underline', 3.2, errmsg=errmsg)
494
495 def test_configure_wraplength(self):
496 widget = self.create()
497 self.checkPixelsParam(widget, 'wraplength', 100)
498
499 def test_configure_xscrollcommand(self):
500 widget = self.create()
501 self.checkCommandParam(widget, 'xscrollcommand')
502
503 def test_configure_yscrollcommand(self):
504 widget = self.create()
505 self.checkCommandParam(widget, 'yscrollcommand')
506
507 # non-standard but common options
508
509 def test_configure_command(self):
510 widget = self.create()
511 self.checkCommandParam(widget, 'command')
512
513 def test_configure_indicatoron(self):
514 widget = self.create()
515 self.checkBooleanParam(widget, 'indicatoron')
516
517 def test_configure_offrelief(self):
518 widget = self.create()
519 self.checkReliefParam(widget, 'offrelief')
520
521 def test_configure_overrelief(self):
522 widget = self.create()
523 self.checkReliefParam(widget, 'overrelief',
524 allow_empty=(tk_version >= (8, 7)))
525
526 def test_configure_selectcolor(self):
527 widget = self.create()
528 self.checkColorParam(widget, 'selectcolor')
529
530 def test_configure_selectimage(self):
531 widget = self.create()
532 self.checkImageParam(widget, 'selectimage')
533
534 def test_configure_tristateimage(self):
535 widget = self.create()
536 self.checkImageParam(widget, 'tristateimage')
537
538 def test_configure_tristatevalue(self):
539 widget = self.create()
540 self.checkParam(widget, 'tristatevalue', 'unknowable')
541
542 def test_configure_variable(self):
543 widget = self.create()
544 var = tkinter.DoubleVar(self.root)
545 self.checkVariableParam(widget, 'variable', var)
546
547
548 class IntegerSizeTests:
549 """ Tests widgets which only accept integral width and height."""
550 def test_configure_height(self):
551 widget = self.create()
552 self.checkIntegerParam(widget, 'height', 100, -100, 0)
553
554 def test_configure_width(self):
555 widget = self.create()
556 self.checkIntegerParam(widget, 'width', 402, -402, 0)
557
558
559 class PixelSizeTests:
560 """ Tests widgets which accept screen distances for width and height."""
561 def test_configure_height(self):
562 widget = self.create()
563 self.checkPixelsParam(widget, 'height', 100, 101.2, 102.6, -100, 0, '3c')
564
565 def test_configure_width(self):
566 widget = self.create()
567 self.checkPixelsParam(widget, 'width', 402, 403.4, 404.6, -402, 0, '5i')
568
569
570 def add_configure_tests(*source_classes):
571 # This decorator adds test_configure_xxx methods from source classes for
572 # every xxx option in the OPTIONS class attribute if they are not defined
573 # explicitly.
574 def decorator(cls):
575 for option in cls.OPTIONS:
576 methodname = 'test_configure_' + option
577 if not hasattr(cls, methodname):
578 for source_class in source_classes:
579 if hasattr(source_class, methodname):
580 setattr(cls, methodname,
581 getattr(source_class, methodname))
582 break
583 else:
584 def test(self, option=option):
585 widget = self.create()
586 widget[option]
587 raise AssertionError('Option "%s" is not tested in %s' %
588 (option, cls.__name__))
589 test.__name__ = methodname
590 setattr(cls, methodname, test)
591 return cls
592 return decorator
593
594 def setUpModule():
595 if test.support.verbose:
596 tcl = tkinter.Tcl()
597 print('patchlevel =', tcl.call('info', 'patchlevel'), flush=True)