Debian Codegraph @

Lib/test/test_tkinter/test_variables.py

raw
1 import unittest
2 from test import support
3
4 import gc
5 import tkinter
6 from tkinter import (Variable, StringVar, IntVar, DoubleVar, BooleanVar, Tcl,
7 TclError)
8 from test.support import ALWAYS_EQ
9 from test.test_tkinter.support import setUpModule # noqa: F401
10 from test.test_tkinter.support import AbstractDefaultRootTest, tcl_version
11
12
13 class Var(Variable):
14
15 _default = "default"
16 side_effect = False
17
18 def set(self, value):
19 self.side_effect = True
20 super().set(value)
21
22
23 class TestBase(unittest.TestCase):
24
25 def setUp(self):
26 self.root = Tcl()
27
28 def tearDown(self):
29 del self.root
30
31
32 class TestVariable(TestBase):
33
34 def info_exists(self, *args):
35 return self.root.getboolean(self.root.call("info", "exists", *args))
36
37 def test_default(self):
38 v = Variable(self.root)
39 self.assertEqual("", v.get())
40 self.assertRegex(str(v), r"^PY_VAR(\d+)$")
41
42 def test_name_and_value(self):
43 v = Variable(self.root, "sample string", "varname")
44 self.assertEqual("sample string", v.get())
45 self.assertEqual("varname", str(v))
46
47 def test___del__(self):
48 self.assertFalse(self.info_exists("varname"))
49 v = Variable(self.root, "sample string", "varname")
50 self.assertTrue(self.info_exists("varname"))
51 del v
52 support.gc_collect() # For PyPy or other GCs.
53 self.assertFalse(self.info_exists("varname"))
54
55 def test_dont_unset_not_existing(self):
56 self.assertFalse(self.info_exists("varname"))
57 v1 = Variable(self.root, name="name")
58 v2 = Variable(self.root, name="name")
59 del v1
60 support.gc_collect() # For PyPy or other GCs.
61 self.assertFalse(self.info_exists("name"))
62 # shouldn't raise exception
63 del v2
64 support.gc_collect() # For PyPy or other GCs.
65 self.assertFalse(self.info_exists("name"))
66
67 def test_equality(self):
68 # values doesn't matter, only class and name are checked
69 v1 = Variable(self.root, name="abc")
70 v2 = Variable(self.root, name="abc")
71 self.assertIsNot(v1, v2)
72 self.assertEqual(v1, v2)
73
74 v3 = Variable(self.root, name="cba")
75 self.assertNotEqual(v1, v3)
76
77 v4 = StringVar(self.root, name="abc")
78 self.assertEqual(str(v1), str(v4))
79 self.assertNotEqual(v1, v4)
80
81 V = type('Variable', (), {})
82 self.assertNotEqual(v1, V())
83
84 self.assertNotEqual(v1, object())
85 self.assertEqual(v1, ALWAYS_EQ)
86
87 root2 = tkinter.Tk()
88 self.addCleanup(root2.destroy)
89 v5 = Variable(root2, name="abc")
90 self.assertEqual(str(v1), str(v5))
91 self.assertNotEqual(v1, v5)
92
93 def test_invalid_name(self):
94 with self.assertRaises(TypeError):
95 Variable(self.root, name=123)
96
97 def test_null_in_name(self):
98 with self.assertRaises(ValueError):
99 Variable(self.root, name='var\x00name')
100 with self.assertRaises(ValueError):
101 self.root.globalsetvar('var\x00name', "value")
102 with self.assertRaises(ValueError):
103 self.root.globalsetvar(b'var\x00name', "value")
104 with self.assertRaises(ValueError):
105 self.root.setvar('var\x00name', "value")
106 with self.assertRaises(ValueError):
107 self.root.setvar(b'var\x00name', "value")
108
109 def test_initialize(self):
110 v = Var(self.root)
111 self.assertFalse(v.side_effect)
112 v.set("value")
113 self.assertTrue(v.side_effect)
114
115 def test_trace_old(self):
116 if tcl_version >= (9, 0):
117 self.skipTest('requires Tcl version < 9.0')
118 # Old interface
119 v = Variable(self.root)
120 vname = str(v)
121 trace = []
122 def read_tracer(*args):
123 trace.append(('read',) + args)
124 def write_tracer(*args):
125 trace.append(('write',) + args)
126 with self.assertWarns(DeprecationWarning) as cm:
127 cb1 = v.trace_variable('r', read_tracer)
128 self.assertEqual(cm.filename, __file__)
129 with self.assertWarns(DeprecationWarning):
130 cb2 = v.trace_variable('wu', write_tracer)
131 with self.assertWarns(DeprecationWarning) as cm:
132 self.assertEqual(sorted(v.trace_vinfo()), [('r', cb1), ('wu', cb2)])
133 self.assertEqual(cm.filename, __file__)
134 self.assertEqual(trace, [])
135
136 v.set('spam')
137 self.assertEqual(trace, [('write', vname, '', 'w')])
138
139 trace = []
140 v.get()
141 self.assertEqual(trace, [('read', vname, '', 'r')])
142
143 trace = []
144 with self.assertWarns(DeprecationWarning):
145 info = sorted(v.trace_vinfo())
146 with self.assertWarns(DeprecationWarning):
147 v.trace_vdelete('w', cb1) # Wrong mode
148 with self.assertWarns(DeprecationWarning):
149 self.assertEqual(sorted(v.trace_vinfo()), info)
150 with self.assertRaises(TclError):
151 with self.assertWarns(DeprecationWarning):
152 v.trace_vdelete('r', 'spam') # Wrong command name
153 with self.assertWarns(DeprecationWarning):
154 self.assertEqual(sorted(v.trace_vinfo()), info)
155 with self.assertWarns(DeprecationWarning):
156 v.trace_vdelete('r', (cb1, 43)) # Wrong arguments
157 with self.assertWarns(DeprecationWarning):
158 self.assertEqual(sorted(v.trace_vinfo()), info)
159 v.get()
160 self.assertEqual(trace, [('read', vname, '', 'r')])
161
162 trace = []
163 with self.assertWarns(DeprecationWarning) as cm:
164 v.trace_vdelete('r', cb1)
165 self.assertEqual(cm.filename, __file__)
166 with self.assertWarns(DeprecationWarning):
167 self.assertEqual(v.trace_vinfo(), [('wu', cb2)])
168 v.get()
169 self.assertEqual(trace, [])
170
171 trace = []
172 del write_tracer
173 gc.collect()
174 v.set('eggs')
175 self.assertEqual(trace, [('write', vname, '', 'w')])
176
177 trace = []
178 del v
179 gc.collect()
180 self.assertEqual(trace, [('write', vname, '', 'u')])
181
182 def test_trace(self):
183 v = Variable(self.root)
184 vname = str(v)
185 trace = []
186 def read_tracer(*args):
187 trace.append(('read',) + args)
188 def write_tracer(*args):
189 trace.append(('write',) + args)
190 tr1 = v.trace_add('read', read_tracer)
191 tr2 = v.trace_add(['write', 'unset'], write_tracer)
192 self.assertEqual(sorted(v.trace_info()), [
193 (('read',), tr1),
194 (('write', 'unset'), tr2)])
195 self.assertEqual(trace, [])
196
197 v.set('spam')
198 self.assertEqual(trace, [('write', vname, '', 'write')])
199
200 trace = []
201 v.get()
202 self.assertEqual(trace, [('read', vname, '', 'read')])
203
204 trace = []
205 info = sorted(v.trace_info())
206 v.trace_remove('write', tr1) # Wrong mode
207 self.assertEqual(sorted(v.trace_info()), info)
208 with self.assertRaises(TclError):
209 v.trace_remove('read', 'spam') # Wrong command name
210 self.assertEqual(sorted(v.trace_info()), info)
211 v.get()
212 self.assertEqual(trace, [('read', vname, '', 'read')])
213
214 trace = []
215 v.trace_remove('read', tr1)
216 self.assertEqual(v.trace_info(), [(('write', 'unset'), tr2)])
217 v.get()
218 self.assertEqual(trace, [])
219
220 trace = []
221 del write_tracer
222 gc.collect()
223 v.set('eggs')
224 self.assertEqual(trace, [('write', vname, '', 'write')])
225
226 trace = []
227 del v
228 gc.collect()
229 self.assertEqual(trace, [('write', vname, '', 'unset')])
230
231
232 class TestStringVar(TestBase):
233
234 def test_default(self):
235 v = StringVar(self.root)
236 self.assertEqual("", v.get())
237
238 def test_get(self):
239 v = StringVar(self.root, "abc", "name")
240 self.assertEqual("abc", v.get())
241 self.root.globalsetvar("name", "value")
242 self.assertEqual("value", v.get())
243
244 def test_get_null(self):
245 v = StringVar(self.root, "abc\x00def", "name")
246 self.assertEqual("abc\x00def", v.get())
247 self.root.globalsetvar("name", "val\x00ue")
248 self.assertEqual("val\x00ue", v.get())
249
250
251 class TestIntVar(TestBase):
252
253 def test_default(self):
254 v = IntVar(self.root)
255 self.assertEqual(0, v.get())
256
257 def test_get(self):
258 v = IntVar(self.root, 123, "name")
259 self.assertEqual(123, v.get())
260 self.root.globalsetvar("name", "345")
261 self.assertEqual(345, v.get())
262 self.root.globalsetvar("name", "876.5")
263 self.assertEqual(876, v.get())
264
265 def test_invalid_value(self):
266 v = IntVar(self.root, name="name")
267 self.root.globalsetvar("name", "value")
268 with self.assertRaises((ValueError, TclError)):
269 v.get()
270
271
272 class TestDoubleVar(TestBase):
273
274 def test_default(self):
275 v = DoubleVar(self.root)
276 self.assertEqual(0.0, v.get())
277
278 def test_get(self):
279 v = DoubleVar(self.root, 1.23, "name")
280 self.assertAlmostEqual(1.23, v.get())
281 self.root.globalsetvar("name", "3.45")
282 self.assertAlmostEqual(3.45, v.get())
283
284 def test_get_from_int(self):
285 v = DoubleVar(self.root, 1.23, "name")
286 self.assertAlmostEqual(1.23, v.get())
287 self.root.globalsetvar("name", "3.45")
288 self.assertAlmostEqual(3.45, v.get())
289 self.root.globalsetvar("name", "456")
290 self.assertAlmostEqual(456, v.get())
291
292 def test_invalid_value(self):
293 v = DoubleVar(self.root, name="name")
294 self.root.globalsetvar("name", "value")
295 with self.assertRaises((ValueError, TclError)):
296 v.get()
297
298
299 class TestBooleanVar(TestBase):
300
301 def test_default(self):
302 v = BooleanVar(self.root)
303 self.assertIs(v.get(), False)
304
305 def test_get(self):
306 v = BooleanVar(self.root, True, "name")
307 self.assertIs(v.get(), True)
308 self.root.globalsetvar("name", "0")
309 self.assertIs(v.get(), False)
310 self.root.globalsetvar("name", 42 if self.root.wantobjects() else 1)
311 self.assertIs(v.get(), True)
312 self.root.globalsetvar("name", 0)
313 self.assertIs(v.get(), False)
314 self.root.globalsetvar("name", "on")
315 self.assertIs(v.get(), True)
316
317 def test_set(self):
318 true = 1 if self.root.wantobjects() else "1"
319 false = 0 if self.root.wantobjects() else "0"
320 v = BooleanVar(self.root, name="name")
321 v.set(True)
322 self.assertEqual(self.root.globalgetvar("name"), true)
323 v.set("0")
324 self.assertEqual(self.root.globalgetvar("name"), false)
325 v.set(42)
326 self.assertEqual(self.root.globalgetvar("name"), true)
327 v.set(0)
328 self.assertEqual(self.root.globalgetvar("name"), false)
329 v.set("on")
330 self.assertEqual(self.root.globalgetvar("name"), true)
331
332 def test_invalid_value_domain(self):
333 false = 0 if self.root.wantobjects() else "0"
334 v = BooleanVar(self.root, name="name")
335 with self.assertRaises(TclError):
336 v.set("value")
337 self.assertEqual(self.root.globalgetvar("name"), false)
338 self.root.globalsetvar("name", "value")
339 with self.assertRaises(ValueError):
340 v.get()
341 self.root.globalsetvar("name", "1.0")
342 with self.assertRaises(ValueError):
343 v.get()
344
345
346 class DefaultRootTest(AbstractDefaultRootTest, unittest.TestCase):
347
348 def test_variable(self):
349 self.assertRaises(RuntimeError, Variable)
350 root = tkinter.Tk()
351 v = Variable()
352 v.set("value")
353 self.assertEqual(v.get(), "value")
354 root.destroy()
355 tkinter.NoDefaultRoot()
356 self.assertRaises(RuntimeError, Variable)
357
358
359 if __name__ == "__main__":
360 unittest.main()