blob: 426f76e9e8c4a9b4ba35cb27f7c287898a6a0d11 [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
Walter Dörwald59b23e82004-09-30 13:46:00 +0000259 def test_copy(self):
260 d = {1:1, 2:2, 3:3}
261 self.assertEqual(d.copy(), {1:1, 2:2, 3:3})
262 self.assertEqual({}.copy(), {})
263 self.assertRaises(TypeError, d.copy, None)
264
265 def test_get(self):
266 d = {}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000267 self.assertIs(d.get('c'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000268 self.assertEqual(d.get('c', 3), 3)
Florent Xiclunaa988e422010-03-02 16:06:24 +0000269 d = {'a': 1, 'b': 2}
270 self.assertIs(d.get('c'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000271 self.assertEqual(d.get('c', 3), 3)
272 self.assertEqual(d.get('a'), 1)
273 self.assertEqual(d.get('a', 3), 1)
274 self.assertRaises(TypeError, d.get)
275 self.assertRaises(TypeError, d.get, None, None, None)
276
277 def test_setdefault(self):
278 # dict.setdefault()
279 d = {}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000280 self.assertIs(d.setdefault('key0'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000281 d.setdefault('key0', [])
Florent Xiclunaa988e422010-03-02 16:06:24 +0000282 self.assertIs(d.setdefault('key0'), None)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000283 d.setdefault('key', []).append(3)
284 self.assertEqual(d['key'][0], 3)
285 d.setdefault('key', []).append(4)
286 self.assertEqual(len(d['key']), 2)
287 self.assertRaises(TypeError, d.setdefault)
288
289 class Exc(Exception): pass
290
291 class BadHash(object):
292 fail = False
293 def __hash__(self):
294 if self.fail:
295 raise Exc()
296 else:
297 return 42
298
299 x = BadHash()
300 d[x] = 42
301 x.fail = True
302 self.assertRaises(Exc, d.setdefault, x, [])
303
Antoine Pitroue965d972012-02-27 00:45:12 +0100304 def test_setdefault_atomic(self):
305 # Issue #13521: setdefault() calls __hash__ and __eq__ only once.
306 class Hashed(object):
307 def __init__(self):
308 self.hash_count = 0
309 self.eq_count = 0
310 def __hash__(self):
311 self.hash_count += 1
312 return 42
313 def __eq__(self, other):
314 self.eq_count += 1
315 return id(self) == id(other)
316 hashed1 = Hashed()
317 y = {hashed1: 5}
318 hashed2 = Hashed()
319 y.setdefault(hashed2, [])
320 self.assertEqual(hashed1.hash_count, 1)
321 self.assertEqual(hashed2.hash_count, 1)
322 self.assertEqual(hashed1.eq_count + hashed2.eq_count, 1)
323
Benjamin Peterson7d95e402012-04-23 11:24:50 -0400324 def test_setitem_atomic_at_resize(self):
325 class Hashed(object):
326 def __init__(self):
327 self.hash_count = 0
328 self.eq_count = 0
329 def __hash__(self):
330 self.hash_count += 1
331 return 42
332 def __eq__(self, other):
333 self.eq_count += 1
334 return id(self) == id(other)
335 hashed1 = Hashed()
336 # 5 items
337 y = {hashed1: 5, 0: 0, 1: 1, 2: 2, 3: 3}
338 hashed2 = Hashed()
339 # 6th item forces a resize
340 y[hashed2] = []
341 self.assertEqual(hashed1.hash_count, 1)
342 self.assertEqual(hashed2.hash_count, 1)
343 self.assertEqual(hashed1.eq_count + hashed2.eq_count, 1)
344
Walter Dörwald59b23e82004-09-30 13:46:00 +0000345 def test_popitem(self):
346 # dict.popitem()
347 for copymode in -1, +1:
348 # -1: b has same structure as a
349 # +1: b is a.copy()
350 for log2size in range(12):
351 size = 2**log2size
352 a = {}
353 b = {}
354 for i in range(size):
355 a[repr(i)] = i
356 if copymode < 0:
357 b[repr(i)] = i
358 if copymode > 0:
359 b = a.copy()
360 for i in range(size):
361 ka, va = ta = a.popitem()
362 self.assertEqual(va, int(ka))
363 kb, vb = tb = b.popitem()
364 self.assertEqual(vb, int(kb))
Florent Xiclunaa988e422010-03-02 16:06:24 +0000365 self.assertFalse(copymode < 0 and ta != tb)
366 self.assertFalse(a)
367 self.assertFalse(b)
Walter Dörwald59b23e82004-09-30 13:46:00 +0000368
369 d = {}
370 self.assertRaises(KeyError, d.popitem)
371
372 def test_pop(self):
373 # Tests for pop with specified key
374 d = {}
375 k, v = 'abc', 'def'
376 d[k] = v
377 self.assertRaises(KeyError, d.pop, 'ghi')
378
379 self.assertEqual(d.pop(k), v)
380 self.assertEqual(len(d), 0)
381
382 self.assertRaises(KeyError, d.pop, k)
383
Walter Dörwald59b23e82004-09-30 13:46:00 +0000384 self.assertEqual(d.pop(k, v), v)
385 d[k] = v
386 self.assertEqual(d.pop(k, 1), v)
387
388 self.assertRaises(TypeError, d.pop)
389
390 class Exc(Exception): pass
391
392 class BadHash(object):
393 fail = False
394 def __hash__(self):
395 if self.fail:
396 raise Exc()
397 else:
398 return 42
399
400 x = BadHash()
401 d[x] = 42
402 x.fail = True
403 self.assertRaises(Exc, d.pop, x)
404
Victor Stinner198b2912012-03-06 01:03:13 +0100405 def test_mutating_iteration(self):
Florent Xiclunaa988e422010-03-02 16:06:24 +0000406 # changing dict size during iteration
Walter Dörwald59b23e82004-09-30 13:46:00 +0000407 d = {}
408 d[1] = 1
Florent Xiclunaa988e422010-03-02 16:06:24 +0000409 with self.assertRaises(RuntimeError):
Walter Dörwald59b23e82004-09-30 13:46:00 +0000410 for i in d:
411 d[i+1] = 1
Walter Dörwald59b23e82004-09-30 13:46:00 +0000412
Victor Stinner198b2912012-03-06 01:03:13 +0100413 def test_mutating_lookup(self):
414 # changing dict during a lookup
415 class NastyKey:
416 mutate_dict = None
417
Victor Stinner28393822012-03-09 22:58:51 +0100418 def __init__(self, value):
419 self.value = value
420
Victor Stinner198b2912012-03-06 01:03:13 +0100421 def __hash__(self):
422 # hash collision!
423 return 1
424
425 def __eq__(self, other):
Victor Stinner28393822012-03-09 22:58:51 +0100426 if NastyKey.mutate_dict:
427 mydict, key = NastyKey.mutate_dict
428 NastyKey.mutate_dict = None
429 del mydict[key]
430 return self.value == other.value
Victor Stinner198b2912012-03-06 01:03:13 +0100431
Victor Stinner28393822012-03-09 22:58:51 +0100432 key1 = NastyKey(1)
433 key2 = NastyKey(2)
434 d = {key1: 1}
435 NastyKey.mutate_dict = (d, key1)
436 with self.assertRaisesRegex(RuntimeError,
437 'dictionary changed size during lookup'):
438 d[key2] = 2
Victor Stinner198b2912012-03-06 01:03:13 +0100439
Walter Dörwald59b23e82004-09-30 13:46:00 +0000440 def test_repr(self):
441 d = {}
442 self.assertEqual(repr(d), '{}')
443 d[1] = 2
444 self.assertEqual(repr(d), '{1: 2}')
445 d = {}
446 d[1] = d
447 self.assertEqual(repr(d), '{1: {...}}')
448
449 class Exc(Exception): pass
450
451 class BadRepr(object):
452 def __repr__(self):
453 raise Exc()
454
455 d = {1: BadRepr()}
456 self.assertRaises(Exc, repr, d)
457
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000458 def test_eq(self):
459 self.assertEqual({}, {})
Guido van Rossume2a383d2007-01-15 16:59:06 +0000460 self.assertEqual({1: 2}, {1: 2})
Walter Dörwald59b23e82004-09-30 13:46:00 +0000461
462 class Exc(Exception): pass
463
464 class BadCmp(object):
465 def __eq__(self, other):
466 raise Exc()
Guido van Rossum38938152006-08-21 23:36:26 +0000467 def __hash__(self):
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000468 return 1
Walter Dörwald59b23e82004-09-30 13:46:00 +0000469
470 d1 = {BadCmp(): 1}
471 d2 = {1: 1}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000472
473 with self.assertRaises(Exc):
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000474 d1 == d2
Walter Dörwald59b23e82004-09-30 13:46:00 +0000475
Guido van Rossumaac530c2007-08-24 22:33:45 +0000476 def test_keys_contained(self):
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000477 self.helper_keys_contained(lambda x: x.keys())
478 self.helper_keys_contained(lambda x: x.items())
479
480 def helper_keys_contained(self, fn):
Guido van Rossumaac530c2007-08-24 22:33:45 +0000481 # Test rich comparisons against dict key views, which should behave the
482 # same as sets.
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000483 empty = fn(dict())
484 empty2 = fn(dict())
485 smaller = fn({1:1, 2:2})
486 larger = fn({1:1, 2:2, 3:3})
487 larger2 = fn({1:1, 2:2, 3:3})
488 larger3 = fn({4:1, 2:2, 3:3})
Guido van Rossumaac530c2007-08-24 22:33:45 +0000489
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000490 self.assertTrue(smaller < larger)
491 self.assertTrue(smaller <= larger)
492 self.assertTrue(larger > smaller)
493 self.assertTrue(larger >= smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000494
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000495 self.assertFalse(smaller >= larger)
496 self.assertFalse(smaller > larger)
497 self.assertFalse(larger <= smaller)
498 self.assertFalse(larger < smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000499
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000500 self.assertFalse(smaller < larger3)
501 self.assertFalse(smaller <= larger3)
502 self.assertFalse(larger3 > smaller)
503 self.assertFalse(larger3 >= smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000504
505 # Inequality strictness
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000506 self.assertTrue(larger2 >= larger)
507 self.assertTrue(larger2 <= larger)
508 self.assertFalse(larger2 > larger)
509 self.assertFalse(larger2 < larger)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000510
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000511 self.assertTrue(larger == larger2)
512 self.assertTrue(smaller != larger)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000513
514 # There is an optimization on the zero-element case.
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000515 self.assertTrue(empty == empty2)
516 self.assertFalse(empty != empty2)
517 self.assertFalse(empty == smaller)
518 self.assertTrue(empty != smaller)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000519
520 # With the same size, an elementwise compare happens
Guido van Rossumcf2ce362007-08-24 23:49:54 +0000521 self.assertTrue(larger != larger3)
522 self.assertFalse(larger == larger3)
Guido van Rossumaac530c2007-08-24 22:33:45 +0000523
524 def test_errors_in_view_containment_check(self):
525 class C:
526 def __eq__(self, other):
527 raise RuntimeError
Florent Xiclunaa988e422010-03-02 16:06:24 +0000528
Guido van Rossumaac530c2007-08-24 22:33:45 +0000529 d1 = {1: C()}
530 d2 = {1: C()}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000531 with self.assertRaises(RuntimeError):
532 d1.items() == d2.items()
533 with self.assertRaises(RuntimeError):
534 d1.items() != d2.items()
535 with self.assertRaises(RuntimeError):
536 d1.items() <= d2.items()
537 with self.assertRaises(RuntimeError):
538 d1.items() >= d2.items()
539
Guido van Rossumaac530c2007-08-24 22:33:45 +0000540 d3 = {1: C(), 2: C()}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000541 with self.assertRaises(RuntimeError):
542 d2.items() < d3.items()
543 with self.assertRaises(RuntimeError):
544 d3.items() > d2.items()
Guido van Rossumaac530c2007-08-24 22:33:45 +0000545
Guido van Rossumbe534712007-08-24 23:43:52 +0000546 def test_dictview_set_operations_on_keys(self):
Guido van Rossum523259b2007-08-24 23:41:22 +0000547 k1 = {1:1, 2:2}.keys()
548 k2 = {1:1, 2:2, 3:3}.keys()
549 k3 = {4:4}.keys()
550
Florent Xiclunaa988e422010-03-02 16:06:24 +0000551 self.assertEqual(k1 - k2, set())
552 self.assertEqual(k1 - k3, {1,2})
553 self.assertEqual(k2 - k1, {3})
554 self.assertEqual(k3 - k1, {4})
555 self.assertEqual(k1 & k2, {1,2})
556 self.assertEqual(k1 & k3, set())
557 self.assertEqual(k1 | k2, {1,2,3})
558 self.assertEqual(k1 ^ k2, {3})
559 self.assertEqual(k1 ^ k3, {1,2,4})
Guido van Rossum523259b2007-08-24 23:41:22 +0000560
Guido van Rossumbe534712007-08-24 23:43:52 +0000561 def test_dictview_set_operations_on_items(self):
562 k1 = {1:1, 2:2}.items()
563 k2 = {1:1, 2:2, 3:3}.items()
564 k3 = {4:4}.items()
565
Florent Xiclunaa988e422010-03-02 16:06:24 +0000566 self.assertEqual(k1 - k2, set())
567 self.assertEqual(k1 - k3, {(1,1), (2,2)})
568 self.assertEqual(k2 - k1, {(3,3)})
569 self.assertEqual(k3 - k1, {(4,4)})
570 self.assertEqual(k1 & k2, {(1,1), (2,2)})
571 self.assertEqual(k1 & k3, set())
572 self.assertEqual(k1 | k2, {(1,1), (2,2), (3,3)})
573 self.assertEqual(k1 ^ k2, {(3,3)})
574 self.assertEqual(k1 ^ k3, {(1,1), (2,2), (4,4)})
Guido van Rossum523259b2007-08-24 23:41:22 +0000575
Guido van Rossum1d719962007-08-24 23:47:30 +0000576 def test_dictview_mixed_set_operations(self):
577 # Just a few for .keys()
Guido van Rossuma401bbe2007-08-24 23:51:55 +0000578 self.assertTrue({1:1}.keys() == {1})
579 self.assertTrue({1} == {1:1}.keys())
Florent Xiclunaa988e422010-03-02 16:06:24 +0000580 self.assertEqual({1:1}.keys() | {2}, {1, 2})
581 self.assertEqual({2} | {1:1}.keys(), {1, 2})
Guido van Rossum1d719962007-08-24 23:47:30 +0000582 # And a few for .items()
Guido van Rossuma401bbe2007-08-24 23:51:55 +0000583 self.assertTrue({1:1}.items() == {(1,1)})
584 self.assertTrue({(1,1)} == {1:1}.items())
Florent Xiclunaa988e422010-03-02 16:06:24 +0000585 self.assertEqual({1:1}.items() | {2}, {(1,1), 2})
586 self.assertEqual({2} | {1:1}.items(), {(1,1), 2})
Guido van Rossum1d719962007-08-24 23:47:30 +0000587
Guido van Rossum1968ad32006-02-25 22:38:04 +0000588 def test_missing(self):
589 # Make sure dict doesn't have a __missing__ method
Florent Xiclunaa988e422010-03-02 16:06:24 +0000590 self.assertFalse(hasattr(dict, "__missing__"))
591 self.assertFalse(hasattr({}, "__missing__"))
Guido van Rossum1968ad32006-02-25 22:38:04 +0000592 # Test several cases:
593 # (D) subclass defines __missing__ method returning a value
594 # (E) subclass defines __missing__ method raising RuntimeError
595 # (F) subclass sets __missing__ instance variable (no effect)
596 # (G) subclass doesn't define __missing__ at a all
597 class D(dict):
598 def __missing__(self, key):
599 return 42
600 d = D({1: 2, 3: 4})
601 self.assertEqual(d[1], 2)
602 self.assertEqual(d[3], 4)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000603 self.assertNotIn(2, d)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000604 self.assertNotIn(2, d.keys())
Guido van Rossum1968ad32006-02-25 22:38:04 +0000605 self.assertEqual(d[2], 42)
Florent Xiclunaa988e422010-03-02 16:06:24 +0000606
Guido van Rossum1968ad32006-02-25 22:38:04 +0000607 class E(dict):
608 def __missing__(self, key):
609 raise RuntimeError(key)
610 e = E()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000611 with self.assertRaises(RuntimeError) as c:
Guido van Rossum1968ad32006-02-25 22:38:04 +0000612 e[42]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000613 self.assertEqual(c.exception.args, (42,))
614
Guido van Rossum1968ad32006-02-25 22:38:04 +0000615 class F(dict):
616 def __init__(self):
617 # An instance variable __missing__ should have no effect
618 self.__missing__ = lambda key: None
619 f = F()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000620 with self.assertRaises(KeyError) as c:
Guido van Rossum1968ad32006-02-25 22:38:04 +0000621 f[42]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000622 self.assertEqual(c.exception.args, (42,))
623
Guido van Rossum1968ad32006-02-25 22:38:04 +0000624 class G(dict):
625 pass
626 g = G()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000627 with self.assertRaises(KeyError) as c:
Guido van Rossum1968ad32006-02-25 22:38:04 +0000628 g[42]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000629 self.assertEqual(c.exception.args, (42,))
Guido van Rossum1968ad32006-02-25 22:38:04 +0000630
Thomas Wouters89f507f2006-12-13 04:49:30 +0000631 def test_tuple_keyerror(self):
632 # SF #1576657
633 d = {}
Florent Xiclunaa988e422010-03-02 16:06:24 +0000634 with self.assertRaises(KeyError) as c:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000635 d[(1,)]
Florent Xiclunaa988e422010-03-02 16:06:24 +0000636 self.assertEqual(c.exception.args, ((1,),))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000637
Guido van Rossumd8faa362007-04-27 19:54:29 +0000638 def test_bad_key(self):
Mark Dickinsona56c4672009-01-27 18:17:45 +0000639 # Dictionary lookups should fail if __eq__() raises an exception.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000640 class CustomException(Exception):
641 pass
642
643 class BadDictKey:
644 def __hash__(self):
645 return hash(self.__class__)
646
647 def __eq__(self, other):
648 if isinstance(other, self.__class__):
649 raise CustomException
650 return other
651
652 d = {}
653 x1 = BadDictKey()
654 x2 = BadDictKey()
655 d[x1] = 1
656 for stmt in ['d[x2] = 2',
657 'z = d[x2]',
658 'x2 in d',
659 'd.get(x2)',
660 'd.setdefault(x2, 42)',
661 'd.pop(x2)',
662 'd.update({x2: 2})']:
Florent Xiclunaa988e422010-03-02 16:06:24 +0000663 with self.assertRaises(CustomException):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000664 exec(stmt, locals())
Guido van Rossumd8faa362007-04-27 19:54:29 +0000665
666 def test_resize1(self):
667 # Dict resizing bug, found by Jack Jansen in 2.2 CVS development.
668 # This version got an assert failure in debug build, infinite loop in
669 # release build. Unfortunately, provoking this kind of stuff requires
670 # a mix of inserts and deletes hitting exactly the right hash codes in
671 # exactly the right order, and I can't think of a randomized approach
672 # that would be *likely* to hit a failing case in reasonable time.
673
674 d = {}
675 for i in range(5):
676 d[i] = i
677 for i in range(5):
678 del d[i]
679 for i in range(5, 9): # i==8 was the problem
680 d[i] = i
681
682 def test_resize2(self):
683 # Another dict resizing bug (SF bug #1456209).
684 # This caused Segmentation faults or Illegal instructions.
685
686 class X(object):
687 def __hash__(self):
688 return 5
689 def __eq__(self, other):
690 if resizing:
691 d.clear()
692 return False
693 d = {}
694 resizing = False
695 d[X()] = 1
696 d[X()] = 2
697 d[X()] = 3
698 d[X()] = 4
699 d[X()] = 5
700 # now trigger a resize
701 resizing = True
702 d[9] = 6
703
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000704 def test_empty_presized_dict_in_freelist(self):
705 # Bug #3537: if an empty but presized dict with a size larger
706 # than 7 was in the freelist, it triggered an assertion failure
Florent Xiclunaa988e422010-03-02 16:06:24 +0000707 with self.assertRaises(ZeroDivisionError):
708 d = {'a': 1 // 0, 'b': None, 'c': None, 'd': None, 'e': None,
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000709 'f': None, 'g': None, 'h': None}
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000710 d = {}
711
Antoine Pitrou7ddda782009-01-01 15:35:33 +0000712 def test_container_iterator(self):
713 # Bug #3680: tp_traverse was not implemented for dictiter and
714 # dictview objects.
715 class C(object):
716 pass
717 views = (dict.items, dict.values, dict.keys)
718 for v in views:
719 obj = C()
720 ref = weakref.ref(obj)
721 container = {obj: 1}
722 obj.v = v(container)
723 obj.x = iter(obj.v)
724 del obj, container
725 gc.collect()
Florent Xiclunaa988e422010-03-02 16:06:24 +0000726 self.assertIs(ref(), None, "Cycle was not collected")
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000727
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000728 def _not_tracked(self, t):
729 # Nested containers can take several collections to untrack
730 gc.collect()
731 gc.collect()
732 self.assertFalse(gc.is_tracked(t), t)
733
734 def _tracked(self, t):
735 self.assertTrue(gc.is_tracked(t), t)
736 gc.collect()
737 gc.collect()
738 self.assertTrue(gc.is_tracked(t), t)
739
Benjamin Peterson3e5cd1d2010-06-27 21:45:24 +0000740 @support.cpython_only
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000741 def test_track_literals(self):
742 # Test GC-optimization of dict literals
743 x, y, z, w = 1.5, "a", (1, None), []
744
745 self._not_tracked({})
746 self._not_tracked({x:(), y:x, z:1})
747 self._not_tracked({1: "a", "b": 2})
748 self._not_tracked({1: 2, (None, True, False, ()): int})
749 self._not_tracked({1: object()})
750
751 # Dicts with mutable elements are always tracked, even if those
752 # elements are not tracked right now.
753 self._tracked({1: []})
754 self._tracked({1: ([],)})
755 self._tracked({1: {}})
756 self._tracked({1: set()})
757
Benjamin Peterson3e5cd1d2010-06-27 21:45:24 +0000758 @support.cpython_only
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000759 def test_track_dynamic(self):
760 # Test GC-optimization of dynamically-created dicts
761 class MyObject(object):
762 pass
763 x, y, z, w, o = 1.5, "a", (1, object()), [], MyObject()
764
765 d = dict()
766 self._not_tracked(d)
767 d[1] = "a"
768 self._not_tracked(d)
769 d[y] = 2
770 self._not_tracked(d)
771 d[z] = 3
772 self._not_tracked(d)
773 self._not_tracked(d.copy())
774 d[4] = w
775 self._tracked(d)
776 self._tracked(d.copy())
777 d[4] = None
778 self._not_tracked(d)
779 self._not_tracked(d.copy())
780
781 # dd isn't tracked right now, but it may mutate and therefore d
782 # which contains it must be tracked.
783 d = dict()
784 dd = dict()
785 d[1] = dd
786 self._not_tracked(dd)
787 self._tracked(d)
788 dd[1] = d
789 self._tracked(dd)
790
791 d = dict.fromkeys([x, y, z])
792 self._not_tracked(d)
793 dd = dict()
794 dd.update(d)
795 self._not_tracked(dd)
796 d = dict.fromkeys([x, y, z, o])
797 self._tracked(d)
798 dd = dict()
799 dd.update(d)
800 self._tracked(dd)
801
802 d = dict(x=x, y=y, z=z)
803 self._not_tracked(d)
804 d = dict(x=x, y=y, z=z, w=w)
805 self._tracked(d)
806 d = dict()
807 d.update(x=x, y=y, z=z)
808 self._not_tracked(d)
809 d.update(w=w)
810 self._tracked(d)
811
812 d = dict([(x, y), (z, 1)])
813 self._not_tracked(d)
814 d = dict([(x, y), (z, w)])
815 self._tracked(d)
816 d = dict()
817 d.update([(x, y), (z, 1)])
818 self._not_tracked(d)
819 d.update([(x, y), (z, w)])
820 self._tracked(d)
821
Benjamin Peterson3e5cd1d2010-06-27 21:45:24 +0000822 @support.cpython_only
Antoine Pitrou3a652b12009-03-23 18:52:06 +0000823 def test_track_subtypes(self):
824 # Dict subtypes are always tracked
825 class MyDict(dict):
826 pass
827 self._tracked(MyDict())
828
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +0000829 def test_iterator_pickling(self):
830 data = {1:"a", 2:"b", 3:"c"}
831 it = iter(data)
832 d = pickle.dumps(it)
833 it = pickle.loads(d)
834 self.assertEqual(sorted(it), sorted(data))
835
836 it = pickle.loads(d)
837 try:
838 drop = next(it)
839 except StopIteration:
840 return
841 d = pickle.dumps(it)
842 it = pickle.loads(d)
843 del data[drop]
844 self.assertEqual(sorted(it), sorted(data))
845
846 def test_itemiterator_pickling(self):
847 data = {1:"a", 2:"b", 3:"c"}
848 # dictviews aren't picklable, only their iterators
849 itorg = iter(data.items())
850 d = pickle.dumps(itorg)
851 it = pickle.loads(d)
852 # note that the type of type of the unpickled iterator
853 # is not necessarily the same as the original. It is
854 # merely an object supporting the iterator protocol, yielding
855 # the same objects as the original one.
856 # self.assertEqual(type(itorg), type(it))
857 self.assertTrue(isinstance(it, collections.abc.Iterator))
858 self.assertEqual(dict(it), data)
859
860 it = pickle.loads(d)
861 drop = next(it)
862 d = pickle.dumps(it)
863 it = pickle.loads(d)
864 del data[drop[0]]
865 self.assertEqual(dict(it), data)
866
867 def test_valuesiterator_pickling(self):
868 data = {1:"a", 2:"b", 3:"c"}
869 # data.values() isn't picklable, only its iterator
870 it = iter(data.values())
871 d = pickle.dumps(it)
872 it = pickle.loads(d)
873 self.assertEqual(sorted(list(it)), sorted(list(data.values())))
874
875 it = pickle.loads(d)
876 drop = next(it)
877 d = pickle.dumps(it)
878 it = pickle.loads(d)
879 values = list(it) + [drop]
880 self.assertEqual(sorted(values), sorted(list(data.values())))
Guido van Rossum1968ad32006-02-25 22:38:04 +0000881
Benjamin Petersondb780d02012-04-23 13:44:32 -0400882 def test_instance_dict_getattr_str_subclass(self):
883 class Foo:
884 def __init__(self, msg):
885 self.msg = msg
886 f = Foo('123')
887 class _str(str):
888 pass
889 self.assertEqual(f.msg, getattr(f, _str('msg')))
890 self.assertEqual(f.msg, f.__dict__[_str('msg')])
891
Benjamin Peterson15ee8212012-04-24 14:44:18 -0400892 def test_object_set_item_single_instance_non_str_key(self):
893 class Foo: pass
894 f = Foo()
895 f.__dict__[1] = 1
896 f.a = 'a'
897 self.assertEqual(f.__dict__, {1:1, 'a':'a'})
898
Neal Norwitzc3e54b82006-03-24 07:38:37 +0000899from test import mapping_tests
Raymond Hettinger49c522b2004-09-30 15:07:29 +0000900
901class GeneralMappingTests(mapping_tests.BasicTestMappingProtocol):
902 type2test = dict
903
904class Dict(dict):
905 pass
906
907class SubclassMappingTests(mapping_tests.BasicTestMappingProtocol):
908 type2test = Dict
909
Walter Dörwald59b23e82004-09-30 13:46:00 +0000910def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000911 support.run_unittest(
Walter Dörwald59b23e82004-09-30 13:46:00 +0000912 DictTest,
Raymond Hettinger49c522b2004-09-30 15:07:29 +0000913 GeneralMappingTests,
914 SubclassMappingTests,
Walter Dörwald59b23e82004-09-30 13:46:00 +0000915 )
916
917if __name__ == "__main__":
918 test_main()