blob: d1f31923708ef93a563ce70dfeb42ad3a6090199 [file] [log] [blame]
Walter Dörwald59b23e82004-09-30 13:46:00 +00001import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002from test import support
Walter Dörwald59b23e82004-09-30 13:46:00 +00003
Florent Xiclunaa988e422010-03-02 16:06:24 +00004import collections, random, string
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00005import collections.abc
Antoine Pitrou7ddda782009-01-01 15:35:33 +00006import gc, weakref
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00007import pickle
Walter Dörwald59b23e82004-09-30 13:46:00 +00008
9
10class DictTest(unittest.TestCase):
Guido van Rossum47b9ff62006-08-24 00:41:19 +000011
Benjamin Petersonfb886362010-04-24 18:21:17 +000012 def test_invalid_keyword_arguments(self):
Benjamin Petersonf6096542010-11-17 22:33:12 +000013 class Custom(dict):
14 pass
15 for invalid in {1 : 2}, Custom({1 : 2}):
16 with self.assertRaises(TypeError):
17 dict(**invalid)
18 with self.assertRaises(TypeError):
19 {}.update(**invalid)
Benjamin Petersonfb886362010-04-24 18:21:17 +000020
Walter Dörwald59b23e82004-09-30 13:46:00 +000021 def test_constructor(self):
22 # calling built-in types without argument must return empty
23 self.assertEqual(dict(), {})
Florent Xiclunaa988e422010-03-02 16:06:24 +000024 self.assertIsNot(dict(), {})
Walter Dörwald59b23e82004-09-30 13:46:00 +000025
Christian Heimes99170a52007-12-19 02:07:34 +000026 def test_literal_constructor(self):
Florent Xiclunaa988e422010-03-02 16:06:24 +000027 # check literal constructor for different sized dicts
28 # (to exercise the BUILD_MAP oparg).
Christian Heimesb186d002008-03-18 15:15:01 +000029 for n in (0, 1, 6, 256, 400):
Florent Xiclunaa988e422010-03-02 16:06:24 +000030 items = [(''.join(random.sample(string.ascii_letters, 8)), i)
Christian Heimesb186d002008-03-18 15:15:01 +000031 for i in range(n)]
32 random.shuffle(items)
Florent Xiclunaa988e422010-03-02 16:06:24 +000033 formatted_items = ('{!r}: {:d}'.format(k, v) for k, v in items)
34 dictliteral = '{' + ', '.join(formatted_items) + '}'
Christian Heimes99170a52007-12-19 02:07:34 +000035 self.assertEqual(eval(dictliteral), dict(items))
Christian Heimes99170a52007-12-19 02:07:34 +000036
Walter Dörwald59b23e82004-09-30 13:46:00 +000037 def test_bool(self):
Florent Xiclunaa988e422010-03-02 16:06:24 +000038 self.assertIs(not {}, True)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000039 self.assertTrue({1: 2})
Florent Xiclunaa988e422010-03-02 16:06:24 +000040 self.assertIs(bool({}), False)
41 self.assertIs(bool({1: 2}), True)
Walter Dörwald59b23e82004-09-30 13:46:00 +000042
43 def test_keys(self):
44 d = {}
Guido van Rossume34cdd12007-02-14 17:49:04 +000045 self.assertEqual(set(d.keys()), set())
Walter Dörwald59b23e82004-09-30 13:46:00 +000046 d = {'a': 1, 'b': 2}
47 k = d.keys()
Benjamin Peterson577473f2010-01-19 00:09:57 +000048 self.assertIn('a', d)
Benjamin Peterson577473f2010-01-19 00:09:57 +000049 self.assertIn('b', d)
Walter Dörwald59b23e82004-09-30 13:46:00 +000050 self.assertRaises(TypeError, d.keys, None)
Raymond Hettingerb0d56af2009-03-03 10:52:49 +000051 self.assertEqual(repr(dict(a=1).keys()), "dict_keys(['a'])")
Walter Dörwald59b23e82004-09-30 13:46:00 +000052
53 def test_values(self):
54 d = {}
Guido van Rossume34cdd12007-02-14 17:49:04 +000055 self.assertEqual(set(d.values()), set())
Walter Dörwald59b23e82004-09-30 13:46:00 +000056 d = {1:2}
Guido van Rossume34cdd12007-02-14 17:49:04 +000057 self.assertEqual(set(d.values()), {2})
Walter Dörwald59b23e82004-09-30 13:46:00 +000058 self.assertRaises(TypeError, d.values, None)
Raymond Hettingerb0d56af2009-03-03 10:52:49 +000059 self.assertEqual(repr(dict(a=1).values()), "dict_values([1])")
Walter Dörwald59b23e82004-09-30 13:46:00 +000060
61 def test_items(self):
62 d = {}
Guido van Rossume34cdd12007-02-14 17:49:04 +000063 self.assertEqual(set(d.items()), set())
Walter Dörwald59b23e82004-09-30 13:46:00 +000064
65 d = {1:2}
Guido van Rossume34cdd12007-02-14 17:49:04 +000066 self.assertEqual(set(d.items()), {(1, 2)})
Walter Dörwald59b23e82004-09-30 13:46:00 +000067 self.assertRaises(TypeError, d.items, None)
Raymond Hettingerb0d56af2009-03-03 10:52:49 +000068 self.assertEqual(repr(dict(a=1).items()), "dict_items([('a', 1)])")
Walter Dörwald59b23e82004-09-30 13:46:00 +000069
Walter Dörwald59b23e82004-09-30 13:46:00 +000070 def test_contains(self):
71 d = {}
Ezio Melottib58e0bd2010-01-23 15:40:09 +000072 self.assertNotIn('a', d)
Florent Xiclunaa988e422010-03-02 16:06:24 +000073 self.assertFalse('a' in d)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000074 self.assertTrue('a' not in d)
Walter Dörwald59b23e82004-09-30 13:46:00 +000075 d = {'a': 1, 'b': 2}
Benjamin Peterson577473f2010-01-19 00:09:57 +000076 self.assertIn('a', d)
Benjamin Peterson577473f2010-01-19 00:09:57 +000077 self.assertIn('b', d)
Benjamin Peterson577473f2010-01-19 00:09:57 +000078 self.assertNotIn('c', d)
Walter Dörwald59b23e82004-09-30 13:46:00 +000079
80 self.assertRaises(TypeError, d.__contains__)
81
82 def test_len(self):
83 d = {}
84 self.assertEqual(len(d), 0)
85 d = {'a': 1, 'b': 2}
86 self.assertEqual(len(d), 2)
87
88 def test_getitem(self):
89 d = {'a': 1, 'b': 2}
90 self.assertEqual(d['a'], 1)
91 self.assertEqual(d['b'], 2)
92 d['c'] = 3
93 d['a'] = 4
94 self.assertEqual(d['c'], 3)
95 self.assertEqual(d['a'], 4)
96 del d['b']
97 self.assertEqual(d, {'a': 4, 'c': 3})
98
99 self.assertRaises(TypeError, d.__getitem__)
100
101 class BadEq(object):
102 def __eq__(self, other):
103 raise Exc()
Guido van Rossum38938152006-08-21 23:36:26 +0000104 def __hash__(self):
105 return 24
Walter Dörwald59b23e82004-09-30 13:46:00 +0000106
107 d = {}
108 d[BadEq()] = 42
109 self.assertRaises(KeyError, d.__getitem__, 23)
110
111 class Exc(Exception): pass
112
113 class BadHash(object):
114 fail = False
115 def __hash__(self):
116 if self.fail:
117 raise Exc()
118 else:
119 return 42
120
121 x = BadHash()
122 d[x] = 42
123 x.fail = True
124 self.assertRaises(Exc, d.__getitem__, x)
125
126 def test_clear(self):
127 d = {1:1, 2:2, 3:3}
128 d.clear()
129 self.assertEqual(d, {})
130
131 self.assertRaises(TypeError, d.clear, None)
132
133 def test_update(self):
134 d = {}
135 d.update({1:100})
136 d.update({2:20})
137 d.update({1:1, 2:2, 3:3})
138 self.assertEqual(d, {1:1, 2:2, 3:3})
139
140 d.update()
141 self.assertEqual(d, {1:1, 2:2, 3:3})
142
143 self.assertRaises((TypeError, AttributeError), d.update, None)
144
145 class SimpleUserDict:
146 def __init__(self):
147 self.d = {1:1, 2:2, 3:3}
148 def keys(self):
149 return self.d.keys()
150 def __getitem__(self, i):
151 return self.d[i]
152 d.clear()
153 d.update(SimpleUserDict())
154 self.assertEqual(d, {1:1, 2:2, 3:3})
155
156 class Exc(Exception): pass
157
158 d.clear()
159 class FailingUserDict:
160 def keys(self):
161 raise Exc
162 self.assertRaises(Exc, d.update, FailingUserDict())
163
164 class FailingUserDict:
165 def keys(self):
166 class BogonIter:
167 def __init__(self):
168 self.i = 1
169 def __iter__(self):
170 return self
Georg Brandla18af4e2007-04-21 15:47:16 +0000171 def __next__(self):
Walter Dörwald59b23e82004-09-30 13:46:00 +0000172 if self.i:
173 self.i = 0
174 return 'a'
175 raise Exc
176 return BogonIter()
177 def __getitem__(self, key):
178 return key
179 self.assertRaises(Exc, d.update, FailingUserDict())
180
181 class FailingUserDict:
182 def keys(self):
183 class BogonIter:
184 def __init__(self):
185 self.i = ord('a')
186 def __iter__(self):
187 return self
Georg Brandla18af4e2007-04-21 15:47:16 +0000188 def __next__(self):
Walter Dörwald59b23e82004-09-30 13:46:00 +0000189 if self.i <= ord('z'):
190 rtn = chr(self.i)
191 self.i += 1
192 return rtn
193 raise StopIteration
194 return BogonIter()
195 def __getitem__(self, key):
196 raise Exc
197 self.assertRaises(Exc, d.update, FailingUserDict())
198
199 class badseq(object):
200 def __iter__(self):
201 return self
Georg Brandla18af4e2007-04-21 15:47:16 +0000202 def __next__(self):
Walter Dörwald59b23e82004-09-30 13:46:00 +0000203 raise Exc()
204
205 self.assertRaises(Exc, {}.update, badseq())
206
207 self.assertRaises(ValueError, {}.update, [(1, 2, 3)])
208
209 def test_fromkeys(self):
210 self.assertEqual(dict.fromkeys('abc'), {'a':None, 'b':None, 'c':None})
211 d = {}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000212 self.assertIsNot(d.fromkeys('abc'), d)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000213 self.assertEqual(d.fromkeys('abc'), {'a':None, 'b':None, 'c':None})
214 self.assertEqual(d.fromkeys((4,5),0), {4:0, 5:0})
215 self.assertEqual(d.fromkeys([]), {})
216 def g():
217 yield 1
218 self.assertEqual(d.fromkeys(g()), {1:None})
219 self.assertRaises(TypeError, {}.fromkeys, 3)
220 class dictlike(dict): pass
221 self.assertEqual(dictlike.fromkeys('a'), {'a':None})
222 self.assertEqual(dictlike().fromkeys('a'), {'a':None})
Florent Xiclunaa988e422010-03-02 16:06:24 +0000223 self.assertIsInstance(dictlike.fromkeys('a'), dictlike)
224 self.assertIsInstance(dictlike().fromkeys('a'), dictlike)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000225 class mydict(dict):
226 def __new__(cls):
Raymond Hettingerf80680d2008-02-06 00:07:11 +0000227 return collections.UserDict()
Walter Dörwald59b23e82004-09-30 13:46:00 +0000228 ud = mydict.fromkeys('ab')
229 self.assertEqual(ud, {'a':None, 'b':None})
Ezio Melottie9615932010-01-24 19:26:24 +0000230 self.assertIsInstance(ud, collections.UserDict)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000231 self.assertRaises(TypeError, dict.fromkeys)
232
233 class Exc(Exception): pass
234
235 class baddict1(dict):
236 def __init__(self):
237 raise Exc()
238
239 self.assertRaises(Exc, baddict1.fromkeys, [1])
240
241 class BadSeq(object):
242 def __iter__(self):
243 return self
Georg Brandla18af4e2007-04-21 15:47:16 +0000244 def __next__(self):
Walter Dörwald59b23e82004-09-30 13:46:00 +0000245 raise Exc()
246
247 self.assertRaises(Exc, dict.fromkeys, BadSeq())
248
249 class baddict2(dict):
250 def __setitem__(self, key, value):
251 raise Exc()
252
253 self.assertRaises(Exc, baddict2.fromkeys, [1])
254
Guido van Rossum58da9312007-11-10 23:39:45 +0000255 # test fast path for dictionary inputs
256 d = dict(zip(range(6), range(6)))
257 self.assertEqual(dict.fromkeys(d, 0), dict(zip(range(6), [0]*6)))
258
Benjamin Petersond1f2cb32012-10-31 14:05:55 -0400259 class baddict3(dict):
260 def __new__(cls):
261 return d
262 d = {i : i for i in range(10)}
263 res = d.copy()
264 res.update(a=None, b=None, c=None)
265 self.assertEqual(baddict3.fromkeys({"a", "b", "c"}), res)
266
Walter Dörwald59b23e82004-09-30 13:46:00 +0000267 def test_copy(self):
268 d = {1:1, 2:2, 3:3}
269 self.assertEqual(d.copy(), {1:1, 2:2, 3:3})
270 self.assertEqual({}.copy(), {})
271 self.assertRaises(TypeError, d.copy, None)
272
273 def test_get(self):
274 d = {}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000275 self.assertIs(d.get('c'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000276 self.assertEqual(d.get('c', 3), 3)
Florent Xiclunaa988e422010-03-02 16:06:24 +0000277 d = {'a': 1, 'b': 2}
278 self.assertIs(d.get('c'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000279 self.assertEqual(d.get('c', 3), 3)
280 self.assertEqual(d.get('a'), 1)
281 self.assertEqual(d.get('a', 3), 1)
282 self.assertRaises(TypeError, d.get)
283 self.assertRaises(TypeError, d.get, None, None, None)
284
285 def test_setdefault(self):
286 # dict.setdefault()
287 d = {}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000288 self.assertIs(d.setdefault('key0'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000289 d.setdefault('key0', [])
Florent Xiclunaa988e422010-03-02 16:06:24 +0000290 self.assertIs(d.setdefault('key0'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000291 d.setdefault('key', []).append(3)
292 self.assertEqual(d['key'][0], 3)
293 d.setdefault('key', []).append(4)
294 self.assertEqual(len(d['key']), 2)
295 self.assertRaises(TypeError, d.setdefault)
296
297 class Exc(Exception): pass
298
299 class BadHash(object):
300 fail = False
301 def __hash__(self):
302 if self.fail:
303 raise Exc()
304 else:
305 return 42
306
307 x = BadHash()
308 d[x] = 42
309 x.fail = True
310 self.assertRaises(Exc, d.setdefault, x, [])
311
Antoine Pitroue965d972012-02-27 00:45:12 +0100312 def test_setdefault_atomic(self):
313 # Issue #13521: setdefault() calls __hash__ and __eq__ only once.
314 class Hashed(object):
315 def __init__(self):
316 self.hash_count = 0
317 self.eq_count = 0
318 def __hash__(self):
319 self.hash_count += 1
320 return 42
321 def __eq__(self, other):
322 self.eq_count += 1
323 return id(self) == id(other)
324 hashed1 = Hashed()
325 y = {hashed1: 5}
326 hashed2 = Hashed()
327 y.setdefault(hashed2, [])
328 self.assertEqual(hashed1.hash_count, 1)
329 self.assertEqual(hashed2.hash_count, 1)
330 self.assertEqual(hashed1.eq_count + hashed2.eq_count, 1)
331
Benjamin Peterson7d95e402012-04-23 11:24:50 -0400332 def test_setitem_atomic_at_resize(self):
333 class Hashed(object):
334 def __init__(self):
335 self.hash_count = 0
336 self.eq_count = 0
337 def __hash__(self):
338 self.hash_count += 1
339 return 42
340 def __eq__(self, other):
341 self.eq_count += 1
342 return id(self) == id(other)
343 hashed1 = Hashed()
344 # 5 items
345 y = {hashed1: 5, 0: 0, 1: 1, 2: 2, 3: 3}
346 hashed2 = Hashed()
347 # 6th item forces a resize
348 y[hashed2] = []
349 self.assertEqual(hashed1.hash_count, 1)
350 self.assertEqual(hashed2.hash_count, 1)
351 self.assertEqual(hashed1.eq_count + hashed2.eq_count, 1)
352
Walter Dörwald59b23e82004-09-30 13:46:00 +0000353 def test_popitem(self):
354 # dict.popitem()
355 for copymode in -1, +1:
356 # -1: b has same structure as a
357 # +1: b is a.copy()
358 for log2size in range(12):
359 size = 2**log2size
360 a = {}
361 b = {}
362 for i in range(size):
363 a[repr(i)] = i
364 if copymode < 0:
365 b[repr(i)] = i
366 if copymode > 0:
367 b = a.copy()
368 for i in range(size):
369 ka, va = ta = a.popitem()
370 self.assertEqual(va, int(ka))
371 kb, vb = tb = b.popitem()
372 self.assertEqual(vb, int(kb))
Florent Xiclunaa988e422010-03-02 16:06:24 +0000373 self.assertFalse(copymode < 0 and ta != tb)
374 self.assertFalse(a)
375 self.assertFalse(b)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000376
377 d = {}
378 self.assertRaises(KeyError, d.popitem)
379
380 def test_pop(self):
381 # Tests for pop with specified key
382 d = {}
383 k, v = 'abc', 'def'
384 d[k] = v
385 self.assertRaises(KeyError, d.pop, 'ghi')
386
387 self.assertEqual(d.pop(k), v)
388 self.assertEqual(len(d), 0)
389
390 self.assertRaises(KeyError, d.pop, k)
391
Walter Dörwald59b23e82004-09-30 13:46:00 +0000392 self.assertEqual(d.pop(k, v), v)
393 d[k] = v
394 self.assertEqual(d.pop(k, 1), v)
395
396 self.assertRaises(TypeError, d.pop)
397
398 class Exc(Exception): pass
399
400 class BadHash(object):
401 fail = False
402 def __hash__(self):
403 if self.fail:
404 raise Exc()
405 else:
406 return 42
407
408 x = BadHash()
409 d[x] = 42
410 x.fail = True
411 self.assertRaises(Exc, d.pop, x)
412
Victor Stinner198b2912012-03-06 01:03:13 +0100413 def test_mutating_iteration(self):
Florent Xiclunaa988e422010-03-02 16:06:24 +0000414 # changing dict size during iteration
Walter Dörwald59b23e82004-09-30 13:46:00 +0000415 d = {}
416 d[1] = 1
Florent Xiclunaa988e422010-03-02 16:06:24 +0000417 with self.assertRaises(RuntimeError):
Walter Dörwald59b23e82004-09-30 13:46:00 +0000418 for i in d:
419 d[i+1] = 1
Walter Dörwald59b23e82004-09-30 13:46:00 +0000420
Victor Stinner198b2912012-03-06 01:03:13 +0100421 def test_mutating_lookup(self):
Antoine Pitrou9a234902012-05-13 20:48:01 +0200422 # changing dict during a lookup (issue #14417)
Victor Stinner198b2912012-03-06 01:03:13 +0100423 class NastyKey:
424 mutate_dict = None
425
Victor Stinner28393822012-03-09 22:58:51 +0100426 def __init__(self, value):
427 self.value = value
428
Victor Stinner198b2912012-03-06 01:03:13 +0100429 def __hash__(self):
430 # hash collision!
431 return 1
432
433 def __eq__(self, other):
Victor Stinner28393822012-03-09 22:58:51 +0100434 if NastyKey.mutate_dict:
435 mydict, key = NastyKey.mutate_dict
436 NastyKey.mutate_dict = None
437 del mydict[key]
438 return self.value == other.value
Victor Stinner198b2912012-03-06 01:03:13 +0100439
Victor Stinner28393822012-03-09 22:58:51 +0100440 key1 = NastyKey(1)
441 key2 = NastyKey(2)
442 d = {key1: 1}
443 NastyKey.mutate_dict = (d, key1)
Antoine Pitrou9a234902012-05-13 20:48:01 +0200444 d[key2] = 2
445 self.assertEqual(d, {key2: 2})
Victor Stinner198b2912012-03-06 01:03:13 +0100446
Walter Dörwald59b23e82004-09-30 13:46:00 +0000447 def test_repr(self):
448 d = {}
449 self.assertEqual(repr(d), '{}')
450 d[1] = 2
451 self.assertEqual(repr(d), '{1: 2}')
452 d = {}
453 d[1] = d
454 self.assertEqual(repr(d), '{1: {...}}')
455
456 class Exc(Exception): pass
457
458 class BadRepr(object):
459 def __repr__(self):
460 raise Exc()
461
462 d = {1: BadRepr()}
463 self.assertRaises(Exc, repr, d)
464
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000465 def test_eq(self):
466 self.assertEqual({}, {})
Guido van Rossume2a383d2007-01-15 16:59:06 +0000467 self.assertEqual({1: 2}, {1: 2})
Walter Dörwald59b23e82004-09-30 13:46:00 +0000468
469 class Exc(Exception): pass
470
471 class BadCmp(object):
472 def __eq__(self, other):
473 raise Exc()
Guido van Rossum38938152006-08-21 23:36:26 +0000474 def __hash__(self):
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000475 return 1
Walter Dörwald59b23e82004-09-30 13:46:00 +0000476
477 d1 = {BadCmp(): 1}
478 d2 = {1: 1}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000479
480 with self.assertRaises(Exc):
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000481 d1 == d2
Walter Dörwald59b23e82004-09-30 13:46:00 +0000482
Guido van Rossumaac530c2007-08-24 22:33:45 +0000483 def test_keys_contained(self):
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000484 self.helper_keys_contained(lambda x: x.keys())
485 self.helper_keys_contained(lambda x: x.items())
486
487 def helper_keys_contained(self, fn):
Guido van Rossumaac530c2007-08-24 22:33:45 +0000488 # Test rich comparisons against dict key views, which should behave the
489 # same as sets.
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000490 empty = fn(dict())
491 empty2 = fn(dict())
492 smaller = fn({1:1, 2:2})
493 larger = fn({1:1, 2:2, 3:3})
494 larger2 = fn({1:1, 2:2, 3:3})
495 larger3 = fn({4:1, 2:2, 3:3})
Guido van Rossumaac530c2007-08-24 22:33:45 +0000496
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000497 self.assertTrue(smaller < larger)
498 self.assertTrue(smaller <= larger)
499 self.assertTrue(larger > smaller)
500 self.assertTrue(larger >= smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000501
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000502 self.assertFalse(smaller >= larger)
503 self.assertFalse(smaller > larger)
504 self.assertFalse(larger <= smaller)
505 self.assertFalse(larger < smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000506
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000507 self.assertFalse(smaller < larger3)
508 self.assertFalse(smaller <= larger3)
509 self.assertFalse(larger3 > smaller)
510 self.assertFalse(larger3 >= smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000511
512 # Inequality strictness
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000513 self.assertTrue(larger2 >= larger)
514 self.assertTrue(larger2 <= larger)
515 self.assertFalse(larger2 > larger)
516 self.assertFalse(larger2 < larger)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000517
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000518 self.assertTrue(larger == larger2)
519 self.assertTrue(smaller != larger)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000520
521 # There is an optimization on the zero-element case.
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000522 self.assertTrue(empty == empty2)
523 self.assertFalse(empty != empty2)
524 self.assertFalse(empty == smaller)
525 self.assertTrue(empty != smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000526
527 # With the same size, an elementwise compare happens
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000528 self.assertTrue(larger != larger3)
529 self.assertFalse(larger == larger3)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000530
531 def test_errors_in_view_containment_check(self):
532 class C:
533 def __eq__(self, other):
534 raise RuntimeError
Florent Xiclunaa988e422010-03-02 16:06:24 +0000535
Guido van Rossumaac530c2007-08-24 22:33:45 +0000536 d1 = {1: C()}
537 d2 = {1: C()}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000538 with self.assertRaises(RuntimeError):
539 d1.items() == d2.items()
540 with self.assertRaises(RuntimeError):
541 d1.items() != d2.items()
542 with self.assertRaises(RuntimeError):
543 d1.items() <= d2.items()
544 with self.assertRaises(RuntimeError):
545 d1.items() >= d2.items()
546
Guido van Rossumaac530c2007-08-24 22:33:45 +0000547 d3 = {1: C(), 2: C()}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000548 with self.assertRaises(RuntimeError):
549 d2.items() < d3.items()
550 with self.assertRaises(RuntimeError):
551 d3.items() > d2.items()
Guido van Rossumaac530c2007-08-24 22:33:45 +0000552
Guido van Rossumbe534712007-08-24 23:43:52 +0000553 def test_dictview_set_operations_on_keys(self):
Guido van Rossum523259b2007-08-24 23:41:22 +0000554 k1 = {1:1, 2:2}.keys()
555 k2 = {1:1, 2:2, 3:3}.keys()
556 k3 = {4:4}.keys()
557
Florent Xiclunaa988e422010-03-02 16:06:24 +0000558 self.assertEqual(k1 - k2, set())
559 self.assertEqual(k1 - k3, {1,2})
560 self.assertEqual(k2 - k1, {3})
561 self.assertEqual(k3 - k1, {4})
562 self.assertEqual(k1 & k2, {1,2})
563 self.assertEqual(k1 & k3, set())
564 self.assertEqual(k1 | k2, {1,2,3})
565 self.assertEqual(k1 ^ k2, {3})
566 self.assertEqual(k1 ^ k3, {1,2,4})
Guido van Rossum523259b2007-08-24 23:41:22 +0000567
Guido van Rossumbe534712007-08-24 23:43:52 +0000568 def test_dictview_set_operations_on_items(self):
569 k1 = {1:1, 2:2}.items()
570 k2 = {1:1, 2:2, 3:3}.items()
571 k3 = {4:4}.items()
572
Florent Xiclunaa988e422010-03-02 16:06:24 +0000573 self.assertEqual(k1 - k2, set())
574 self.assertEqual(k1 - k3, {(1,1), (2,2)})
575 self.assertEqual(k2 - k1, {(3,3)})
576 self.assertEqual(k3 - k1, {(4,4)})
577 self.assertEqual(k1 & k2, {(1,1), (2,2)})
578 self.assertEqual(k1 & k3, set())
579 self.assertEqual(k1 | k2, {(1,1), (2,2), (3,3)})
580 self.assertEqual(k1 ^ k2, {(3,3)})
581 self.assertEqual(k1 ^ k3, {(1,1), (2,2), (4,4)})
Guido van Rossum523259b2007-08-24 23:41:22 +0000582
Guido van Rossum1d719962007-08-24 23:47:30 +0000583 def test_dictview_mixed_set_operations(self):
584 # Just a few for .keys()
Guido van Rossuma401bbe2007-08-24 23:51:55 +0000585 self.assertTrue({1:1}.keys() == {1})
586 self.assertTrue({1} == {1:1}.keys())
Florent Xiclunaa988e422010-03-02 16:06:24 +0000587 self.assertEqual({1:1}.keys() | {2}, {1, 2})
588 self.assertEqual({2} | {1:1}.keys(), {1, 2})
Guido van Rossum1d719962007-08-24 23:47:30 +0000589 # And a few for .items()
Guido van Rossuma401bbe2007-08-24 23:51:55 +0000590 self.assertTrue({1:1}.items() == {(1,1)})
591 self.assertTrue({(1,1)} == {1:1}.items())
Florent Xiclunaa988e422010-03-02 16:06:24 +0000592 self.assertEqual({1:1}.items() | {2}, {(1,1), 2})
593 self.assertEqual({2} | {1:1}.items(), {(1,1), 2})
Guido van Rossum1d719962007-08-24 23:47:30 +0000594
Guido van Rossum1968ad32006-02-25 22:38:04 +0000595 def test_missing(self):
596 # Make sure dict doesn't have a __missing__ method
Florent Xiclunaa988e422010-03-02 16:06:24 +0000597 self.assertFalse(hasattr(dict, "__missing__"))
598 self.assertFalse(hasattr({}, "__missing__"))
Guido van Rossum1968ad32006-02-25 22:38:04 +0000599 # Test several cases:
600 # (D) subclass defines __missing__ method returning a value
601 # (E) subclass defines __missing__ method raising RuntimeError
602 # (F) subclass sets __missing__ instance variable (no effect)
603 # (G) subclass doesn't define __missing__ at a all
604 class D(dict):
605 def __missing__(self, key):
606 return 42
607 d = D({1: 2, 3: 4})
608 self.assertEqual(d[1], 2)
609 self.assertEqual(d[3], 4)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000610 self.assertNotIn(2, d)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000611 self.assertNotIn(2, d.keys())
Guido van Rossum1968ad32006-02-25 22:38:04 +0000612 self.assertEqual(d[2], 42)
Florent Xiclunaa988e422010-03-02 16:06:24 +0000613
Guido van Rossum1968ad32006-02-25 22:38:04 +0000614 class E(dict):
615 def __missing__(self, key):
616 raise RuntimeError(key)
617 e = E()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000618 with self.assertRaises(RuntimeError) as c:
Guido van Rossum1968ad32006-02-25 22:38:04 +0000619 e[42]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000620 self.assertEqual(c.exception.args, (42,))
621
Guido van Rossum1968ad32006-02-25 22:38:04 +0000622 class F(dict):
623 def __init__(self):
624 # An instance variable __missing__ should have no effect
625 self.__missing__ = lambda key: None
626 f = F()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000627 with self.assertRaises(KeyError) as c:
Guido van Rossum1968ad32006-02-25 22:38:04 +0000628 f[42]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000629 self.assertEqual(c.exception.args, (42,))
630
Guido van Rossum1968ad32006-02-25 22:38:04 +0000631 class G(dict):
632 pass
633 g = G()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000634 with self.assertRaises(KeyError) as c:
Guido van Rossum1968ad32006-02-25 22:38:04 +0000635 g[42]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000636 self.assertEqual(c.exception.args, (42,))
Guido van Rossum1968ad32006-02-25 22:38:04 +0000637
Thomas Wouters89f507f2006-12-13 04:49:30 +0000638 def test_tuple_keyerror(self):
639 # SF #1576657
640 d = {}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000641 with self.assertRaises(KeyError) as c:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000642 d[(1,)]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000643 self.assertEqual(c.exception.args, ((1,),))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000644
Guido van Rossumd8faa362007-04-27 19:54:29 +0000645 def test_bad_key(self):
Mark Dickinsona56c4672009-01-27 18:17:45 +0000646 # Dictionary lookups should fail if __eq__() raises an exception.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000647 class CustomException(Exception):
648 pass
649
650 class BadDictKey:
651 def __hash__(self):
652 return hash(self.__class__)
653
654 def __eq__(self, other):
655 if isinstance(other, self.__class__):
656 raise CustomException
657 return other
658
659 d = {}
660 x1 = BadDictKey()
661 x2 = BadDictKey()
662 d[x1] = 1
663 for stmt in ['d[x2] = 2',
664 'z = d[x2]',
665 'x2 in d',
666 'd.get(x2)',
667 'd.setdefault(x2, 42)',
668 'd.pop(x2)',
669 'd.update({x2: 2})']:
Florent Xiclunaa988e422010-03-02 16:06:24 +0000670 with self.assertRaises(CustomException):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000671 exec(stmt, locals())
Guido van Rossumd8faa362007-04-27 19:54:29 +0000672
673 def test_resize1(self):
674 # Dict resizing bug, found by Jack Jansen in 2.2 CVS development.
675 # This version got an assert failure in debug build, infinite loop in
676 # release build. Unfortunately, provoking this kind of stuff requires
677 # a mix of inserts and deletes hitting exactly the right hash codes in
678 # exactly the right order, and I can't think of a randomized approach
679 # that would be *likely* to hit a failing case in reasonable time.
680
681 d = {}
682 for i in range(5):
683 d[i] = i
684 for i in range(5):
685 del d[i]
686 for i in range(5, 9): # i==8 was the problem
687 d[i] = i
688
689 def test_resize2(self):
690 # Another dict resizing bug (SF bug #1456209).
691 # This caused Segmentation faults or Illegal instructions.
692
693 class X(object):
694 def __hash__(self):
695 return 5
696 def __eq__(self, other):
697 if resizing:
698 d.clear()
699 return False
700 d = {}
701 resizing = False
702 d[X()] = 1
703 d[X()] = 2
704 d[X()] = 3
705 d[X()] = 4
706 d[X()] = 5
707 # now trigger a resize
708 resizing = True
709 d[9] = 6
710
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000711 def test_empty_presized_dict_in_freelist(self):
712 # Bug #3537: if an empty but presized dict with a size larger
713 # than 7 was in the freelist, it triggered an assertion failure
Florent Xiclunaa988e422010-03-02 16:06:24 +0000714 with self.assertRaises(ZeroDivisionError):
715 d = {'a': 1 // 0, 'b': None, 'c': None, 'd': None, 'e': None,
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000716 'f': None, 'g': None, 'h': None}
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000717 d = {}
718
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000719 def test_container_iterator(self):
720 # Bug #3680: tp_traverse was not implemented for dictiter and
721 # dictview objects.
722 class C(object):
723 pass
724 views = (dict.items, dict.values, dict.keys)
725 for v in views:
726 obj = C()
727 ref = weakref.ref(obj)
728 container = {obj: 1}
729 obj.v = v(container)
730 obj.x = iter(obj.v)
731 del obj, container
732 gc.collect()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000733 self.assertIs(ref(), None, "Cycle was not collected")
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000734
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000735 def _not_tracked(self, t):
736 # Nested containers can take several collections to untrack
737 gc.collect()
738 gc.collect()
739 self.assertFalse(gc.is_tracked(t), t)
740
741 def _tracked(self, t):
742 self.assertTrue(gc.is_tracked(t), t)
743 gc.collect()
744 gc.collect()
745 self.assertTrue(gc.is_tracked(t), t)
746
Benjamin Peterson3e5cd1d2010-06-27 21:45:24 +0000747 @support.cpython_only
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000748 def test_track_literals(self):
749 # Test GC-optimization of dict literals
750 x, y, z, w = 1.5, "a", (1, None), []
751
752 self._not_tracked({})
753 self._not_tracked({x:(), y:x, z:1})
754 self._not_tracked({1: "a", "b": 2})
755 self._not_tracked({1: 2, (None, True, False, ()): int})
756 self._not_tracked({1: object()})
757
758 # Dicts with mutable elements are always tracked, even if those
759 # elements are not tracked right now.
760 self._tracked({1: []})
761 self._tracked({1: ([],)})
762 self._tracked({1: {}})
763 self._tracked({1: set()})
764
Benjamin Peterson3e5cd1d2010-06-27 21:45:24 +0000765 @support.cpython_only
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000766 def test_track_dynamic(self):
767 # Test GC-optimization of dynamically-created dicts
768 class MyObject(object):
769 pass
770 x, y, z, w, o = 1.5, "a", (1, object()), [], MyObject()
771
772 d = dict()
773 self._not_tracked(d)
774 d[1] = "a"
775 self._not_tracked(d)
776 d[y] = 2
777 self._not_tracked(d)
778 d[z] = 3
779 self._not_tracked(d)
780 self._not_tracked(d.copy())
781 d[4] = w
782 self._tracked(d)
783 self._tracked(d.copy())
784 d[4] = None
785 self._not_tracked(d)
786 self._not_tracked(d.copy())
787
788 # dd isn't tracked right now, but it may mutate and therefore d
789 # which contains it must be tracked.
790 d = dict()
791 dd = dict()
792 d[1] = dd
793 self._not_tracked(dd)
794 self._tracked(d)
795 dd[1] = d
796 self._tracked(dd)
797
798 d = dict.fromkeys([x, y, z])
799 self._not_tracked(d)
800 dd = dict()
801 dd.update(d)
802 self._not_tracked(dd)
803 d = dict.fromkeys([x, y, z, o])
804 self._tracked(d)
805 dd = dict()
806 dd.update(d)
807 self._tracked(dd)
808
809 d = dict(x=x, y=y, z=z)
810 self._not_tracked(d)
811 d = dict(x=x, y=y, z=z, w=w)
812 self._tracked(d)
813 d = dict()
814 d.update(x=x, y=y, z=z)
815 self._not_tracked(d)
816 d.update(w=w)
817 self._tracked(d)
818
819 d = dict([(x, y), (z, 1)])
820 self._not_tracked(d)
821 d = dict([(x, y), (z, w)])
822 self._tracked(d)
823 d = dict()
824 d.update([(x, y), (z, 1)])
825 self._not_tracked(d)
826 d.update([(x, y), (z, w)])
827 self._tracked(d)
828
Benjamin Peterson3e5cd1d2010-06-27 21:45:24 +0000829 @support.cpython_only
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000830 def test_track_subtypes(self):
831 # Dict subtypes are always tracked
832 class MyDict(dict):
833 pass
834 self._tracked(MyDict())
835
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000836 def test_iterator_pickling(self):
837 data = {1:"a", 2:"b", 3:"c"}
838 it = iter(data)
839 d = pickle.dumps(it)
840 it = pickle.loads(d)
841 self.assertEqual(sorted(it), sorted(data))
842
843 it = pickle.loads(d)
844 try:
845 drop = next(it)
846 except StopIteration:
847 return
848 d = pickle.dumps(it)
849 it = pickle.loads(d)
850 del data[drop]
851 self.assertEqual(sorted(it), sorted(data))
852
853 def test_itemiterator_pickling(self):
854 data = {1:"a", 2:"b", 3:"c"}
855 # dictviews aren't picklable, only their iterators
856 itorg = iter(data.items())
857 d = pickle.dumps(itorg)
858 it = pickle.loads(d)
859 # note that the type of type of the unpickled iterator
860 # is not necessarily the same as the original. It is
861 # merely an object supporting the iterator protocol, yielding
862 # the same objects as the original one.
863 # self.assertEqual(type(itorg), type(it))
864 self.assertTrue(isinstance(it, collections.abc.Iterator))
865 self.assertEqual(dict(it), data)
866
867 it = pickle.loads(d)
868 drop = next(it)
869 d = pickle.dumps(it)
870 it = pickle.loads(d)
871 del data[drop[0]]
872 self.assertEqual(dict(it), data)
873
874 def test_valuesiterator_pickling(self):
875 data = {1:"a", 2:"b", 3:"c"}
876 # data.values() isn't picklable, only its iterator
877 it = iter(data.values())
878 d = pickle.dumps(it)
879 it = pickle.loads(d)
880 self.assertEqual(sorted(list(it)), sorted(list(data.values())))
881
882 it = pickle.loads(d)
883 drop = next(it)
884 d = pickle.dumps(it)
885 it = pickle.loads(d)
886 values = list(it) + [drop]
887 self.assertEqual(sorted(values), sorted(list(data.values())))
Guido van Rossum1968ad32006-02-25 22:38:04 +0000888
Benjamin Petersondb780d02012-04-23 13:44:32 -0400889 def test_instance_dict_getattr_str_subclass(self):
890 class Foo:
891 def __init__(self, msg):
892 self.msg = msg
893 f = Foo('123')
894 class _str(str):
895 pass
896 self.assertEqual(f.msg, getattr(f, _str('msg')))
897 self.assertEqual(f.msg, f.__dict__[_str('msg')])
898
Benjamin Peterson15ee8212012-04-24 14:44:18 -0400899 def test_object_set_item_single_instance_non_str_key(self):
900 class Foo: pass
901 f = Foo()
902 f.__dict__[1] = 1
903 f.a = 'a'
904 self.assertEqual(f.__dict__, {1:1, 'a':'a'})
905
Neal Norwitzc3e54b82006-03-24 07:38:37 +0000906from test import mapping_tests
Raymond Hettinger49c522b2004-09-30 15:07:29 +0000907
908class GeneralMappingTests(mapping_tests.BasicTestMappingProtocol):
909 type2test = dict
910
911class Dict(dict):
912 pass
913
914class SubclassMappingTests(mapping_tests.BasicTestMappingProtocol):
915 type2test = Dict
916
Walter Dörwald59b23e82004-09-30 13:46:00 +0000917def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000918 support.run_unittest(
Walter Dörwald59b23e82004-09-30 13:46:00 +0000919 DictTest,
Raymond Hettinger49c522b2004-09-30 15:07:29 +0000920 GeneralMappingTests,
921 SubclassMappingTests,
Walter Dörwald59b23e82004-09-30 13:46:00 +0000922 )
923
924if __name__ == "__main__":
925 test_main()