blob: 5a5f86074d8b9e2a5872191c669e343b27ebbd1b [file] [log] [blame]
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001
Guido van Rossum2bc13791999-03-24 19:06:42 +00002/* Dictionary object implementation using a hash table */
Guido van Rossum9bfef441993-03-29 10:43:31 +00003
Raymond Hettinger930427b2003-05-03 06:51:59 +00004/* The distribution includes a separate file, Objects/dictnotes.txt,
Tim Peters60b29962006-01-01 01:19:23 +00005 describing explorations into dictionary design and optimization.
Raymond Hettinger930427b2003-05-03 06:51:59 +00006 It covers typical dictionary use patterns, the parameters for
7 tuning dictionaries, and several ideas for possible optimizations.
8*/
9
Guido van Rossumc0b618a1997-05-02 03:12:38 +000010#include "Python.h"
Guido van Rossum4b1302b1993-03-27 18:11:32 +000011
Tim Peters6d6c1a32001-08-02 04:15:00 +000012typedef PyDictEntry dictentry;
13typedef PyDictObject dictobject;
Guido van Rossum16e93a81997-01-28 00:00:11 +000014
Georg Brandlb9f4ad32006-10-29 18:31:42 +000015/* Set a key error with the specified argument, wrapping it in a
16 * tuple automatically so that tuple keys are not unpacked as the
17 * exception arguments. */
18static void
19set_key_error(PyObject *arg)
20{
21 PyObject *tup;
22 tup = PyTuple_Pack(1, arg);
23 if (!tup)
24 return; /* caller will expect error to be set anyway */
25 PyErr_SetObject(PyExc_KeyError, tup);
Neal Norwitz7b932da2006-10-29 23:39:03 +000026 Py_DECREF(tup);
Georg Brandlb9f4ad32006-10-29 18:31:42 +000027}
28
Tim Peterseb28ef22001-06-02 05:27:19 +000029/* Define this out if you don't want conversion statistics on exit. */
Fred Drake1bff34a2000-08-31 19:31:38 +000030#undef SHOW_CONVERSION_COUNTS
31
Tim Peterseb28ef22001-06-02 05:27:19 +000032/* See large comment block below. This must be >= 1. */
33#define PERTURB_SHIFT 5
34
Guido van Rossum16e93a81997-01-28 00:00:11 +000035/*
Tim Peterseb28ef22001-06-02 05:27:19 +000036Major subtleties ahead: Most hash schemes depend on having a "good" hash
37function, in the sense of simulating randomness. Python doesn't: its most
38important hash functions (for strings and ints) are very regular in common
39cases:
Tim Peters15d49292001-05-27 07:39:22 +000040
Tim Peterseb28ef22001-06-02 05:27:19 +000041>>> map(hash, (0, 1, 2, 3))
42[0, 1, 2, 3]
43>>> map(hash, ("namea", "nameb", "namec", "named"))
44[-1658398457, -1658398460, -1658398459, -1658398462]
45>>>
Tim Peters15d49292001-05-27 07:39:22 +000046
Tim Peterseb28ef22001-06-02 05:27:19 +000047This isn't necessarily bad! To the contrary, in a table of size 2**i, taking
48the low-order i bits as the initial table index is extremely fast, and there
49are no collisions at all for dicts indexed by a contiguous range of ints.
50The same is approximately true when keys are "consecutive" strings. So this
51gives better-than-random behavior in common cases, and that's very desirable.
Tim Peters15d49292001-05-27 07:39:22 +000052
Tim Peterseb28ef22001-06-02 05:27:19 +000053OTOH, when collisions occur, the tendency to fill contiguous slices of the
54hash table makes a good collision resolution strategy crucial. Taking only
55the last i bits of the hash code is also vulnerable: for example, consider
56[i << 16 for i in range(20000)] as a set of keys. Since ints are their own
57hash codes, and this fits in a dict of size 2**15, the last 15 bits of every
58hash code are all 0: they *all* map to the same table index.
Tim Peters15d49292001-05-27 07:39:22 +000059
Tim Peterseb28ef22001-06-02 05:27:19 +000060But catering to unusual cases should not slow the usual ones, so we just take
61the last i bits anyway. It's up to collision resolution to do the rest. If
62we *usually* find the key we're looking for on the first try (and, it turns
63out, we usually do -- the table load factor is kept under 2/3, so the odds
64are solidly in our favor), then it makes best sense to keep the initial index
65computation dirt cheap.
Tim Peters15d49292001-05-27 07:39:22 +000066
Tim Peterseb28ef22001-06-02 05:27:19 +000067The first half of collision resolution is to visit table indices via this
68recurrence:
Tim Peters15d49292001-05-27 07:39:22 +000069
Tim Peterseb28ef22001-06-02 05:27:19 +000070 j = ((5*j) + 1) mod 2**i
Tim Peters15d49292001-05-27 07:39:22 +000071
Tim Peterseb28ef22001-06-02 05:27:19 +000072For any initial j in range(2**i), repeating that 2**i times generates each
73int in range(2**i) exactly once (see any text on random-number generation for
74proof). By itself, this doesn't help much: like linear probing (setting
75j += 1, or j -= 1, on each loop trip), it scans the table entries in a fixed
76order. This would be bad, except that's not the only thing we do, and it's
77actually *good* in the common cases where hash keys are consecutive. In an
78example that's really too small to make this entirely clear, for a table of
79size 2**3 the order of indices is:
Tim Peters15d49292001-05-27 07:39:22 +000080
Tim Peterseb28ef22001-06-02 05:27:19 +000081 0 -> 1 -> 6 -> 7 -> 4 -> 5 -> 2 -> 3 -> 0 [and here it's repeating]
82
83If two things come in at index 5, the first place we look after is index 2,
84not 6, so if another comes in at index 6 the collision at 5 didn't hurt it.
85Linear probing is deadly in this case because there the fixed probe order
86is the *same* as the order consecutive keys are likely to arrive. But it's
87extremely unlikely hash codes will follow a 5*j+1 recurrence by accident,
88and certain that consecutive hash codes do not.
89
90The other half of the strategy is to get the other bits of the hash code
91into play. This is done by initializing a (unsigned) vrbl "perturb" to the
92full hash code, and changing the recurrence to:
93
94 j = (5*j) + 1 + perturb;
95 perturb >>= PERTURB_SHIFT;
96 use j % 2**i as the next table index;
97
98Now the probe sequence depends (eventually) on every bit in the hash code,
99and the pseudo-scrambling property of recurring on 5*j+1 is more valuable,
100because it quickly magnifies small differences in the bits that didn't affect
101the initial index. Note that because perturb is unsigned, if the recurrence
102is executed often enough perturb eventually becomes and remains 0. At that
103point (very rarely reached) the recurrence is on (just) 5*j+1 again, and
104that's certain to find an empty slot eventually (since it generates every int
105in range(2**i), and we make sure there's always at least one empty slot).
106
107Selecting a good value for PERTURB_SHIFT is a balancing act. You want it
108small so that the high bits of the hash code continue to affect the probe
109sequence across iterations; but you want it large so that in really bad cases
110the high-order hash bits have an effect on early iterations. 5 was "the
111best" in minimizing total collisions across experiments Tim Peters ran (on
112both normal and pathological cases), but 4 and 6 weren't significantly worse.
113
114Historical: Reimer Behrends contributed the idea of using a polynomial-based
115approach, using repeated multiplication by x in GF(2**n) where an irreducible
116polynomial for each table size was chosen such that x was a primitive root.
117Christian Tismer later extended that to use division by x instead, as an
118efficient way to get the high bits of the hash code into play. This scheme
119also gave excellent collision statistics, but was more expensive: two
120if-tests were required inside the loop; computing "the next" index took about
121the same number of operations but without as much potential parallelism
122(e.g., computing 5*j can go on at the same time as computing 1+perturb in the
123above, and then shifting perturb can be done while the table index is being
124masked); and the dictobject struct required a member to hold the table's
125polynomial. In Tim's experiments the current scheme ran faster, produced
126equally good collision statistics, needed less code & used less memory.
Tim Peters9b10f7e2006-05-30 04:16:25 +0000127
128Theoretical Python 2.5 headache: hash codes are only C "long", but
129sizeof(Py_ssize_t) > sizeof(long) may be possible. In that case, and if a
130dict is genuinely huge, then only the slots directly reachable via indexing
131by a C long can be the first slot in a probe sequence. The probe sequence
132will still eventually reach every slot in the table, but the collision rate
133on initial probes may be much higher than this scheme was designed for.
134Getting a hash code as fat as Py_ssize_t is the only real cure. But in
135practice, this probably won't make a lick of difference for many years (at
136which point everyone will have terabytes of RAM on 64-bit boxes).
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000137*/
Tim Petersdea48ec2001-05-22 20:40:22 +0000138
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000139/* Object used as dummy key to fill deleted entries */
Raymond Hettingerf81e4502005-08-17 02:19:36 +0000140static PyObject *dummy = NULL; /* Initialized by first call to newdictobject() */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000141
Armin Rigoe1709372006-04-12 17:06:05 +0000142#ifdef Py_REF_DEBUG
143PyObject *
144_PyDict_Dummy(void)
145{
146 return dummy;
147}
148#endif
149
Fred Drake1bff34a2000-08-31 19:31:38 +0000150/* forward declarations */
151static dictentry *
152lookdict_string(dictobject *mp, PyObject *key, long hash);
153
154#ifdef SHOW_CONVERSION_COUNTS
155static long created = 0L;
156static long converted = 0L;
157
158static void
159show_counts(void)
160{
161 fprintf(stderr, "created %ld string dicts\n", created);
162 fprintf(stderr, "converted %ld to normal dicts\n", converted);
163 fprintf(stderr, "%.2f%% conversion rate\n", (100.0*converted)/created);
164}
165#endif
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000166
Tim Peters6d6c1a32001-08-02 04:15:00 +0000167/* Initialization macros.
168 There are two ways to create a dict: PyDict_New() is the main C API
169 function, and the tp_new slot maps to dict_new(). In the latter case we
170 can save a little time over what PyDict_New does because it's guaranteed
171 that the PyDictObject struct is already zeroed out.
172 Everyone except dict_new() should use EMPTY_TO_MINSIZE (unless they have
173 an excellent reason not to).
174*/
175
176#define INIT_NONZERO_DICT_SLOTS(mp) do { \
Tim Petersdea48ec2001-05-22 20:40:22 +0000177 (mp)->ma_table = (mp)->ma_smalltable; \
Tim Peters6d6c1a32001-08-02 04:15:00 +0000178 (mp)->ma_mask = PyDict_MINSIZE - 1; \
179 } while(0)
180
181#define EMPTY_TO_MINSIZE(mp) do { \
182 memset((mp)->ma_smalltable, 0, sizeof((mp)->ma_smalltable)); \
Tim Petersdea48ec2001-05-22 20:40:22 +0000183 (mp)->ma_used = (mp)->ma_fill = 0; \
Tim Peters6d6c1a32001-08-02 04:15:00 +0000184 INIT_NONZERO_DICT_SLOTS(mp); \
Tim Petersdea48ec2001-05-22 20:40:22 +0000185 } while(0)
186
Raymond Hettinger43442782004-03-17 21:55:03 +0000187/* Dictionary reuse scheme to save calls to malloc, free, and memset */
188#define MAXFREEDICTS 80
189static PyDictObject *free_dicts[MAXFREEDICTS];
190static int num_free_dicts = 0;
191
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000192PyObject *
Thomas Wouters78890102000-07-22 19:25:51 +0000193PyDict_New(void)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000194{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000195 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000196 if (dummy == NULL) { /* Auto-initialize dummy */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000197 dummy = PyString_FromString("<dummy key>");
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000198 if (dummy == NULL)
199 return NULL;
Fred Drake1bff34a2000-08-31 19:31:38 +0000200#ifdef SHOW_CONVERSION_COUNTS
201 Py_AtExit(show_counts);
202#endif
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000203 }
Raymond Hettinger43442782004-03-17 21:55:03 +0000204 if (num_free_dicts) {
205 mp = free_dicts[--num_free_dicts];
206 assert (mp != NULL);
207 assert (mp->ob_type == &PyDict_Type);
208 _Py_NewReference((PyObject *)mp);
209 if (mp->ma_fill) {
210 EMPTY_TO_MINSIZE(mp);
211 }
212 assert (mp->ma_used == 0);
213 assert (mp->ma_table == mp->ma_smalltable);
214 assert (mp->ma_mask == PyDict_MINSIZE - 1);
215 } else {
216 mp = PyObject_GC_New(dictobject, &PyDict_Type);
217 if (mp == NULL)
218 return NULL;
219 EMPTY_TO_MINSIZE(mp);
220 }
Fred Drake1bff34a2000-08-31 19:31:38 +0000221 mp->ma_lookup = lookdict_string;
222#ifdef SHOW_CONVERSION_COUNTS
223 ++created;
224#endif
Neil Schemenauere83c00e2001-08-29 23:54:21 +0000225 _PyObject_GC_TRACK(mp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000226 return (PyObject *)mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000227}
228
229/*
230The basic lookup function used by all operations.
Guido van Rossum16e93a81997-01-28 00:00:11 +0000231This is based on Algorithm D from Knuth Vol. 3, Sec. 6.4.
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000232Open addressing is preferred over chaining since the link overhead for
233chaining would be substantial (100% with typical malloc overhead).
234
Tim Peterseb28ef22001-06-02 05:27:19 +0000235The initial probe index is computed as hash mod the table size. Subsequent
236probe indices are computed as explained earlier.
Guido van Rossum2bc13791999-03-24 19:06:42 +0000237
238All arithmetic on hash should ignore overflow.
Guido van Rossum16e93a81997-01-28 00:00:11 +0000239
Tim Peterseb28ef22001-06-02 05:27:19 +0000240(The details in this version are due to Tim Peters, building on many past
241contributions by Reimer Behrends, Jyrki Alakuijala, Vladimir Marangozov and
242Christian Tismer).
Fred Drake1bff34a2000-08-31 19:31:38 +0000243
Tim Petersd770ebd2006-06-01 15:50:44 +0000244lookdict() is general-purpose, and may return NULL if (and only if) a
245comparison raises an exception (this was new in Python 2.5).
246lookdict_string() below is specialized to string keys, comparison of which can
247never raise an exception; that function can never return NULL. For both, when
248the key isn't found a dictentry* is returned for which the me_value field is
249NULL; this is the slot in the dict at which the key would have been found, and
250the caller can (if it wishes) add the <key, value> pair to the returned
251dictentry*.
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000252*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000253static dictentry *
Tim Peters1f5871e2000-07-04 17:44:48 +0000254lookdict(dictobject *mp, PyObject *key, register long hash)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000255{
Tim Petersd770ebd2006-06-01 15:50:44 +0000256 register size_t i;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000257 register size_t perturb;
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000258 register dictentry *freeslot;
Tim Petersd770ebd2006-06-01 15:50:44 +0000259 register size_t mask = (size_t)mp->ma_mask;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000260 dictentry *ep0 = mp->ma_table;
261 register dictentry *ep;
Fred Drakec88b99c2000-08-31 19:04:07 +0000262 register int cmp;
Tim Peters453163d2001-06-03 04:54:32 +0000263 PyObject *startkey;
Tim Peterseb28ef22001-06-02 05:27:19 +0000264
Tim Petersd770ebd2006-06-01 15:50:44 +0000265 i = (size_t)hash & mask;
Guido van Rossumefb46091997-01-29 15:53:56 +0000266 ep = &ep0[i];
Guido van Rossumc1c7b1a1998-10-06 16:01:14 +0000267 if (ep->me_key == NULL || ep->me_key == key)
Guido van Rossum7d181591997-01-16 21:06:45 +0000268 return ep;
Tim Peters7b5d0af2001-06-03 04:14:43 +0000269
Guido van Rossum16e93a81997-01-28 00:00:11 +0000270 if (ep->me_key == dummy)
Guido van Rossum7d181591997-01-16 21:06:45 +0000271 freeslot = ep;
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000272 else {
Fred Drakec88b99c2000-08-31 19:04:07 +0000273 if (ep->me_hash == hash) {
Tim Peters453163d2001-06-03 04:54:32 +0000274 startkey = ep->me_key;
275 cmp = PyObject_RichCompareBool(startkey, key, Py_EQ);
Tim Peters7b5d0af2001-06-03 04:14:43 +0000276 if (cmp < 0)
Armin Rigo35f6d362006-06-01 13:19:12 +0000277 return NULL;
Tim Peters453163d2001-06-03 04:54:32 +0000278 if (ep0 == mp->ma_table && ep->me_key == startkey) {
279 if (cmp > 0)
Armin Rigo35f6d362006-06-01 13:19:12 +0000280 return ep;
Tim Peters453163d2001-06-03 04:54:32 +0000281 }
282 else {
283 /* The compare did major nasty stuff to the
284 * dict: start over.
285 * XXX A clever adversary could prevent this
286 * XXX from terminating.
287 */
Armin Rigo35f6d362006-06-01 13:19:12 +0000288 return lookdict(mp, key, hash);
Tim Peters453163d2001-06-03 04:54:32 +0000289 }
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000290 }
291 freeslot = NULL;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000292 }
Tim Peters15d49292001-05-27 07:39:22 +0000293
Tim Peters342c65e2001-05-13 06:43:53 +0000294 /* In the loop, me_key == dummy is by far (factor of 100s) the
295 least likely outcome, so test for that last. */
Tim Peterseb28ef22001-06-02 05:27:19 +0000296 for (perturb = hash; ; perturb >>= PERTURB_SHIFT) {
297 i = (i << 2) + i + perturb + 1;
298 ep = &ep0[i & mask];
Armin Rigo35f6d362006-06-01 13:19:12 +0000299 if (ep->me_key == NULL)
300 return freeslot == NULL ? ep : freeslot;
Tim Peters7b5d0af2001-06-03 04:14:43 +0000301 if (ep->me_key == key)
Armin Rigo35f6d362006-06-01 13:19:12 +0000302 return ep;
Tim Peters7b5d0af2001-06-03 04:14:43 +0000303 if (ep->me_hash == hash && ep->me_key != dummy) {
Tim Peters453163d2001-06-03 04:54:32 +0000304 startkey = ep->me_key;
305 cmp = PyObject_RichCompareBool(startkey, key, Py_EQ);
Tim Peters7b5d0af2001-06-03 04:14:43 +0000306 if (cmp < 0)
Armin Rigo35f6d362006-06-01 13:19:12 +0000307 return NULL;
Tim Peters453163d2001-06-03 04:54:32 +0000308 if (ep0 == mp->ma_table && ep->me_key == startkey) {
309 if (cmp > 0)
Armin Rigo35f6d362006-06-01 13:19:12 +0000310 return ep;
Tim Peters453163d2001-06-03 04:54:32 +0000311 }
312 else {
313 /* The compare did major nasty stuff to the
314 * dict: start over.
315 * XXX A clever adversary could prevent this
316 * XXX from terminating.
317 */
Armin Rigo35f6d362006-06-01 13:19:12 +0000318 return lookdict(mp, key, hash);
Tim Peters453163d2001-06-03 04:54:32 +0000319 }
Guido van Rossum16e93a81997-01-28 00:00:11 +0000320 }
Tim Peters342c65e2001-05-13 06:43:53 +0000321 else if (ep->me_key == dummy && freeslot == NULL)
322 freeslot = ep;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000323 }
Neal Norwitza5ccda92006-10-28 21:16:54 +0000324 assert(0); /* NOT REACHED */
325 return 0;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000326}
327
328/*
Fred Drake1bff34a2000-08-31 19:31:38 +0000329 * Hacked up version of lookdict which can assume keys are always strings;
Tim Petersd770ebd2006-06-01 15:50:44 +0000330 * this assumption allows testing for errors during PyObject_RichCompareBool()
331 * to be dropped; string-string comparisons never raise exceptions. This also
332 * means we don't need to go through PyObject_RichCompareBool(); we can always
333 * use _PyString_Eq() directly.
Fred Drake1bff34a2000-08-31 19:31:38 +0000334 *
Tim Petersd770ebd2006-06-01 15:50:44 +0000335 * This is valuable because dicts with only string keys are very common.
Fred Drake1bff34a2000-08-31 19:31:38 +0000336 */
337static dictentry *
338lookdict_string(dictobject *mp, PyObject *key, register long hash)
339{
Tim Petersd770ebd2006-06-01 15:50:44 +0000340 register size_t i;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000341 register size_t perturb;
Fred Drake1bff34a2000-08-31 19:31:38 +0000342 register dictentry *freeslot;
Tim Petersd770ebd2006-06-01 15:50:44 +0000343 register size_t mask = (size_t)mp->ma_mask;
Fred Drake1bff34a2000-08-31 19:31:38 +0000344 dictentry *ep0 = mp->ma_table;
345 register dictentry *ep;
Fred Drake1bff34a2000-08-31 19:31:38 +0000346
Tim Peters0ab085c2001-09-14 00:25:33 +0000347 /* Make sure this function doesn't have to handle non-string keys,
348 including subclasses of str; e.g., one reason to subclass
349 strings is to override __eq__, and for speed we don't cater to
350 that here. */
351 if (!PyString_CheckExact(key)) {
Fred Drake1bff34a2000-08-31 19:31:38 +0000352#ifdef SHOW_CONVERSION_COUNTS
353 ++converted;
354#endif
355 mp->ma_lookup = lookdict;
356 return lookdict(mp, key, hash);
357 }
Tim Peters2f228e72001-05-13 00:19:31 +0000358 i = hash & mask;
Fred Drake1bff34a2000-08-31 19:31:38 +0000359 ep = &ep0[i];
360 if (ep->me_key == NULL || ep->me_key == key)
361 return ep;
362 if (ep->me_key == dummy)
363 freeslot = ep;
364 else {
Tim Petersd770ebd2006-06-01 15:50:44 +0000365 if (ep->me_hash == hash && _PyString_Eq(ep->me_key, key))
Fred Drake1bff34a2000-08-31 19:31:38 +0000366 return ep;
Fred Drake1bff34a2000-08-31 19:31:38 +0000367 freeslot = NULL;
368 }
Tim Peters15d49292001-05-27 07:39:22 +0000369
Tim Peters342c65e2001-05-13 06:43:53 +0000370 /* In the loop, me_key == dummy is by far (factor of 100s) the
371 least likely outcome, so test for that last. */
Tim Peterseb28ef22001-06-02 05:27:19 +0000372 for (perturb = hash; ; perturb >>= PERTURB_SHIFT) {
373 i = (i << 2) + i + perturb + 1;
374 ep = &ep0[i & mask];
Tim Peters342c65e2001-05-13 06:43:53 +0000375 if (ep->me_key == NULL)
376 return freeslot == NULL ? ep : freeslot;
377 if (ep->me_key == key
378 || (ep->me_hash == hash
379 && ep->me_key != dummy
Martin v. Löwiscd353062001-05-24 16:56:35 +0000380 && _PyString_Eq(ep->me_key, key)))
Fred Drake1bff34a2000-08-31 19:31:38 +0000381 return ep;
Tim Petersdea48ec2001-05-22 20:40:22 +0000382 if (ep->me_key == dummy && freeslot == NULL)
Tim Peters342c65e2001-05-13 06:43:53 +0000383 freeslot = ep;
Fred Drake1bff34a2000-08-31 19:31:38 +0000384 }
Neal Norwitza5ccda92006-10-28 21:16:54 +0000385 assert(0); /* NOT REACHED */
386 return 0;
Fred Drake1bff34a2000-08-31 19:31:38 +0000387}
388
389/*
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000390Internal routine to insert a new item into the table.
391Used both by the internal resize routine and by the public insert routine.
392Eats a reference to key and one to value.
Tim Petersd770ebd2006-06-01 15:50:44 +0000393Returns -1 if an error occurred, or 0 on success.
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000394*/
Armin Rigo35f6d362006-06-01 13:19:12 +0000395static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000396insertdict(register dictobject *mp, PyObject *key, long hash, PyObject *value)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000397{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000398 PyObject *old_value;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000399 register dictentry *ep;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000400 typedef PyDictEntry *(*lookupfunc)(PyDictObject *, PyObject *, long);
401
402 assert(mp->ma_lookup != NULL);
403 ep = mp->ma_lookup(mp, key, hash);
Armin Rigo35f6d362006-06-01 13:19:12 +0000404 if (ep == NULL) {
405 Py_DECREF(key);
406 Py_DECREF(value);
407 return -1;
408 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000409 if (ep->me_value != NULL) {
Guido van Rossumd7047b31995-01-02 19:07:15 +0000410 old_value = ep->me_value;
411 ep->me_value = value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000412 Py_DECREF(old_value); /* which **CAN** re-enter */
413 Py_DECREF(key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000414 }
415 else {
416 if (ep->me_key == NULL)
417 mp->ma_fill++;
Raymond Hettinger07ead172005-02-05 23:42:57 +0000418 else {
419 assert(ep->me_key == dummy);
420 Py_DECREF(dummy);
421 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000422 ep->me_key = key;
Tim Peters9b10f7e2006-05-30 04:16:25 +0000423 ep->me_hash = (Py_ssize_t)hash;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000424 ep->me_value = value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000425 mp->ma_used++;
426 }
Armin Rigo35f6d362006-06-01 13:19:12 +0000427 return 0;
428}
429
430/*
431Internal routine used by dictresize() to insert an item which is
432known to be absent from the dict. This routine also assumes that
433the dict contains no deleted entries. Besides the performance benefit,
434using insertdict() in dictresize() is dangerous (SF bug #1456209).
Tim Petersd770ebd2006-06-01 15:50:44 +0000435Note that no refcounts are changed by this routine; if needed, the caller
436is responsible for incref'ing `key` and `value`.
Armin Rigo35f6d362006-06-01 13:19:12 +0000437*/
438static void
439insertdict_clean(register dictobject *mp, PyObject *key, long hash,
440 PyObject *value)
441{
Tim Petersd770ebd2006-06-01 15:50:44 +0000442 register size_t i;
Armin Rigo35f6d362006-06-01 13:19:12 +0000443 register size_t perturb;
Tim Petersd770ebd2006-06-01 15:50:44 +0000444 register size_t mask = (size_t)mp->ma_mask;
Armin Rigo35f6d362006-06-01 13:19:12 +0000445 dictentry *ep0 = mp->ma_table;
446 register dictentry *ep;
447
448 i = hash & mask;
449 ep = &ep0[i];
450 for (perturb = hash; ep->me_key != NULL; perturb >>= PERTURB_SHIFT) {
451 i = (i << 2) + i + perturb + 1;
452 ep = &ep0[i & mask];
453 }
Tim Petersd770ebd2006-06-01 15:50:44 +0000454 assert(ep->me_value == NULL);
Armin Rigo35f6d362006-06-01 13:19:12 +0000455 mp->ma_fill++;
456 ep->me_key = key;
457 ep->me_hash = (Py_ssize_t)hash;
458 ep->me_value = value;
459 mp->ma_used++;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000460}
461
462/*
463Restructure the table by allocating a new table and reinserting all
464items again. When entries have been deleted, the new table may
465actually be smaller than the old one.
466*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000467static int
Tim Peters9b10f7e2006-05-30 04:16:25 +0000468dictresize(dictobject *mp, Py_ssize_t minused)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000469{
Tim Peters9b10f7e2006-05-30 04:16:25 +0000470 Py_ssize_t newsize;
Tim Peters0c6010b2001-05-23 23:33:57 +0000471 dictentry *oldtable, *newtable, *ep;
Tim Peters9b10f7e2006-05-30 04:16:25 +0000472 Py_ssize_t i;
Tim Peters0c6010b2001-05-23 23:33:57 +0000473 int is_oldtable_malloced;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000474 dictentry small_copy[PyDict_MINSIZE];
Tim Peters91a364d2001-05-19 07:04:38 +0000475
476 assert(minused >= 0);
Tim Peters0c6010b2001-05-23 23:33:57 +0000477
Tim Peterseb28ef22001-06-02 05:27:19 +0000478 /* Find the smallest table size > minused. */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000479 for (newsize = PyDict_MINSIZE;
Tim Peterseb28ef22001-06-02 05:27:19 +0000480 newsize <= minused && newsize > 0;
481 newsize <<= 1)
482 ;
483 if (newsize <= 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000484 PyErr_NoMemory();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000485 return -1;
486 }
Tim Peters0c6010b2001-05-23 23:33:57 +0000487
488 /* Get space for a new table. */
489 oldtable = mp->ma_table;
490 assert(oldtable != NULL);
491 is_oldtable_malloced = oldtable != mp->ma_smalltable;
492
Tim Peters6d6c1a32001-08-02 04:15:00 +0000493 if (newsize == PyDict_MINSIZE) {
Tim Petersf8a548c2001-05-24 16:26:40 +0000494 /* A large table is shrinking, or we can't get any smaller. */
Tim Petersdea48ec2001-05-22 20:40:22 +0000495 newtable = mp->ma_smalltable;
Tim Peters0c6010b2001-05-23 23:33:57 +0000496 if (newtable == oldtable) {
Tim Petersf8a548c2001-05-24 16:26:40 +0000497 if (mp->ma_fill == mp->ma_used) {
498 /* No dummies, so no point doing anything. */
Tim Peters0c6010b2001-05-23 23:33:57 +0000499 return 0;
Tim Petersf8a548c2001-05-24 16:26:40 +0000500 }
501 /* We're not going to resize it, but rebuild the
502 table anyway to purge old dummy entries.
503 Subtle: This is *necessary* if fill==size,
504 as lookdict needs at least one virgin slot to
505 terminate failing searches. If fill < size, it's
506 merely desirable, as dummies slow searches. */
507 assert(mp->ma_fill > mp->ma_used);
Tim Peters0c6010b2001-05-23 23:33:57 +0000508 memcpy(small_copy, oldtable, sizeof(small_copy));
509 oldtable = small_copy;
510 }
Tim Petersdea48ec2001-05-22 20:40:22 +0000511 }
512 else {
513 newtable = PyMem_NEW(dictentry, newsize);
514 if (newtable == NULL) {
515 PyErr_NoMemory();
516 return -1;
517 }
518 }
Tim Peters0c6010b2001-05-23 23:33:57 +0000519
520 /* Make the dict empty, using the new table. */
Tim Petersdea48ec2001-05-22 20:40:22 +0000521 assert(newtable != oldtable);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000522 mp->ma_table = newtable;
Tim Petersafb6ae82001-06-04 21:00:21 +0000523 mp->ma_mask = newsize - 1;
Tim Petersdea48ec2001-05-22 20:40:22 +0000524 memset(newtable, 0, sizeof(dictentry) * newsize);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000525 mp->ma_used = 0;
Tim Petersdea48ec2001-05-22 20:40:22 +0000526 i = mp->ma_fill;
527 mp->ma_fill = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000528
Tim Peters19283142001-05-17 22:25:34 +0000529 /* Copy the data over; this is refcount-neutral for active entries;
530 dummy entries aren't copied over, of course */
Tim Petersdea48ec2001-05-22 20:40:22 +0000531 for (ep = oldtable; i > 0; ep++) {
532 if (ep->me_value != NULL) { /* active entry */
533 --i;
Armin Rigo35f6d362006-06-01 13:19:12 +0000534 insertdict_clean(mp, ep->me_key, (long)ep->me_hash,
535 ep->me_value);
Tim Petersdea48ec2001-05-22 20:40:22 +0000536 }
Tim Peters19283142001-05-17 22:25:34 +0000537 else if (ep->me_key != NULL) { /* dummy entry */
Tim Petersdea48ec2001-05-22 20:40:22 +0000538 --i;
Tim Peters19283142001-05-17 22:25:34 +0000539 assert(ep->me_key == dummy);
540 Py_DECREF(ep->me_key);
Guido van Rossum255443b1998-04-10 22:47:14 +0000541 }
Tim Peters19283142001-05-17 22:25:34 +0000542 /* else key == value == NULL: nothing to do */
Guido van Rossumd7047b31995-01-02 19:07:15 +0000543 }
544
Tim Peters0c6010b2001-05-23 23:33:57 +0000545 if (is_oldtable_malloced)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000546 PyMem_DEL(oldtable);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000547 return 0;
548}
549
Tim Petersd770ebd2006-06-01 15:50:44 +0000550/* Note that, for historical reasons, PyDict_GetItem() suppresses all errors
551 * that may occur (originally dicts supported only string keys, and exceptions
552 * weren't possible). So, while the original intent was that a NULL return
Andrew M. Kuchling0067b5f2006-08-04 20:37:43 +0000553 * meant the key wasn't present, in reality it can mean that, or that an error
Tim Petersd770ebd2006-06-01 15:50:44 +0000554 * (suppressed) occurred while computing the key's hash, or that some error
555 * (suppressed) occurred when comparing keys in the dict's internal probe
556 * sequence. A nasty example of the latter is when a Python-coded comparison
557 * function hits a stack-depth error, which can cause this to return NULL
558 * even if the key is present.
559 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000560PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000561PyDict_GetItem(PyObject *op, PyObject *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000562{
563 long hash;
Fred Drake1bff34a2000-08-31 19:31:38 +0000564 dictobject *mp = (dictobject *)op;
Armin Rigo35f6d362006-06-01 13:19:12 +0000565 dictentry *ep;
566 PyThreadState *tstate;
Tim Petersd770ebd2006-06-01 15:50:44 +0000567 if (!PyDict_Check(op))
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000568 return NULL;
Tim Peters0ab085c2001-09-14 00:25:33 +0000569 if (!PyString_CheckExact(key) ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000570 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Guido van Rossumca756f21997-01-23 19:39:29 +0000571 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000572 hash = PyObject_Hash(key);
Guido van Rossum474b19e1998-05-14 01:00:51 +0000573 if (hash == -1) {
574 PyErr_Clear();
Guido van Rossumca756f21997-01-23 19:39:29 +0000575 return NULL;
Guido van Rossum474b19e1998-05-14 01:00:51 +0000576 }
Guido van Rossumca756f21997-01-23 19:39:29 +0000577 }
Armin Rigo35f6d362006-06-01 13:19:12 +0000578
579 /* We can arrive here with a NULL tstate during initialization:
580 try running "python -Wi" for an example related to string
581 interning. Let's just hope that no exception occurs then... */
Armin Rigoacd0d6d2006-06-10 10:57:40 +0000582 tstate = _PyThreadState_Current;
Armin Rigo35f6d362006-06-01 13:19:12 +0000583 if (tstate != NULL && tstate->curexc_type != NULL) {
584 /* preserve the existing exception */
585 PyObject *err_type, *err_value, *err_tb;
586 PyErr_Fetch(&err_type, &err_value, &err_tb);
587 ep = (mp->ma_lookup)(mp, key, hash);
588 /* ignore errors */
589 PyErr_Restore(err_type, err_value, err_tb);
590 if (ep == NULL)
591 return NULL;
592 }
593 else {
594 ep = (mp->ma_lookup)(mp, key, hash);
595 if (ep == NULL) {
596 PyErr_Clear();
597 return NULL;
598 }
599 }
600 return ep->me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000601}
602
Guido van Rossuma4dd0112001-04-15 22:16:26 +0000603/* CAUTION: PyDict_SetItem() must guarantee that it won't resize the
Tim Peters60b29962006-01-01 01:19:23 +0000604 * dictionary if it's merely replacing the value for an existing key.
605 * This means that it's safe to loop over a dictionary with PyDict_Next()
606 * and occasionally replace a value -- but you can't insert new keys or
607 * remove them.
Guido van Rossuma4dd0112001-04-15 22:16:26 +0000608 */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000609int
Tim Peters1f5871e2000-07-04 17:44:48 +0000610PyDict_SetItem(register PyObject *op, PyObject *key, PyObject *value)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000611{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000612 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000613 register long hash;
Tim Peters9b10f7e2006-05-30 04:16:25 +0000614 register Py_ssize_t n_used;
Guido van Rossuma4dd0112001-04-15 22:16:26 +0000615
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000616 if (!PyDict_Check(op)) {
617 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000618 return -1;
619 }
Neal Norwitz48808a12006-07-21 05:29:58 +0000620 assert(key);
621 assert(value);
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000622 mp = (dictobject *)op;
Tim Peters0ab085c2001-09-14 00:25:33 +0000623 if (PyString_CheckExact(key)) {
Guido van Rossum45ec02a2002-08-19 21:43:18 +0000624 hash = ((PyStringObject *)key)->ob_shash;
625 if (hash == -1)
626 hash = PyObject_Hash(key);
Guido van Rossum2a61e741997-01-18 07:55:05 +0000627 }
Tim Peters1f7df352002-03-29 03:29:08 +0000628 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000629 hash = PyObject_Hash(key);
Guido van Rossum2a61e741997-01-18 07:55:05 +0000630 if (hash == -1)
631 return -1;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000632 }
Tim Petersafb6ae82001-06-04 21:00:21 +0000633 assert(mp->ma_fill <= mp->ma_mask); /* at least one empty slot */
Guido van Rossuma4dd0112001-04-15 22:16:26 +0000634 n_used = mp->ma_used;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000635 Py_INCREF(value);
636 Py_INCREF(key);
Armin Rigo35f6d362006-06-01 13:19:12 +0000637 if (insertdict(mp, key, hash, value) != 0)
638 return -1;
Raymond Hettinger3539f6b2003-05-05 22:22:10 +0000639 /* If we added a key, we can safely resize. Otherwise just return!
640 * If fill >= 2/3 size, adjust size. Normally, this doubles or
641 * quaduples the size, but it's also possible for the dict to shrink
Tim Peters60b29962006-01-01 01:19:23 +0000642 * (if ma_fill is much larger than ma_used, meaning a lot of dict
Raymond Hettinger3539f6b2003-05-05 22:22:10 +0000643 * keys have been * deleted).
Tim Peters60b29962006-01-01 01:19:23 +0000644 *
Raymond Hettinger3539f6b2003-05-05 22:22:10 +0000645 * Quadrupling the size improves average dictionary sparseness
646 * (reducing collisions) at the cost of some memory and iteration
647 * speed (which loops over every possible entry). It also halves
Neal Norwitz80af59c2006-05-30 04:19:21 +0000648 * the number of expensive resize operations in a growing dictionary.
Tim Peters60b29962006-01-01 01:19:23 +0000649 *
650 * Very large dictionaries (over 50K items) use doubling instead.
Raymond Hettinger3539f6b2003-05-05 22:22:10 +0000651 * This may help applications with severe memory constraints.
Guido van Rossuma4dd0112001-04-15 22:16:26 +0000652 */
Raymond Hettinger3539f6b2003-05-05 22:22:10 +0000653 if (!(mp->ma_used > n_used && mp->ma_fill*3 >= (mp->ma_mask+1)*2))
654 return 0;
Tim Peters9b10f7e2006-05-30 04:16:25 +0000655 return dictresize(mp, (mp->ma_used > 50000 ? 2 : 4) * mp->ma_used);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000656}
657
658int
Tim Peters1f5871e2000-07-04 17:44:48 +0000659PyDict_DelItem(PyObject *op, PyObject *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000660{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000661 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000662 register long hash;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000663 register dictentry *ep;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000664 PyObject *old_value, *old_key;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000665
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000666 if (!PyDict_Check(op)) {
667 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000668 return -1;
669 }
Neal Norwitz48808a12006-07-21 05:29:58 +0000670 assert(key);
Tim Peters0ab085c2001-09-14 00:25:33 +0000671 if (!PyString_CheckExact(key) ||
Tim Peters1f7df352002-03-29 03:29:08 +0000672 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000673 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000674 if (hash == -1)
675 return -1;
676 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000677 mp = (dictobject *)op;
Fred Drake1bff34a2000-08-31 19:31:38 +0000678 ep = (mp->ma_lookup)(mp, key, hash);
Armin Rigo35f6d362006-06-01 13:19:12 +0000679 if (ep == NULL)
680 return -1;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000681 if (ep->me_value == NULL) {
Georg Brandlb9f4ad32006-10-29 18:31:42 +0000682 set_key_error(key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000683 return -1;
684 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000685 old_key = ep->me_key;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000686 Py_INCREF(dummy);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000687 ep->me_key = dummy;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000688 old_value = ep->me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000689 ep->me_value = NULL;
690 mp->ma_used--;
Tim Petersea8f2bf2000-12-13 01:02:46 +0000691 Py_DECREF(old_value);
692 Py_DECREF(old_key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000693 return 0;
694}
695
Guido van Rossum25831651993-05-19 14:50:45 +0000696void
Tim Peters1f5871e2000-07-04 17:44:48 +0000697PyDict_Clear(PyObject *op)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000698{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000699 dictobject *mp;
Tim Petersdea48ec2001-05-22 20:40:22 +0000700 dictentry *ep, *table;
701 int table_is_malloced;
Tim Peters9b10f7e2006-05-30 04:16:25 +0000702 Py_ssize_t fill;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000703 dictentry small_copy[PyDict_MINSIZE];
Tim Petersdea48ec2001-05-22 20:40:22 +0000704#ifdef Py_DEBUG
Tim Peters9b10f7e2006-05-30 04:16:25 +0000705 Py_ssize_t i, n;
Tim Petersdea48ec2001-05-22 20:40:22 +0000706#endif
707
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000708 if (!PyDict_Check(op))
Guido van Rossum25831651993-05-19 14:50:45 +0000709 return;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000710 mp = (dictobject *)op;
Tim Petersdea48ec2001-05-22 20:40:22 +0000711#ifdef Py_DEBUG
Tim Petersafb6ae82001-06-04 21:00:21 +0000712 n = mp->ma_mask + 1;
Tim Petersdea48ec2001-05-22 20:40:22 +0000713 i = 0;
714#endif
715
716 table = mp->ma_table;
717 assert(table != NULL);
718 table_is_malloced = table != mp->ma_smalltable;
719
720 /* This is delicate. During the process of clearing the dict,
721 * decrefs can cause the dict to mutate. To avoid fatal confusion
722 * (voice of experience), we have to make the dict empty before
723 * clearing the slots, and never refer to anything via mp->xxx while
724 * clearing.
725 */
726 fill = mp->ma_fill;
727 if (table_is_malloced)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000728 EMPTY_TO_MINSIZE(mp);
Tim Petersdea48ec2001-05-22 20:40:22 +0000729
730 else if (fill > 0) {
731 /* It's a small table with something that needs to be cleared.
732 * Afraid the only safe way is to copy the dict entries into
733 * another small table first.
734 */
735 memcpy(small_copy, table, sizeof(small_copy));
736 table = small_copy;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000737 EMPTY_TO_MINSIZE(mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000738 }
Tim Petersdea48ec2001-05-22 20:40:22 +0000739 /* else it's a small table that's already empty */
740
741 /* Now we can finally clear things. If C had refcounts, we could
742 * assert that the refcount on table is 1 now, i.e. that this function
743 * has unique access to it, so decref side-effects can't alter it.
744 */
745 for (ep = table; fill > 0; ++ep) {
746#ifdef Py_DEBUG
747 assert(i < n);
748 ++i;
749#endif
750 if (ep->me_key) {
751 --fill;
752 Py_DECREF(ep->me_key);
753 Py_XDECREF(ep->me_value);
754 }
755#ifdef Py_DEBUG
756 else
757 assert(ep->me_value == NULL);
758#endif
759 }
760
761 if (table_is_malloced)
762 PyMem_DEL(table);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000763}
764
Tim Peters080c88b2003-02-15 03:01:11 +0000765/*
766 * Iterate over a dict. Use like so:
767 *
Tim Peters9b10f7e2006-05-30 04:16:25 +0000768 * Py_ssize_t i;
Tim Peters080c88b2003-02-15 03:01:11 +0000769 * PyObject *key, *value;
770 * i = 0; # important! i should not otherwise be changed by you
Neal Norwitz07323012003-02-15 14:45:12 +0000771 * while (PyDict_Next(yourdict, &i, &key, &value)) {
Tim Peters080c88b2003-02-15 03:01:11 +0000772 * Refer to borrowed references in key and value.
773 * }
774 *
775 * CAUTION: In general, it isn't safe to use PyDict_Next in a loop that
Tim Peters67830702001-03-21 19:23:56 +0000776 * mutates the dict. One exception: it is safe if the loop merely changes
777 * the values associated with the keys (but doesn't insert new keys or
778 * delete keys), via PyDict_SetItem().
779 */
Guido van Rossum25831651993-05-19 14:50:45 +0000780int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000781PyDict_Next(PyObject *op, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000782{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000783 register Py_ssize_t i;
Tim Peters9b10f7e2006-05-30 04:16:25 +0000784 register Py_ssize_t mask;
Raymond Hettinger43442782004-03-17 21:55:03 +0000785 register dictentry *ep;
786
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000787 if (!PyDict_Check(op))
Guido van Rossum25831651993-05-19 14:50:45 +0000788 return 0;
Guido van Rossum25831651993-05-19 14:50:45 +0000789 i = *ppos;
790 if (i < 0)
791 return 0;
Raymond Hettinger43442782004-03-17 21:55:03 +0000792 ep = ((dictobject *)op)->ma_table;
793 mask = ((dictobject *)op)->ma_mask;
794 while (i <= mask && ep[i].me_value == NULL)
Guido van Rossum25831651993-05-19 14:50:45 +0000795 i++;
796 *ppos = i+1;
Raymond Hettinger43442782004-03-17 21:55:03 +0000797 if (i > mask)
Guido van Rossum25831651993-05-19 14:50:45 +0000798 return 0;
799 if (pkey)
Raymond Hettinger43442782004-03-17 21:55:03 +0000800 *pkey = ep[i].me_key;
Guido van Rossum25831651993-05-19 14:50:45 +0000801 if (pvalue)
Raymond Hettinger43442782004-03-17 21:55:03 +0000802 *pvalue = ep[i].me_value;
Guido van Rossum25831651993-05-19 14:50:45 +0000803 return 1;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000804}
805
806/* Methods */
807
808static void
Tim Peters1f5871e2000-07-04 17:44:48 +0000809dict_dealloc(register dictobject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000810{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000811 register dictentry *ep;
Tim Peters9b10f7e2006-05-30 04:16:25 +0000812 Py_ssize_t fill = mp->ma_fill;
Guido van Rossumff413af2002-03-28 20:34:59 +0000813 PyObject_GC_UnTrack(mp);
Guido van Rossumd724b232000-03-13 16:01:29 +0000814 Py_TRASHCAN_SAFE_BEGIN(mp)
Tim Petersdea48ec2001-05-22 20:40:22 +0000815 for (ep = mp->ma_table; fill > 0; ep++) {
816 if (ep->me_key) {
817 --fill;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000818 Py_DECREF(ep->me_key);
Tim Petersdea48ec2001-05-22 20:40:22 +0000819 Py_XDECREF(ep->me_value);
Guido van Rossum255443b1998-04-10 22:47:14 +0000820 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000821 }
Tim Petersdea48ec2001-05-22 20:40:22 +0000822 if (mp->ma_table != mp->ma_smalltable)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000823 PyMem_DEL(mp->ma_table);
Raymond Hettinger43442782004-03-17 21:55:03 +0000824 if (num_free_dicts < MAXFREEDICTS && mp->ob_type == &PyDict_Type)
825 free_dicts[num_free_dicts++] = mp;
Tim Peters60b29962006-01-01 01:19:23 +0000826 else
Raymond Hettinger43442782004-03-17 21:55:03 +0000827 mp->ob_type->tp_free((PyObject *)mp);
Guido van Rossumd724b232000-03-13 16:01:29 +0000828 Py_TRASHCAN_SAFE_END(mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000829}
830
831static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000832dict_print(register dictobject *mp, register FILE *fp, register int flags)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000833{
Tim Peters9b10f7e2006-05-30 04:16:25 +0000834 register Py_ssize_t i;
835 register Py_ssize_t any;
Tim Peters33f4a6a2006-05-30 05:23:59 +0000836 int status;
Guido van Rossum255443b1998-04-10 22:47:14 +0000837
Tim Peters33f4a6a2006-05-30 05:23:59 +0000838 status = Py_ReprEnter((PyObject*)mp);
839 if (status != 0) {
840 if (status < 0)
841 return status;
Guido van Rossum255443b1998-04-10 22:47:14 +0000842 fprintf(fp, "{...}");
843 return 0;
844 }
845
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000846 fprintf(fp, "{");
847 any = 0;
Tim Petersafb6ae82001-06-04 21:00:21 +0000848 for (i = 0; i <= mp->ma_mask; i++) {
Tim Peters23cf6be2001-06-02 08:02:56 +0000849 dictentry *ep = mp->ma_table + i;
850 PyObject *pvalue = ep->me_value;
851 if (pvalue != NULL) {
852 /* Prevent PyObject_Repr from deleting value during
853 key format */
854 Py_INCREF(pvalue);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000855 if (any++ > 0)
856 fprintf(fp, ", ");
Guido van Rossum255443b1998-04-10 22:47:14 +0000857 if (PyObject_Print((PyObject *)ep->me_key, fp, 0)!=0) {
Tim Peters23cf6be2001-06-02 08:02:56 +0000858 Py_DECREF(pvalue);
Guido van Rossum255443b1998-04-10 22:47:14 +0000859 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000860 return -1;
Guido van Rossum255443b1998-04-10 22:47:14 +0000861 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000862 fprintf(fp, ": ");
Tim Peters19b77cf2001-06-02 08:27:39 +0000863 if (PyObject_Print(pvalue, fp, 0) != 0) {
Tim Peters23cf6be2001-06-02 08:02:56 +0000864 Py_DECREF(pvalue);
Guido van Rossum255443b1998-04-10 22:47:14 +0000865 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000866 return -1;
Guido van Rossum255443b1998-04-10 22:47:14 +0000867 }
Tim Peters23cf6be2001-06-02 08:02:56 +0000868 Py_DECREF(pvalue);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000869 }
870 }
871 fprintf(fp, "}");
Guido van Rossum255443b1998-04-10 22:47:14 +0000872 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000873 return 0;
874}
875
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000876static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000877dict_repr(dictobject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000878{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000879 Py_ssize_t i;
Tim Petersa7259592001-06-16 05:11:17 +0000880 PyObject *s, *temp, *colon = NULL;
881 PyObject *pieces = NULL, *result = NULL;
882 PyObject *key, *value;
Guido van Rossum255443b1998-04-10 22:47:14 +0000883
Tim Petersa7259592001-06-16 05:11:17 +0000884 i = Py_ReprEnter((PyObject *)mp);
Guido van Rossum255443b1998-04-10 22:47:14 +0000885 if (i != 0) {
Tim Petersa7259592001-06-16 05:11:17 +0000886 return i > 0 ? PyString_FromString("{...}") : NULL;
Guido van Rossum255443b1998-04-10 22:47:14 +0000887 }
888
Tim Petersa7259592001-06-16 05:11:17 +0000889 if (mp->ma_used == 0) {
890 result = PyString_FromString("{}");
891 goto Done;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000892 }
Tim Petersa7259592001-06-16 05:11:17 +0000893
894 pieces = PyList_New(0);
895 if (pieces == NULL)
896 goto Done;
897
898 colon = PyString_FromString(": ");
899 if (colon == NULL)
900 goto Done;
901
902 /* Do repr() on each key+value pair, and insert ": " between them.
903 Note that repr may mutate the dict. */
Tim Petersc6057842001-06-16 07:52:53 +0000904 i = 0;
905 while (PyDict_Next((PyObject *)mp, &i, &key, &value)) {
Tim Petersa7259592001-06-16 05:11:17 +0000906 int status;
907 /* Prevent repr from deleting value during key format. */
908 Py_INCREF(value);
909 s = PyObject_Repr(key);
910 PyString_Concat(&s, colon);
911 PyString_ConcatAndDel(&s, PyObject_Repr(value));
912 Py_DECREF(value);
913 if (s == NULL)
914 goto Done;
915 status = PyList_Append(pieces, s);
916 Py_DECREF(s); /* append created a new ref */
917 if (status < 0)
918 goto Done;
919 }
920
921 /* Add "{}" decorations to the first and last items. */
922 assert(PyList_GET_SIZE(pieces) > 0);
923 s = PyString_FromString("{");
924 if (s == NULL)
925 goto Done;
926 temp = PyList_GET_ITEM(pieces, 0);
927 PyString_ConcatAndDel(&s, temp);
928 PyList_SET_ITEM(pieces, 0, s);
929 if (s == NULL)
930 goto Done;
931
932 s = PyString_FromString("}");
933 if (s == NULL)
934 goto Done;
935 temp = PyList_GET_ITEM(pieces, PyList_GET_SIZE(pieces) - 1);
936 PyString_ConcatAndDel(&temp, s);
937 PyList_SET_ITEM(pieces, PyList_GET_SIZE(pieces) - 1, temp);
938 if (temp == NULL)
939 goto Done;
940
941 /* Paste them all together with ", " between. */
942 s = PyString_FromString(", ");
943 if (s == NULL)
944 goto Done;
945 result = _PyString_Join(s, pieces);
Tim Peters0ab085c2001-09-14 00:25:33 +0000946 Py_DECREF(s);
Tim Petersa7259592001-06-16 05:11:17 +0000947
948Done:
949 Py_XDECREF(pieces);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000950 Py_XDECREF(colon);
Tim Petersa7259592001-06-16 05:11:17 +0000951 Py_ReprLeave((PyObject *)mp);
952 return result;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000953}
954
Martin v. Löwis18e16552006-02-15 17:27:45 +0000955static Py_ssize_t
Tim Peters1f5871e2000-07-04 17:44:48 +0000956dict_length(dictobject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000957{
958 return mp->ma_used;
959}
960
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000961static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000962dict_subscript(dictobject *mp, register PyObject *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000963{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000964 PyObject *v;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000965 long hash;
Armin Rigo35f6d362006-06-01 13:19:12 +0000966 dictentry *ep;
Tim Petersdea48ec2001-05-22 20:40:22 +0000967 assert(mp->ma_table != NULL);
Tim Peters0ab085c2001-09-14 00:25:33 +0000968 if (!PyString_CheckExact(key) ||
Tim Peters1f7df352002-03-29 03:29:08 +0000969 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000970 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000971 if (hash == -1)
972 return NULL;
973 }
Armin Rigo35f6d362006-06-01 13:19:12 +0000974 ep = (mp->ma_lookup)(mp, key, hash);
975 if (ep == NULL)
976 return NULL;
977 v = ep->me_value;
Guido van Rossum1968ad32006-02-25 22:38:04 +0000978 if (v == NULL) {
979 if (!PyDict_CheckExact(mp)) {
980 /* Look up __missing__ method if we're a subclass. */
Guido van Rossum4b92a822006-02-25 23:32:30 +0000981 PyObject *missing;
Guido van Rossum1968ad32006-02-25 22:38:04 +0000982 static PyObject *missing_str = NULL;
983 if (missing_str == NULL)
Tim Peters9b10f7e2006-05-30 04:16:25 +0000984 missing_str =
Guido van Rossum1968ad32006-02-25 22:38:04 +0000985 PyString_InternFromString("__missing__");
Guido van Rossum4b92a822006-02-25 23:32:30 +0000986 missing = _PyType_Lookup(mp->ob_type, missing_str);
Guido van Rossum1968ad32006-02-25 22:38:04 +0000987 if (missing != NULL)
988 return PyObject_CallFunctionObjArgs(missing,
989 (PyObject *)mp, key, NULL);
990 }
Georg Brandlb9f4ad32006-10-29 18:31:42 +0000991 set_key_error(key);
Guido van Rossum1968ad32006-02-25 22:38:04 +0000992 return NULL;
993 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000994 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000995 Py_INCREF(v);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000996 return v;
997}
998
999static int
Tim Peters1f5871e2000-07-04 17:44:48 +00001000dict_ass_sub(dictobject *mp, PyObject *v, PyObject *w)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001001{
1002 if (w == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001003 return PyDict_DelItem((PyObject *)mp, v);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001004 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001005 return PyDict_SetItem((PyObject *)mp, v, w);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001006}
1007
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001008static PyMappingMethods dict_as_mapping = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001009 (lenfunc)dict_length, /*mp_length*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001010 (binaryfunc)dict_subscript, /*mp_subscript*/
1011 (objobjargproc)dict_ass_sub, /*mp_ass_subscript*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001012};
1013
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001014static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001015dict_keys(register dictobject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001016{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001017 register PyObject *v;
Tim Peters9b10f7e2006-05-30 04:16:25 +00001018 register Py_ssize_t i, j;
Raymond Hettinger43442782004-03-17 21:55:03 +00001019 dictentry *ep;
Tim Peters9b10f7e2006-05-30 04:16:25 +00001020 Py_ssize_t mask, n;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001021
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001022 again:
1023 n = mp->ma_used;
1024 v = PyList_New(n);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001025 if (v == NULL)
1026 return NULL;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001027 if (n != mp->ma_used) {
1028 /* Durnit. The allocations caused the dict to resize.
1029 * Just start over, this shouldn't normally happen.
1030 */
1031 Py_DECREF(v);
1032 goto again;
1033 }
Raymond Hettinger43442782004-03-17 21:55:03 +00001034 ep = mp->ma_table;
1035 mask = mp->ma_mask;
1036 for (i = 0, j = 0; i <= mask; i++) {
1037 if (ep[i].me_value != NULL) {
1038 PyObject *key = ep[i].me_key;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001039 Py_INCREF(key);
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001040 PyList_SET_ITEM(v, j, key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001041 j++;
1042 }
1043 }
Raymond Hettinger43442782004-03-17 21:55:03 +00001044 assert(j == n);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001045 return v;
1046}
1047
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001048static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001049dict_values(register dictobject *mp)
Guido van Rossum25831651993-05-19 14:50:45 +00001050{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001051 register PyObject *v;
Tim Peters9b10f7e2006-05-30 04:16:25 +00001052 register Py_ssize_t i, j;
Raymond Hettinger43442782004-03-17 21:55:03 +00001053 dictentry *ep;
Tim Peters9b10f7e2006-05-30 04:16:25 +00001054 Py_ssize_t mask, n;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001055
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001056 again:
1057 n = mp->ma_used;
1058 v = PyList_New(n);
Guido van Rossum25831651993-05-19 14:50:45 +00001059 if (v == NULL)
1060 return NULL;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001061 if (n != mp->ma_used) {
1062 /* Durnit. The allocations caused the dict to resize.
1063 * Just start over, this shouldn't normally happen.
1064 */
1065 Py_DECREF(v);
1066 goto again;
1067 }
Raymond Hettinger43442782004-03-17 21:55:03 +00001068 ep = mp->ma_table;
1069 mask = mp->ma_mask;
1070 for (i = 0, j = 0; i <= mask; i++) {
1071 if (ep[i].me_value != NULL) {
1072 PyObject *value = ep[i].me_value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001073 Py_INCREF(value);
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001074 PyList_SET_ITEM(v, j, value);
Guido van Rossum25831651993-05-19 14:50:45 +00001075 j++;
1076 }
1077 }
Raymond Hettinger43442782004-03-17 21:55:03 +00001078 assert(j == n);
Guido van Rossum25831651993-05-19 14:50:45 +00001079 return v;
1080}
1081
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001082static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001083dict_items(register dictobject *mp)
Guido van Rossum25831651993-05-19 14:50:45 +00001084{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001085 register PyObject *v;
Tim Peters9b10f7e2006-05-30 04:16:25 +00001086 register Py_ssize_t i, j, n;
1087 Py_ssize_t mask;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001088 PyObject *item, *key, *value;
Raymond Hettinger43442782004-03-17 21:55:03 +00001089 dictentry *ep;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001090
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001091 /* Preallocate the list of tuples, to avoid allocations during
1092 * the loop over the items, which could trigger GC, which
1093 * could resize the dict. :-(
1094 */
1095 again:
1096 n = mp->ma_used;
1097 v = PyList_New(n);
Guido van Rossum25831651993-05-19 14:50:45 +00001098 if (v == NULL)
1099 return NULL;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001100 for (i = 0; i < n; i++) {
1101 item = PyTuple_New(2);
1102 if (item == NULL) {
1103 Py_DECREF(v);
1104 return NULL;
1105 }
1106 PyList_SET_ITEM(v, i, item);
1107 }
1108 if (n != mp->ma_used) {
1109 /* Durnit. The allocations caused the dict to resize.
1110 * Just start over, this shouldn't normally happen.
1111 */
1112 Py_DECREF(v);
1113 goto again;
1114 }
1115 /* Nothing we do below makes any function calls. */
Raymond Hettinger43442782004-03-17 21:55:03 +00001116 ep = mp->ma_table;
1117 mask = mp->ma_mask;
1118 for (i = 0, j = 0; i <= mask; i++) {
Raymond Hettinger06905122004-03-19 10:30:00 +00001119 if ((value=ep[i].me_value) != NULL) {
Raymond Hettinger43442782004-03-17 21:55:03 +00001120 key = ep[i].me_key;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001121 item = PyList_GET_ITEM(v, j);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001122 Py_INCREF(key);
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001123 PyTuple_SET_ITEM(item, 0, key);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001124 Py_INCREF(value);
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001125 PyTuple_SET_ITEM(item, 1, value);
Guido van Rossum25831651993-05-19 14:50:45 +00001126 j++;
1127 }
1128 }
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001129 assert(j == n);
Guido van Rossum25831651993-05-19 14:50:45 +00001130 return v;
1131}
1132
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001133static PyObject *
Tim Petersbca1cbc2002-12-09 22:56:13 +00001134dict_fromkeys(PyObject *cls, PyObject *args)
Raymond Hettingere33d3df2002-11-27 07:29:33 +00001135{
1136 PyObject *seq;
1137 PyObject *value = Py_None;
1138 PyObject *it; /* iter(seq) */
1139 PyObject *key;
1140 PyObject *d;
Raymond Hettingere33d3df2002-11-27 07:29:33 +00001141 int status;
1142
Raymond Hettingerea3fdf42002-12-29 16:33:45 +00001143 if (!PyArg_UnpackTuple(args, "fromkeys", 1, 2, &seq, &value))
Raymond Hettingere33d3df2002-11-27 07:29:33 +00001144 return NULL;
1145
1146 d = PyObject_CallObject(cls, NULL);
1147 if (d == NULL)
1148 return NULL;
Raymond Hettingere33d3df2002-11-27 07:29:33 +00001149
1150 it = PyObject_GetIter(seq);
1151 if (it == NULL){
1152 Py_DECREF(d);
1153 return NULL;
1154 }
1155
1156 for (;;) {
1157 key = PyIter_Next(it);
1158 if (key == NULL) {
1159 if (PyErr_Occurred())
1160 goto Fail;
1161 break;
1162 }
Raymond Hettingere03e5b12002-12-07 08:10:51 +00001163 status = PyObject_SetItem(d, key, value);
Raymond Hettingere33d3df2002-11-27 07:29:33 +00001164 Py_DECREF(key);
1165 if (status < 0)
1166 goto Fail;
1167 }
1168
1169 Py_DECREF(it);
1170 return d;
1171
1172Fail:
1173 Py_DECREF(it);
1174 Py_DECREF(d);
1175 return NULL;
1176}
1177
Raymond Hettinger31017ae2004-03-04 08:25:44 +00001178static int
1179dict_update_common(PyObject *self, PyObject *args, PyObject *kwds, char *methname)
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001180{
Raymond Hettinger31017ae2004-03-04 08:25:44 +00001181 PyObject *arg = NULL;
1182 int result = 0;
1183
1184 if (!PyArg_UnpackTuple(args, methname, 0, 1, &arg))
1185 result = -1;
1186
1187 else if (arg != NULL) {
1188 if (PyObject_HasAttrString(arg, "keys"))
1189 result = PyDict_Merge(self, arg, 1);
1190 else
1191 result = PyDict_MergeFromSeq2(self, arg, 1);
1192 }
1193 if (result == 0 && kwds != NULL)
1194 result = PyDict_Merge(self, kwds, 1);
1195 return result;
1196}
1197
1198static PyObject *
1199dict_update(PyObject *self, PyObject *args, PyObject *kwds)
1200{
Raymond Hettinger7892b1c2004-04-12 18:10:01 +00001201 if (dict_update_common(self, args, kwds, "update") != -1)
1202 Py_RETURN_NONE;
1203 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001204}
1205
Guido van Rossum05ac6de2001-08-10 20:28:28 +00001206/* Update unconditionally replaces existing items.
1207 Merge has a 3rd argument 'override'; if set, it acts like Update,
Tim Peters1fc240e2001-10-26 05:06:50 +00001208 otherwise it leaves existing items unchanged.
1209
1210 PyDict_{Update,Merge} update/merge from a mapping object.
1211
Tim Petersf582b822001-12-11 18:51:08 +00001212 PyDict_MergeFromSeq2 updates/merges from any iterable object
Tim Peters1fc240e2001-10-26 05:06:50 +00001213 producing iterable objects of length 2.
1214*/
1215
Tim Petersf582b822001-12-11 18:51:08 +00001216int
Tim Peters1fc240e2001-10-26 05:06:50 +00001217PyDict_MergeFromSeq2(PyObject *d, PyObject *seq2, int override)
1218{
1219 PyObject *it; /* iter(seq2) */
Tim Peters9b10f7e2006-05-30 04:16:25 +00001220 Py_ssize_t i; /* index into seq2 of current element */
Tim Peters1fc240e2001-10-26 05:06:50 +00001221 PyObject *item; /* seq2[i] */
1222 PyObject *fast; /* item as a 2-tuple or 2-list */
1223
1224 assert(d != NULL);
1225 assert(PyDict_Check(d));
1226 assert(seq2 != NULL);
1227
1228 it = PyObject_GetIter(seq2);
1229 if (it == NULL)
1230 return -1;
1231
1232 for (i = 0; ; ++i) {
1233 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001234 Py_ssize_t n;
Tim Peters1fc240e2001-10-26 05:06:50 +00001235
1236 fast = NULL;
1237 item = PyIter_Next(it);
1238 if (item == NULL) {
1239 if (PyErr_Occurred())
1240 goto Fail;
1241 break;
1242 }
1243
1244 /* Convert item to sequence, and verify length 2. */
1245 fast = PySequence_Fast(item, "");
1246 if (fast == NULL) {
1247 if (PyErr_ExceptionMatches(PyExc_TypeError))
1248 PyErr_Format(PyExc_TypeError,
1249 "cannot convert dictionary update "
Neal Norwitzd3881b02006-05-30 04:25:05 +00001250 "sequence element #%zd to a sequence",
Tim Peters1fc240e2001-10-26 05:06:50 +00001251 i);
1252 goto Fail;
1253 }
1254 n = PySequence_Fast_GET_SIZE(fast);
1255 if (n != 2) {
1256 PyErr_Format(PyExc_ValueError,
Neal Norwitzd3881b02006-05-30 04:25:05 +00001257 "dictionary update sequence element #%zd "
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00001258 "has length %zd; 2 is required",
Martin v. Löwise0e89f72006-02-16 06:59:22 +00001259 i, n);
Tim Peters1fc240e2001-10-26 05:06:50 +00001260 goto Fail;
1261 }
1262
1263 /* Update/merge with this (key, value) pair. */
1264 key = PySequence_Fast_GET_ITEM(fast, 0);
1265 value = PySequence_Fast_GET_ITEM(fast, 1);
1266 if (override || PyDict_GetItem(d, key) == NULL) {
1267 int status = PyDict_SetItem(d, key, value);
1268 if (status < 0)
1269 goto Fail;
1270 }
1271 Py_DECREF(fast);
1272 Py_DECREF(item);
1273 }
1274
1275 i = 0;
1276 goto Return;
1277Fail:
1278 Py_XDECREF(item);
1279 Py_XDECREF(fast);
1280 i = -1;
1281Return:
1282 Py_DECREF(it);
Neal Norwitzd3881b02006-05-30 04:25:05 +00001283 return Py_SAFE_DOWNCAST(i, Py_ssize_t, int);
Tim Peters1fc240e2001-10-26 05:06:50 +00001284}
1285
Tim Peters6d6c1a32001-08-02 04:15:00 +00001286int
1287PyDict_Update(PyObject *a, PyObject *b)
1288{
Guido van Rossum05ac6de2001-08-10 20:28:28 +00001289 return PyDict_Merge(a, b, 1);
1290}
1291
1292int
1293PyDict_Merge(PyObject *a, PyObject *b, int override)
1294{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001295 register PyDictObject *mp, *other;
Tim Peters9b10f7e2006-05-30 04:16:25 +00001296 register Py_ssize_t i;
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001297 dictentry *entry;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001298
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001299 /* We accept for the argument either a concrete dictionary object,
1300 * or an abstract "mapping" object. For the former, we can do
1301 * things quite efficiently. For the latter, we only require that
1302 * PyMapping_Keys() and PyObject_GetItem() be supported.
1303 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001304 if (a == NULL || !PyDict_Check(a) || b == NULL) {
1305 PyErr_BadInternalCall();
1306 return -1;
1307 }
1308 mp = (dictobject*)a;
1309 if (PyDict_Check(b)) {
1310 other = (dictobject*)b;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001311 if (other == mp || other->ma_used == 0)
1312 /* a.update(a) or a.update({}); nothing to do */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001313 return 0;
Raymond Hettinger186e7392005-05-14 18:08:25 +00001314 if (mp->ma_used == 0)
1315 /* Since the target dict is empty, PyDict_GetItem()
1316 * always returns NULL. Setting override to 1
1317 * skips the unnecessary test.
1318 */
1319 override = 1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001320 /* Do one big resize at the start, rather than
1321 * incrementally resizing as we insert new items. Expect
1322 * that there will be no (or few) overlapping keys.
1323 */
1324 if ((mp->ma_fill + other->ma_used)*3 >= (mp->ma_mask+1)*2) {
Raymond Hettingerc8d22902003-05-07 00:49:40 +00001325 if (dictresize(mp, (mp->ma_used + other->ma_used)*2) != 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001326 return -1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001327 }
1328 for (i = 0; i <= other->ma_mask; i++) {
1329 entry = &other->ma_table[i];
Guido van Rossum05ac6de2001-08-10 20:28:28 +00001330 if (entry->me_value != NULL &&
1331 (override ||
1332 PyDict_GetItem(a, entry->me_key) == NULL)) {
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001333 Py_INCREF(entry->me_key);
1334 Py_INCREF(entry->me_value);
Armin Rigo35f6d362006-06-01 13:19:12 +00001335 if (insertdict(mp, entry->me_key,
1336 (long)entry->me_hash,
1337 entry->me_value) != 0)
1338 return -1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001339 }
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001340 }
1341 }
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001342 else {
1343 /* Do it the generic, slower way */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001344 PyObject *keys = PyMapping_Keys(b);
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001345 PyObject *iter;
1346 PyObject *key, *value;
1347 int status;
1348
1349 if (keys == NULL)
1350 /* Docstring says this is equivalent to E.keys() so
1351 * if E doesn't have a .keys() method we want
1352 * AttributeError to percolate up. Might as well
1353 * do the same for any other error.
1354 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001355 return -1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001356
1357 iter = PyObject_GetIter(keys);
1358 Py_DECREF(keys);
1359 if (iter == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001360 return -1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001361
1362 for (key = PyIter_Next(iter); key; key = PyIter_Next(iter)) {
Guido van Rossum05ac6de2001-08-10 20:28:28 +00001363 if (!override && PyDict_GetItem(a, key) != NULL) {
1364 Py_DECREF(key);
1365 continue;
1366 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001367 value = PyObject_GetItem(b, key);
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001368 if (value == NULL) {
1369 Py_DECREF(iter);
1370 Py_DECREF(key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001371 return -1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001372 }
Guido van Rossum05ac6de2001-08-10 20:28:28 +00001373 status = PyDict_SetItem(a, key, value);
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001374 Py_DECREF(key);
1375 Py_DECREF(value);
1376 if (status < 0) {
1377 Py_DECREF(iter);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001378 return -1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001379 }
1380 }
1381 Py_DECREF(iter);
1382 if (PyErr_Occurred())
1383 /* Iterator completed, via error */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001384 return -1;
Barry Warsaw66a0d1d2001-06-26 20:08:32 +00001385 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001386 return 0;
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001387}
1388
1389static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001390dict_copy(register dictobject *mp)
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001391{
Jeremy Hyltona12c7a72000-03-30 22:27:31 +00001392 return PyDict_Copy((PyObject*)mp);
1393}
1394
1395PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001396PyDict_Copy(PyObject *o)
Jeremy Hyltona12c7a72000-03-30 22:27:31 +00001397{
Raymond Hettingerebedb2f2004-03-08 04:19:01 +00001398 PyObject *copy;
Jeremy Hyltona12c7a72000-03-30 22:27:31 +00001399
1400 if (o == NULL || !PyDict_Check(o)) {
1401 PyErr_BadInternalCall();
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001402 return NULL;
Jeremy Hyltona12c7a72000-03-30 22:27:31 +00001403 }
Raymond Hettingerebedb2f2004-03-08 04:19:01 +00001404 copy = PyDict_New();
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001405 if (copy == NULL)
1406 return NULL;
Raymond Hettingerebedb2f2004-03-08 04:19:01 +00001407 if (PyDict_Merge(copy, o, 1) == 0)
1408 return copy;
1409 Py_DECREF(copy);
Raymond Hettinger1356f782005-04-15 15:58:42 +00001410 return NULL;
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001411}
1412
Martin v. Löwis18e16552006-02-15 17:27:45 +00001413Py_ssize_t
Tim Peters1f5871e2000-07-04 17:44:48 +00001414PyDict_Size(PyObject *mp)
Guido van Rossum4199fac1993-11-05 10:18:44 +00001415{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001416 if (mp == NULL || !PyDict_Check(mp)) {
1417 PyErr_BadInternalCall();
Jeremy Hylton7083bb72004-02-17 20:10:11 +00001418 return -1;
Guido van Rossum4199fac1993-11-05 10:18:44 +00001419 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001420 return ((dictobject *)mp)->ma_used;
Guido van Rossum4199fac1993-11-05 10:18:44 +00001421}
1422
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001423PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001424PyDict_Keys(PyObject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001425{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001426 if (mp == NULL || !PyDict_Check(mp)) {
1427 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001428 return NULL;
1429 }
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001430 return dict_keys((dictobject *)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001431}
1432
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001433PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001434PyDict_Values(PyObject *mp)
Guido van Rossum25831651993-05-19 14:50:45 +00001435{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001436 if (mp == NULL || !PyDict_Check(mp)) {
1437 PyErr_BadInternalCall();
Guido van Rossum25831651993-05-19 14:50:45 +00001438 return NULL;
1439 }
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001440 return dict_values((dictobject *)mp);
Guido van Rossum25831651993-05-19 14:50:45 +00001441}
1442
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001443PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001444PyDict_Items(PyObject *mp)
Guido van Rossum25831651993-05-19 14:50:45 +00001445{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001446 if (mp == NULL || !PyDict_Check(mp)) {
1447 PyErr_BadInternalCall();
Guido van Rossum25831651993-05-19 14:50:45 +00001448 return NULL;
1449 }
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001450 return dict_items((dictobject *)mp);
Guido van Rossum25831651993-05-19 14:50:45 +00001451}
1452
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001453/* Subroutine which returns the smallest key in a for which b's value
1454 is different or absent. The value is returned too, through the
Tim Peters95bf9392001-05-10 08:32:44 +00001455 pval argument. Both are NULL if no key in a is found for which b's status
1456 differs. The refcounts on (and only on) non-NULL *pval and function return
1457 values must be decremented by the caller (characterize() increments them
1458 to ensure that mutating comparison and PyDict_GetItem calls can't delete
1459 them before the caller is done looking at them). */
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001460
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001461static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001462characterize(dictobject *a, dictobject *b, PyObject **pval)
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001463{
Tim Peters95bf9392001-05-10 08:32:44 +00001464 PyObject *akey = NULL; /* smallest key in a s.t. a[akey] != b[akey] */
1465 PyObject *aval = NULL; /* a[akey] */
Tim Peters9b10f7e2006-05-30 04:16:25 +00001466 Py_ssize_t i;
1467 int cmp;
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001468
Tim Petersafb6ae82001-06-04 21:00:21 +00001469 for (i = 0; i <= a->ma_mask; i++) {
Tim Peters95bf9392001-05-10 08:32:44 +00001470 PyObject *thiskey, *thisaval, *thisbval;
1471 if (a->ma_table[i].me_value == NULL)
1472 continue;
1473 thiskey = a->ma_table[i].me_key;
1474 Py_INCREF(thiskey); /* keep alive across compares */
1475 if (akey != NULL) {
1476 cmp = PyObject_RichCompareBool(akey, thiskey, Py_LT);
1477 if (cmp < 0) {
1478 Py_DECREF(thiskey);
1479 goto Fail;
1480 }
1481 if (cmp > 0 ||
Tim Petersafb6ae82001-06-04 21:00:21 +00001482 i > a->ma_mask ||
Tim Peters95bf9392001-05-10 08:32:44 +00001483 a->ma_table[i].me_value == NULL)
1484 {
1485 /* Not the *smallest* a key; or maybe it is
1486 * but the compare shrunk the dict so we can't
1487 * find its associated value anymore; or
1488 * maybe it is but the compare deleted the
1489 * a[thiskey] entry.
Neal Norwitzd3881b02006-05-30 04:25:05 +00001490 */
Tim Peters95bf9392001-05-10 08:32:44 +00001491 Py_DECREF(thiskey);
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001492 continue;
Guido van Rossumb9324202001-01-18 00:39:02 +00001493 }
Tim Peters95bf9392001-05-10 08:32:44 +00001494 }
1495
1496 /* Compare a[thiskey] to b[thiskey]; cmp <- true iff equal. */
1497 thisaval = a->ma_table[i].me_value;
1498 assert(thisaval);
1499 Py_INCREF(thisaval); /* keep alive */
1500 thisbval = PyDict_GetItem((PyObject *)b, thiskey);
1501 if (thisbval == NULL)
1502 cmp = 0;
1503 else {
1504 /* both dicts have thiskey: same values? */
1505 cmp = PyObject_RichCompareBool(
1506 thisaval, thisbval, Py_EQ);
1507 if (cmp < 0) {
1508 Py_DECREF(thiskey);
1509 Py_DECREF(thisaval);
1510 goto Fail;
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001511 }
1512 }
Tim Peters95bf9392001-05-10 08:32:44 +00001513 if (cmp == 0) {
1514 /* New winner. */
1515 Py_XDECREF(akey);
1516 Py_XDECREF(aval);
1517 akey = thiskey;
1518 aval = thisaval;
1519 }
1520 else {
1521 Py_DECREF(thiskey);
1522 Py_DECREF(thisaval);
1523 }
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001524 }
Tim Peters95bf9392001-05-10 08:32:44 +00001525 *pval = aval;
1526 return akey;
1527
1528Fail:
1529 Py_XDECREF(akey);
1530 Py_XDECREF(aval);
1531 *pval = NULL;
1532 return NULL;
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001533}
1534
1535static int
Tim Peters1f5871e2000-07-04 17:44:48 +00001536dict_compare(dictobject *a, dictobject *b)
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001537{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001538 PyObject *adiff, *bdiff, *aval, *bval;
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001539 int res;
1540
1541 /* Compare lengths first */
1542 if (a->ma_used < b->ma_used)
1543 return -1; /* a is shorter */
1544 else if (a->ma_used > b->ma_used)
1545 return 1; /* b is shorter */
Tim Peters95bf9392001-05-10 08:32:44 +00001546
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001547 /* Same length -- check all keys */
Tim Peters95bf9392001-05-10 08:32:44 +00001548 bdiff = bval = NULL;
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001549 adiff = characterize(a, b, &aval);
Tim Peters95bf9392001-05-10 08:32:44 +00001550 if (adiff == NULL) {
1551 assert(!aval);
Tim Peters3918fb22001-05-10 18:58:31 +00001552 /* Either an error, or a is a subset with the same length so
Tim Peters95bf9392001-05-10 08:32:44 +00001553 * must be equal.
1554 */
1555 res = PyErr_Occurred() ? -1 : 0;
1556 goto Finished;
1557 }
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001558 bdiff = characterize(b, a, &bval);
Tim Peters95bf9392001-05-10 08:32:44 +00001559 if (bdiff == NULL && PyErr_Occurred()) {
1560 assert(!bval);
1561 res = -1;
1562 goto Finished;
1563 }
1564 res = 0;
1565 if (bdiff) {
1566 /* bdiff == NULL "should be" impossible now, but perhaps
1567 * the last comparison done by the characterize() on a had
1568 * the side effect of making the dicts equal!
1569 */
1570 res = PyObject_Compare(adiff, bdiff);
1571 }
1572 if (res == 0 && bval != NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001573 res = PyObject_Compare(aval, bval);
Tim Peters95bf9392001-05-10 08:32:44 +00001574
1575Finished:
1576 Py_XDECREF(adiff);
1577 Py_XDECREF(bdiff);
1578 Py_XDECREF(aval);
1579 Py_XDECREF(bval);
Guido van Rossuma0a69b81996-12-05 21:55:55 +00001580 return res;
1581}
1582
Tim Peterse63415e2001-05-08 04:38:29 +00001583/* Return 1 if dicts equal, 0 if not, -1 if error.
1584 * Gets out as soon as any difference is detected.
1585 * Uses only Py_EQ comparison.
1586 */
1587static int
1588dict_equal(dictobject *a, dictobject *b)
1589{
Tim Peters9b10f7e2006-05-30 04:16:25 +00001590 Py_ssize_t i;
Tim Peterse63415e2001-05-08 04:38:29 +00001591
1592 if (a->ma_used != b->ma_used)
1593 /* can't be equal if # of entries differ */
1594 return 0;
Tim Peterseb28ef22001-06-02 05:27:19 +00001595
Tim Peterse63415e2001-05-08 04:38:29 +00001596 /* Same # of entries -- check all of 'em. Exit early on any diff. */
Tim Petersafb6ae82001-06-04 21:00:21 +00001597 for (i = 0; i <= a->ma_mask; i++) {
Tim Peterse63415e2001-05-08 04:38:29 +00001598 PyObject *aval = a->ma_table[i].me_value;
1599 if (aval != NULL) {
1600 int cmp;
1601 PyObject *bval;
1602 PyObject *key = a->ma_table[i].me_key;
1603 /* temporarily bump aval's refcount to ensure it stays
1604 alive until we're done with it */
1605 Py_INCREF(aval);
Neal Norwitza22975f2006-09-05 02:24:03 +00001606 /* ditto for key */
1607 Py_INCREF(key);
Tim Peterse63415e2001-05-08 04:38:29 +00001608 bval = PyDict_GetItem((PyObject *)b, key);
Neal Norwitza22975f2006-09-05 02:24:03 +00001609 Py_DECREF(key);
Tim Peterse63415e2001-05-08 04:38:29 +00001610 if (bval == NULL) {
1611 Py_DECREF(aval);
1612 return 0;
1613 }
1614 cmp = PyObject_RichCompareBool(aval, bval, Py_EQ);
1615 Py_DECREF(aval);
1616 if (cmp <= 0) /* error or not equal */
1617 return cmp;
1618 }
1619 }
1620 return 1;
1621 }
1622
1623static PyObject *
1624dict_richcompare(PyObject *v, PyObject *w, int op)
1625{
1626 int cmp;
1627 PyObject *res;
1628
1629 if (!PyDict_Check(v) || !PyDict_Check(w)) {
1630 res = Py_NotImplemented;
1631 }
1632 else if (op == Py_EQ || op == Py_NE) {
1633 cmp = dict_equal((dictobject *)v, (dictobject *)w);
1634 if (cmp < 0)
1635 return NULL;
1636 res = (cmp == (op == Py_EQ)) ? Py_True : Py_False;
1637 }
Tim Peters4fa58bf2001-05-10 21:45:19 +00001638 else
1639 res = Py_NotImplemented;
Tim Peterse63415e2001-05-08 04:38:29 +00001640 Py_INCREF(res);
1641 return res;
1642 }
1643
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001644static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001645dict_has_key(register dictobject *mp, PyObject *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001646{
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001647 long hash;
Armin Rigo35f6d362006-06-01 13:19:12 +00001648 dictentry *ep;
Tim Petersd770ebd2006-06-01 15:50:44 +00001649
Tim Peters0ab085c2001-09-14 00:25:33 +00001650 if (!PyString_CheckExact(key) ||
Tim Peters1f7df352002-03-29 03:29:08 +00001651 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001652 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +00001653 if (hash == -1)
1654 return NULL;
1655 }
Armin Rigo35f6d362006-06-01 13:19:12 +00001656 ep = (mp->ma_lookup)(mp, key, hash);
1657 if (ep == NULL)
1658 return NULL;
Tim Petersd770ebd2006-06-01 15:50:44 +00001659 return PyBool_FromLong(ep->me_value != NULL);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001660}
1661
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001662static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001663dict_get(register dictobject *mp, PyObject *args)
Barry Warsawc38c5da1997-10-06 17:49:20 +00001664{
1665 PyObject *key;
Barry Warsaw320ac331997-10-20 17:26:25 +00001666 PyObject *failobj = Py_None;
Barry Warsawc38c5da1997-10-06 17:49:20 +00001667 PyObject *val = NULL;
1668 long hash;
Armin Rigo35f6d362006-06-01 13:19:12 +00001669 dictentry *ep;
Barry Warsawc38c5da1997-10-06 17:49:20 +00001670
Raymond Hettingerea3fdf42002-12-29 16:33:45 +00001671 if (!PyArg_UnpackTuple(args, "get", 1, 2, &key, &failobj))
Barry Warsawc38c5da1997-10-06 17:49:20 +00001672 return NULL;
1673
Tim Peters0ab085c2001-09-14 00:25:33 +00001674 if (!PyString_CheckExact(key) ||
Tim Peters1f7df352002-03-29 03:29:08 +00001675 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Barry Warsawc38c5da1997-10-06 17:49:20 +00001676 hash = PyObject_Hash(key);
1677 if (hash == -1)
1678 return NULL;
1679 }
Armin Rigo35f6d362006-06-01 13:19:12 +00001680 ep = (mp->ma_lookup)(mp, key, hash);
1681 if (ep == NULL)
1682 return NULL;
1683 val = ep->me_value;
Barry Warsawc38c5da1997-10-06 17:49:20 +00001684 if (val == NULL)
1685 val = failobj;
1686 Py_INCREF(val);
1687 return val;
1688}
1689
1690
1691static PyObject *
Guido van Rossum164452c2000-08-08 16:12:54 +00001692dict_setdefault(register dictobject *mp, PyObject *args)
1693{
1694 PyObject *key;
1695 PyObject *failobj = Py_None;
1696 PyObject *val = NULL;
1697 long hash;
Armin Rigo35f6d362006-06-01 13:19:12 +00001698 dictentry *ep;
Guido van Rossum164452c2000-08-08 16:12:54 +00001699
Raymond Hettingerea3fdf42002-12-29 16:33:45 +00001700 if (!PyArg_UnpackTuple(args, "setdefault", 1, 2, &key, &failobj))
Guido van Rossum164452c2000-08-08 16:12:54 +00001701 return NULL;
Guido van Rossum164452c2000-08-08 16:12:54 +00001702
Tim Peters0ab085c2001-09-14 00:25:33 +00001703 if (!PyString_CheckExact(key) ||
Tim Peters1f7df352002-03-29 03:29:08 +00001704 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Guido van Rossum164452c2000-08-08 16:12:54 +00001705 hash = PyObject_Hash(key);
1706 if (hash == -1)
1707 return NULL;
1708 }
Armin Rigo35f6d362006-06-01 13:19:12 +00001709 ep = (mp->ma_lookup)(mp, key, hash);
1710 if (ep == NULL)
1711 return NULL;
1712 val = ep->me_value;
Guido van Rossum164452c2000-08-08 16:12:54 +00001713 if (val == NULL) {
1714 val = failobj;
1715 if (PyDict_SetItem((PyObject*)mp, key, failobj))
1716 val = NULL;
1717 }
1718 Py_XINCREF(val);
1719 return val;
1720}
1721
1722
1723static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001724dict_clear(register dictobject *mp)
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +00001725{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001726 PyDict_Clear((PyObject *)mp);
Raymond Hettinger7892b1c2004-04-12 18:10:01 +00001727 Py_RETURN_NONE;
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +00001728}
1729
Guido van Rossumba6ab842000-12-12 22:02:18 +00001730static PyObject *
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +00001731dict_pop(dictobject *mp, PyObject *args)
Guido van Rossume027d982002-04-12 15:11:59 +00001732{
1733 long hash;
1734 dictentry *ep;
1735 PyObject *old_value, *old_key;
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +00001736 PyObject *key, *deflt = NULL;
Guido van Rossume027d982002-04-12 15:11:59 +00001737
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +00001738 if(!PyArg_UnpackTuple(args, "pop", 1, 2, &key, &deflt))
1739 return NULL;
Guido van Rossume027d982002-04-12 15:11:59 +00001740 if (mp->ma_used == 0) {
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +00001741 if (deflt) {
1742 Py_INCREF(deflt);
1743 return deflt;
1744 }
Guido van Rossume027d982002-04-12 15:11:59 +00001745 PyErr_SetString(PyExc_KeyError,
1746 "pop(): dictionary is empty");
1747 return NULL;
1748 }
1749 if (!PyString_CheckExact(key) ||
1750 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
1751 hash = PyObject_Hash(key);
1752 if (hash == -1)
1753 return NULL;
1754 }
1755 ep = (mp->ma_lookup)(mp, key, hash);
Armin Rigo35f6d362006-06-01 13:19:12 +00001756 if (ep == NULL)
1757 return NULL;
Guido van Rossume027d982002-04-12 15:11:59 +00001758 if (ep->me_value == NULL) {
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +00001759 if (deflt) {
1760 Py_INCREF(deflt);
1761 return deflt;
1762 }
Georg Brandlb9f4ad32006-10-29 18:31:42 +00001763 set_key_error(key);
Guido van Rossume027d982002-04-12 15:11:59 +00001764 return NULL;
1765 }
1766 old_key = ep->me_key;
1767 Py_INCREF(dummy);
1768 ep->me_key = dummy;
1769 old_value = ep->me_value;
1770 ep->me_value = NULL;
1771 mp->ma_used--;
1772 Py_DECREF(old_key);
1773 return old_value;
1774}
1775
1776static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001777dict_popitem(dictobject *mp)
Guido van Rossumba6ab842000-12-12 22:02:18 +00001778{
Tim Peters9b10f7e2006-05-30 04:16:25 +00001779 Py_ssize_t i = 0;
Guido van Rossumba6ab842000-12-12 22:02:18 +00001780 dictentry *ep;
1781 PyObject *res;
1782
Tim Petersf4b33f62001-06-02 05:42:29 +00001783 /* Allocate the result tuple before checking the size. Believe it
1784 * or not, this allocation could trigger a garbage collection which
1785 * could empty the dict, so if we checked the size first and that
1786 * happened, the result would be an infinite loop (searching for an
1787 * entry that no longer exists). Note that the usual popitem()
1788 * idiom is "while d: k, v = d.popitem()". so needing to throw the
Tim Peters9b10f7e2006-05-30 04:16:25 +00001789 * tuple away if the dict *is* empty isn't a significant
Tim Petersf4b33f62001-06-02 05:42:29 +00001790 * inefficiency -- possible, but unlikely in practice.
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001791 */
1792 res = PyTuple_New(2);
1793 if (res == NULL)
1794 return NULL;
Guido van Rossume04eaec2001-04-16 00:02:32 +00001795 if (mp->ma_used == 0) {
1796 Py_DECREF(res);
1797 PyErr_SetString(PyExc_KeyError,
1798 "popitem(): dictionary is empty");
1799 return NULL;
1800 }
Guido van Rossumba6ab842000-12-12 22:02:18 +00001801 /* Set ep to "the first" dict entry with a value. We abuse the hash
1802 * field of slot 0 to hold a search finger:
1803 * If slot 0 has a value, use slot 0.
1804 * Else slot 0 is being used to hold a search finger,
Neal Norwitzd3881b02006-05-30 04:25:05 +00001805 * and we use its hash value as the first index to look.
Guido van Rossumba6ab842000-12-12 22:02:18 +00001806 */
1807 ep = &mp->ma_table[0];
1808 if (ep->me_value == NULL) {
Tim Peters9b10f7e2006-05-30 04:16:25 +00001809 i = ep->me_hash;
Tim Petersdea48ec2001-05-22 20:40:22 +00001810 /* The hash field may be a real hash value, or it may be a
1811 * legit search finger, or it may be a once-legit search
1812 * finger that's out of bounds now because it wrapped around
1813 * or the table shrunk -- simply make sure it's in bounds now.
Guido van Rossumba6ab842000-12-12 22:02:18 +00001814 */
Tim Petersafb6ae82001-06-04 21:00:21 +00001815 if (i > mp->ma_mask || i < 1)
Guido van Rossumba6ab842000-12-12 22:02:18 +00001816 i = 1; /* skip slot 0 */
1817 while ((ep = &mp->ma_table[i])->me_value == NULL) {
1818 i++;
Tim Petersafb6ae82001-06-04 21:00:21 +00001819 if (i > mp->ma_mask)
Guido van Rossumba6ab842000-12-12 22:02:18 +00001820 i = 1;
1821 }
1822 }
Guido van Rossuma4dd0112001-04-15 22:16:26 +00001823 PyTuple_SET_ITEM(res, 0, ep->me_key);
1824 PyTuple_SET_ITEM(res, 1, ep->me_value);
1825 Py_INCREF(dummy);
1826 ep->me_key = dummy;
1827 ep->me_value = NULL;
1828 mp->ma_used--;
1829 assert(mp->ma_table[0].me_value == NULL);
1830 mp->ma_table[0].me_hash = i + 1; /* next place to start */
Guido van Rossumba6ab842000-12-12 22:02:18 +00001831 return res;
1832}
1833
Jeremy Hylton8caad492000-06-23 14:18:11 +00001834static int
1835dict_traverse(PyObject *op, visitproc visit, void *arg)
1836{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001837 Py_ssize_t i = 0;
Jeremy Hylton8caad492000-06-23 14:18:11 +00001838 PyObject *pk;
1839 PyObject *pv;
1840
1841 while (PyDict_Next(op, &i, &pk, &pv)) {
Thomas Woutersc6e55062006-04-15 21:47:09 +00001842 Py_VISIT(pk);
1843 Py_VISIT(pv);
Jeremy Hylton8caad492000-06-23 14:18:11 +00001844 }
1845 return 0;
1846}
1847
1848static int
1849dict_tp_clear(PyObject *op)
1850{
1851 PyDict_Clear(op);
1852 return 0;
1853}
1854
Tim Petersf7f88b12000-12-13 23:18:45 +00001855
Raymond Hettinger019a1482004-03-18 02:41:19 +00001856extern PyTypeObject PyDictIterKey_Type; /* Forward */
1857extern PyTypeObject PyDictIterValue_Type; /* Forward */
1858extern PyTypeObject PyDictIterItem_Type; /* Forward */
1859static PyObject *dictiter_new(dictobject *, PyTypeObject *);
Guido van Rossum09e563a2001-05-01 12:10:21 +00001860
1861static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001862dict_iterkeys(dictobject *dict)
Guido van Rossum09e563a2001-05-01 12:10:21 +00001863{
Raymond Hettinger019a1482004-03-18 02:41:19 +00001864 return dictiter_new(dict, &PyDictIterKey_Type);
Guido van Rossum09e563a2001-05-01 12:10:21 +00001865}
1866
1867static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001868dict_itervalues(dictobject *dict)
Guido van Rossum09e563a2001-05-01 12:10:21 +00001869{
Raymond Hettinger019a1482004-03-18 02:41:19 +00001870 return dictiter_new(dict, &PyDictIterValue_Type);
Guido van Rossum09e563a2001-05-01 12:10:21 +00001871}
1872
1873static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001874dict_iteritems(dictobject *dict)
Guido van Rossum09e563a2001-05-01 12:10:21 +00001875{
Raymond Hettinger019a1482004-03-18 02:41:19 +00001876 return dictiter_new(dict, &PyDictIterItem_Type);
Guido van Rossum09e563a2001-05-01 12:10:21 +00001877}
1878
1879
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001880PyDoc_STRVAR(has_key__doc__,
Raymond Hettinger574aa322003-09-01 22:12:08 +00001881"D.has_key(k) -> True if D has a key k, else False");
Tim Petersf7f88b12000-12-13 23:18:45 +00001882
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00001883PyDoc_STRVAR(contains__doc__,
1884"D.__contains__(k) -> True if D has a key k, else False");
1885
1886PyDoc_STRVAR(getitem__doc__, "x.__getitem__(y) <==> x[y]");
1887
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001888PyDoc_STRVAR(get__doc__,
Guido van Rossumefae8862002-09-04 11:29:45 +00001889"D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.");
Tim Petersf7f88b12000-12-13 23:18:45 +00001890
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001891PyDoc_STRVAR(setdefault_doc__,
Guido van Rossumefae8862002-09-04 11:29:45 +00001892"D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D");
Tim Petersf7f88b12000-12-13 23:18:45 +00001893
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001894PyDoc_STRVAR(pop__doc__,
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +00001895"D.pop(k[,d]) -> v, remove specified key and return the corresponding value\n\
1896If key is not found, d is returned if given, otherwise KeyError is raised");
Guido van Rossume027d982002-04-12 15:11:59 +00001897
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001898PyDoc_STRVAR(popitem__doc__,
Tim Petersf7f88b12000-12-13 23:18:45 +00001899"D.popitem() -> (k, v), remove and return some (key, value) pair as a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000019002-tuple; but raise KeyError if D is empty");
Tim Petersf7f88b12000-12-13 23:18:45 +00001901
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001902PyDoc_STRVAR(keys__doc__,
1903"D.keys() -> list of D's keys");
Tim Petersf7f88b12000-12-13 23:18:45 +00001904
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001905PyDoc_STRVAR(items__doc__,
1906"D.items() -> list of D's (key, value) pairs, as 2-tuples");
Tim Petersf7f88b12000-12-13 23:18:45 +00001907
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001908PyDoc_STRVAR(values__doc__,
1909"D.values() -> list of D's values");
Tim Petersf7f88b12000-12-13 23:18:45 +00001910
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001911PyDoc_STRVAR(update__doc__,
Walter Dörwaldd70ad8a2004-05-28 20:59:21 +00001912"D.update(E, **F) -> None. Update D from E and F: for k in E: D[k] = E[k]\n\
1913(if E has keys else: for (k, v) in E: D[k] = v) then: for k in F: D[k] = F[k]");
Tim Petersf7f88b12000-12-13 23:18:45 +00001914
Raymond Hettingere33d3df2002-11-27 07:29:33 +00001915PyDoc_STRVAR(fromkeys__doc__,
1916"dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.\n\
1917v defaults to None.");
1918
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001919PyDoc_STRVAR(clear__doc__,
1920"D.clear() -> None. Remove all items from D.");
Tim Petersf7f88b12000-12-13 23:18:45 +00001921
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001922PyDoc_STRVAR(copy__doc__,
1923"D.copy() -> a shallow copy of D");
Tim Petersf7f88b12000-12-13 23:18:45 +00001924
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001925PyDoc_STRVAR(iterkeys__doc__,
1926"D.iterkeys() -> an iterator over the keys of D");
Guido van Rossum09e563a2001-05-01 12:10:21 +00001927
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001928PyDoc_STRVAR(itervalues__doc__,
1929"D.itervalues() -> an iterator over the values of D");
Guido van Rossum09e563a2001-05-01 12:10:21 +00001930
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001931PyDoc_STRVAR(iteritems__doc__,
1932"D.iteritems() -> an iterator over the (key, value) items of D");
Guido van Rossum09e563a2001-05-01 12:10:21 +00001933
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001934static PyMethodDef mapp_methods[] = {
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00001935 {"__contains__",(PyCFunction)dict_has_key, METH_O | METH_COEXIST,
1936 contains__doc__},
Raymond Hettinger0c669672003-12-13 13:31:55 +00001937 {"__getitem__", (PyCFunction)dict_subscript, METH_O | METH_COEXIST,
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00001938 getitem__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001939 {"has_key", (PyCFunction)dict_has_key, METH_O,
Tim Petersf7f88b12000-12-13 23:18:45 +00001940 has_key__doc__},
1941 {"get", (PyCFunction)dict_get, METH_VARARGS,
1942 get__doc__},
1943 {"setdefault", (PyCFunction)dict_setdefault, METH_VARARGS,
1944 setdefault_doc__},
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +00001945 {"pop", (PyCFunction)dict_pop, METH_VARARGS,
Just van Rossuma797d812002-11-23 09:45:04 +00001946 pop__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001947 {"popitem", (PyCFunction)dict_popitem, METH_NOARGS,
Tim Petersf7f88b12000-12-13 23:18:45 +00001948 popitem__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001949 {"keys", (PyCFunction)dict_keys, METH_NOARGS,
Tim Petersf7f88b12000-12-13 23:18:45 +00001950 keys__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001951 {"items", (PyCFunction)dict_items, METH_NOARGS,
Tim Petersf7f88b12000-12-13 23:18:45 +00001952 items__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001953 {"values", (PyCFunction)dict_values, METH_NOARGS,
Tim Petersf7f88b12000-12-13 23:18:45 +00001954 values__doc__},
Raymond Hettinger31017ae2004-03-04 08:25:44 +00001955 {"update", (PyCFunction)dict_update, METH_VARARGS | METH_KEYWORDS,
Tim Petersf7f88b12000-12-13 23:18:45 +00001956 update__doc__},
Raymond Hettingere33d3df2002-11-27 07:29:33 +00001957 {"fromkeys", (PyCFunction)dict_fromkeys, METH_VARARGS | METH_CLASS,
1958 fromkeys__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001959 {"clear", (PyCFunction)dict_clear, METH_NOARGS,
Tim Petersf7f88b12000-12-13 23:18:45 +00001960 clear__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001961 {"copy", (PyCFunction)dict_copy, METH_NOARGS,
Tim Petersf7f88b12000-12-13 23:18:45 +00001962 copy__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001963 {"iterkeys", (PyCFunction)dict_iterkeys, METH_NOARGS,
Guido van Rossum09e563a2001-05-01 12:10:21 +00001964 iterkeys__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001965 {"itervalues", (PyCFunction)dict_itervalues, METH_NOARGS,
Guido van Rossum09e563a2001-05-01 12:10:21 +00001966 itervalues__doc__},
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001967 {"iteritems", (PyCFunction)dict_iteritems, METH_NOARGS,
Guido van Rossum09e563a2001-05-01 12:10:21 +00001968 iteritems__doc__},
Tim Petersf7f88b12000-12-13 23:18:45 +00001969 {NULL, NULL} /* sentinel */
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001970};
1971
Tim Petersd770ebd2006-06-01 15:50:44 +00001972/* Return 1 if `key` is in dict `op`, 0 if not, and -1 on error. */
Raymond Hettingerbc0f2ab2003-11-25 21:12:14 +00001973int
1974PyDict_Contains(PyObject *op, PyObject *key)
Guido van Rossum0dbb4fb2001-04-20 16:50:40 +00001975{
1976 long hash;
Raymond Hettingerbc0f2ab2003-11-25 21:12:14 +00001977 dictobject *mp = (dictobject *)op;
Armin Rigo35f6d362006-06-01 13:19:12 +00001978 dictentry *ep;
Guido van Rossum0dbb4fb2001-04-20 16:50:40 +00001979
Tim Peters0ab085c2001-09-14 00:25:33 +00001980 if (!PyString_CheckExact(key) ||
Tim Peters1f7df352002-03-29 03:29:08 +00001981 (hash = ((PyStringObject *) key)->ob_shash) == -1) {
Guido van Rossum0dbb4fb2001-04-20 16:50:40 +00001982 hash = PyObject_Hash(key);
1983 if (hash == -1)
1984 return -1;
1985 }
Armin Rigo35f6d362006-06-01 13:19:12 +00001986 ep = (mp->ma_lookup)(mp, key, hash);
Tim Petersd770ebd2006-06-01 15:50:44 +00001987 return ep == NULL ? -1 : (ep->me_value != NULL);
Guido van Rossum0dbb4fb2001-04-20 16:50:40 +00001988}
1989
Guido van Rossum0dbb4fb2001-04-20 16:50:40 +00001990/* Hack to implement "key in dict" */
1991static PySequenceMethods dict_as_sequence = {
Georg Brandl347b3002006-03-30 11:57:00 +00001992 0, /* sq_length */
1993 0, /* sq_concat */
1994 0, /* sq_repeat */
1995 0, /* sq_item */
1996 0, /* sq_slice */
1997 0, /* sq_ass_item */
1998 0, /* sq_ass_slice */
1999 PyDict_Contains, /* sq_contains */
2000 0, /* sq_inplace_concat */
2001 0, /* sq_inplace_repeat */
Guido van Rossum0dbb4fb2001-04-20 16:50:40 +00002002};
2003
Guido van Rossum09e563a2001-05-01 12:10:21 +00002004static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002005dict_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2006{
2007 PyObject *self;
2008
2009 assert(type != NULL && type->tp_alloc != NULL);
2010 self = type->tp_alloc(type, 0);
2011 if (self != NULL) {
2012 PyDictObject *d = (PyDictObject *)self;
2013 /* It's guaranteed that tp->alloc zeroed out the struct. */
2014 assert(d->ma_table == NULL && d->ma_fill == 0 && d->ma_used == 0);
2015 INIT_NONZERO_DICT_SLOTS(d);
2016 d->ma_lookup = lookdict_string;
2017#ifdef SHOW_CONVERSION_COUNTS
2018 ++created;
2019#endif
2020 }
2021 return self;
2022}
2023
Tim Peters25786c02001-09-02 08:22:48 +00002024static int
2025dict_init(PyObject *self, PyObject *args, PyObject *kwds)
2026{
Raymond Hettinger31017ae2004-03-04 08:25:44 +00002027 return dict_update_common(self, args, kwds, "dict");
Tim Peters25786c02001-09-02 08:22:48 +00002028}
2029
Guido van Rossumdbb53d92001-12-03 16:32:18 +00002030static long
2031dict_nohash(PyObject *self)
2032{
2033 PyErr_SetString(PyExc_TypeError, "dict objects are unhashable");
2034 return -1;
2035}
2036
Tim Peters6d6c1a32001-08-02 04:15:00 +00002037static PyObject *
Guido van Rossum09e563a2001-05-01 12:10:21 +00002038dict_iter(dictobject *dict)
2039{
Raymond Hettinger019a1482004-03-18 02:41:19 +00002040 return dictiter_new(dict, &PyDictIterKey_Type);
Guido van Rossum09e563a2001-05-01 12:10:21 +00002041}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002042
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002043PyDoc_STRVAR(dictionary_doc,
Tim Petersa427a2b2001-10-29 22:25:45 +00002044"dict() -> new empty dictionary.\n"
2045"dict(mapping) -> new dictionary initialized from a mapping object's\n"
Tim Peters1fc240e2001-10-26 05:06:50 +00002046" (key, value) pairs.\n"
Tim Petersa427a2b2001-10-29 22:25:45 +00002047"dict(seq) -> new dictionary initialized as if via:\n"
Tim Peters4d859532001-10-27 18:27:48 +00002048" d = {}\n"
2049" for k, v in seq:\n"
Just van Rossuma797d812002-11-23 09:45:04 +00002050" d[k] = v\n"
2051"dict(**kwargs) -> new dictionary initialized with the name=value pairs\n"
2052" in the keyword argument list. For example: dict(one=1, two=2)");
Tim Peters25786c02001-09-02 08:22:48 +00002053
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002054PyTypeObject PyDict_Type = {
2055 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002056 0,
Tim Petersa427a2b2001-10-29 22:25:45 +00002057 "dict",
Neil Schemenauere83c00e2001-08-29 23:54:21 +00002058 sizeof(dictobject),
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002059 0,
Guido van Rossumb9324202001-01-18 00:39:02 +00002060 (destructor)dict_dealloc, /* tp_dealloc */
2061 (printfunc)dict_print, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002062 0, /* tp_getattr */
Guido van Rossumb9324202001-01-18 00:39:02 +00002063 0, /* tp_setattr */
Tim Peters4fa58bf2001-05-10 21:45:19 +00002064 (cmpfunc)dict_compare, /* tp_compare */
Guido van Rossumb9324202001-01-18 00:39:02 +00002065 (reprfunc)dict_repr, /* tp_repr */
2066 0, /* tp_as_number */
Guido van Rossum0dbb4fb2001-04-20 16:50:40 +00002067 &dict_as_sequence, /* tp_as_sequence */
Guido van Rossumb9324202001-01-18 00:39:02 +00002068 &dict_as_mapping, /* tp_as_mapping */
Guido van Rossumdbb53d92001-12-03 16:32:18 +00002069 dict_nohash, /* tp_hash */
Guido van Rossumb9324202001-01-18 00:39:02 +00002070 0, /* tp_call */
2071 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002072 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossumb9324202001-01-18 00:39:02 +00002073 0, /* tp_setattro */
2074 0, /* tp_as_buffer */
Neil Schemenauere83c00e2001-08-29 23:54:21 +00002075 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
Tim Peters6d6c1a32001-08-02 04:15:00 +00002076 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters25786c02001-09-02 08:22:48 +00002077 dictionary_doc, /* tp_doc */
Georg Brandl347b3002006-03-30 11:57:00 +00002078 dict_traverse, /* tp_traverse */
2079 dict_tp_clear, /* tp_clear */
Tim Peterse63415e2001-05-08 04:38:29 +00002080 dict_richcompare, /* tp_richcompare */
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002081 0, /* tp_weaklistoffset */
Guido van Rossum09e563a2001-05-01 12:10:21 +00002082 (getiterfunc)dict_iter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002083 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002084 mapp_methods, /* tp_methods */
2085 0, /* tp_members */
2086 0, /* tp_getset */
2087 0, /* tp_base */
2088 0, /* tp_dict */
2089 0, /* tp_descr_get */
2090 0, /* tp_descr_set */
2091 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002092 dict_init, /* tp_init */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002093 PyType_GenericAlloc, /* tp_alloc */
2094 dict_new, /* tp_new */
Neil Schemenauer6189b892002-04-12 02:43:00 +00002095 PyObject_GC_Del, /* tp_free */
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002096};
2097
Guido van Rossum3cca2451997-05-16 14:23:33 +00002098/* For backward compatibility with old dictionary interface */
2099
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002100PyObject *
Martin v. Löwis32b4a1b2002-12-11 13:21:12 +00002101PyDict_GetItemString(PyObject *v, const char *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002102{
Guido van Rossum3cca2451997-05-16 14:23:33 +00002103 PyObject *kv, *rv;
2104 kv = PyString_FromString(key);
2105 if (kv == NULL)
2106 return NULL;
Guido van Rossum3cca2451997-05-16 14:23:33 +00002107 rv = PyDict_GetItem(v, kv);
2108 Py_DECREF(kv);
2109 return rv;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002110}
2111
2112int
Martin v. Löwis32b4a1b2002-12-11 13:21:12 +00002113PyDict_SetItemString(PyObject *v, const char *key, PyObject *item)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002114{
Guido van Rossum3cca2451997-05-16 14:23:33 +00002115 PyObject *kv;
2116 int err;
2117 kv = PyString_FromString(key);
2118 if (kv == NULL)
Guido van Rossum037b2201997-05-20 18:35:19 +00002119 return -1;
Guido van Rossum4f3bf1e1997-09-29 23:31:11 +00002120 PyString_InternInPlace(&kv); /* XXX Should we really? */
Guido van Rossum3cca2451997-05-16 14:23:33 +00002121 err = PyDict_SetItem(v, kv, item);
2122 Py_DECREF(kv);
2123 return err;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002124}
2125
2126int
Martin v. Löwis32b4a1b2002-12-11 13:21:12 +00002127PyDict_DelItemString(PyObject *v, const char *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002128{
Guido van Rossum3cca2451997-05-16 14:23:33 +00002129 PyObject *kv;
2130 int err;
2131 kv = PyString_FromString(key);
2132 if (kv == NULL)
Guido van Rossum037b2201997-05-20 18:35:19 +00002133 return -1;
Guido van Rossum3cca2451997-05-16 14:23:33 +00002134 err = PyDict_DelItem(v, kv);
2135 Py_DECREF(kv);
2136 return err;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00002137}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002138
Raymond Hettinger019a1482004-03-18 02:41:19 +00002139/* Dictionary iterator types */
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002140
2141typedef struct {
2142 PyObject_HEAD
Guido van Rossum2147df72002-07-16 20:30:22 +00002143 dictobject *di_dict; /* Set to NULL when iterator is exhausted */
Tim Peters9b10f7e2006-05-30 04:16:25 +00002144 Py_ssize_t di_used;
2145 Py_ssize_t di_pos;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002146 PyObject* di_result; /* reusable result tuple for iteritems */
Tim Peters9b10f7e2006-05-30 04:16:25 +00002147 Py_ssize_t len;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002148} dictiterobject;
2149
2150static PyObject *
Raymond Hettinger019a1482004-03-18 02:41:19 +00002151dictiter_new(dictobject *dict, PyTypeObject *itertype)
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002152{
2153 dictiterobject *di;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002154 di = PyObject_New(dictiterobject, itertype);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002155 if (di == NULL)
2156 return NULL;
2157 Py_INCREF(dict);
2158 di->di_dict = dict;
Guido van Rossumb1f35bf2001-05-02 15:13:44 +00002159 di->di_used = dict->ma_used;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002160 di->di_pos = 0;
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002161 di->len = dict->ma_used;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002162 if (itertype == &PyDictIterItem_Type) {
2163 di->di_result = PyTuple_Pack(2, Py_None, Py_None);
2164 if (di->di_result == NULL) {
2165 Py_DECREF(di);
2166 return NULL;
2167 }
2168 }
2169 else
2170 di->di_result = NULL;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002171 return (PyObject *)di;
2172}
2173
2174static void
2175dictiter_dealloc(dictiterobject *di)
2176{
Guido van Rossum2147df72002-07-16 20:30:22 +00002177 Py_XDECREF(di->di_dict);
Raymond Hettinger019a1482004-03-18 02:41:19 +00002178 Py_XDECREF(di->di_result);
Neil Schemenauer6189b892002-04-12 02:43:00 +00002179 PyObject_Del(di);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002180}
2181
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002182static PyObject *
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002183dictiter_len(dictiterobject *di)
2184{
Tim Peters9b10f7e2006-05-30 04:16:25 +00002185 Py_ssize_t len = 0;
Raymond Hettinger7892b1c2004-04-12 18:10:01 +00002186 if (di->di_dict != NULL && di->di_used == di->di_dict->ma_used)
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002187 len = di->len;
Tim Peters9b10f7e2006-05-30 04:16:25 +00002188 return PyInt_FromSize_t(len);
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002189}
2190
Armin Rigof5b3e362006-02-11 21:32:43 +00002191PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002192
2193static PyMethodDef dictiter_methods[] = {
Armin Rigof5b3e362006-02-11 21:32:43 +00002194 {"__length_hint__", (PyCFunction)dictiter_len, METH_NOARGS, length_hint_doc},
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002195 {NULL, NULL} /* sentinel */
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002196};
2197
Raymond Hettinger019a1482004-03-18 02:41:19 +00002198static PyObject *dictiter_iternextkey(dictiterobject *di)
Guido van Rossum213c7a62001-04-23 14:08:49 +00002199{
Raymond Hettinger019a1482004-03-18 02:41:19 +00002200 PyObject *key;
Tim Peters9b10f7e2006-05-30 04:16:25 +00002201 register Py_ssize_t i, mask;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002202 register dictentry *ep;
2203 dictobject *d = di->di_dict;
Guido van Rossum213c7a62001-04-23 14:08:49 +00002204
Raymond Hettinger019a1482004-03-18 02:41:19 +00002205 if (d == NULL)
Guido van Rossum2147df72002-07-16 20:30:22 +00002206 return NULL;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002207 assert (PyDict_Check(d));
Guido van Rossum2147df72002-07-16 20:30:22 +00002208
Raymond Hettinger019a1482004-03-18 02:41:19 +00002209 if (di->di_used != d->ma_used) {
Guido van Rossum213c7a62001-04-23 14:08:49 +00002210 PyErr_SetString(PyExc_RuntimeError,
2211 "dictionary changed size during iteration");
Guido van Rossum2147df72002-07-16 20:30:22 +00002212 di->di_used = -1; /* Make this state sticky */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002213 return NULL;
2214 }
Guido van Rossum2147df72002-07-16 20:30:22 +00002215
Raymond Hettinger019a1482004-03-18 02:41:19 +00002216 i = di->di_pos;
2217 if (i < 0)
2218 goto fail;
2219 ep = d->ma_table;
2220 mask = d->ma_mask;
2221 while (i <= mask && ep[i].me_value == NULL)
2222 i++;
2223 di->di_pos = i+1;
2224 if (i > mask)
2225 goto fail;
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002226 di->len--;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002227 key = ep[i].me_key;
2228 Py_INCREF(key);
2229 return key;
2230
2231fail:
2232 Py_DECREF(d);
Guido van Rossum2147df72002-07-16 20:30:22 +00002233 di->di_dict = NULL;
Guido van Rossum213c7a62001-04-23 14:08:49 +00002234 return NULL;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002235}
2236
Raymond Hettinger019a1482004-03-18 02:41:19 +00002237PyTypeObject PyDictIterKey_Type = {
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002238 PyObject_HEAD_INIT(&PyType_Type)
2239 0, /* ob_size */
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002240 "dictionary-keyiterator", /* tp_name */
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002241 sizeof(dictiterobject), /* tp_basicsize */
2242 0, /* tp_itemsize */
2243 /* methods */
2244 (destructor)dictiter_dealloc, /* tp_dealloc */
2245 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002246 0, /* tp_getattr */
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002247 0, /* tp_setattr */
2248 0, /* tp_compare */
2249 0, /* tp_repr */
2250 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002251 0, /* tp_as_sequence */
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002252 0, /* tp_as_mapping */
2253 0, /* tp_hash */
2254 0, /* tp_call */
2255 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002256 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002257 0, /* tp_setattro */
2258 0, /* tp_as_buffer */
2259 Py_TPFLAGS_DEFAULT, /* tp_flags */
2260 0, /* tp_doc */
2261 0, /* tp_traverse */
2262 0, /* tp_clear */
2263 0, /* tp_richcompare */
2264 0, /* tp_weaklistoffset */
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +00002265 PyObject_SelfIter, /* tp_iter */
Raymond Hettinger019a1482004-03-18 02:41:19 +00002266 (iternextfunc)dictiter_iternextkey, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002267 dictiter_methods, /* tp_methods */
2268 0,
Raymond Hettinger019a1482004-03-18 02:41:19 +00002269};
2270
2271static PyObject *dictiter_iternextvalue(dictiterobject *di)
2272{
2273 PyObject *value;
Tim Peters9b10f7e2006-05-30 04:16:25 +00002274 register Py_ssize_t i, mask;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002275 register dictentry *ep;
2276 dictobject *d = di->di_dict;
2277
2278 if (d == NULL)
2279 return NULL;
2280 assert (PyDict_Check(d));
2281
2282 if (di->di_used != d->ma_used) {
2283 PyErr_SetString(PyExc_RuntimeError,
2284 "dictionary changed size during iteration");
2285 di->di_used = -1; /* Make this state sticky */
2286 return NULL;
2287 }
2288
2289 i = di->di_pos;
Guido van Rossum09240f62004-03-20 19:11:58 +00002290 mask = d->ma_mask;
2291 if (i < 0 || i > mask)
Raymond Hettinger019a1482004-03-18 02:41:19 +00002292 goto fail;
2293 ep = d->ma_table;
Guido van Rossum09240f62004-03-20 19:11:58 +00002294 while ((value=ep[i].me_value) == NULL) {
Raymond Hettinger019a1482004-03-18 02:41:19 +00002295 i++;
Guido van Rossum09240f62004-03-20 19:11:58 +00002296 if (i > mask)
2297 goto fail;
2298 }
Raymond Hettinger019a1482004-03-18 02:41:19 +00002299 di->di_pos = i+1;
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002300 di->len--;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002301 Py_INCREF(value);
2302 return value;
2303
2304fail:
2305 Py_DECREF(d);
2306 di->di_dict = NULL;
2307 return NULL;
2308}
2309
2310PyTypeObject PyDictIterValue_Type = {
2311 PyObject_HEAD_INIT(&PyType_Type)
2312 0, /* ob_size */
2313 "dictionary-valueiterator", /* tp_name */
2314 sizeof(dictiterobject), /* tp_basicsize */
2315 0, /* tp_itemsize */
2316 /* methods */
2317 (destructor)dictiter_dealloc, /* tp_dealloc */
2318 0, /* tp_print */
2319 0, /* tp_getattr */
2320 0, /* tp_setattr */
2321 0, /* tp_compare */
2322 0, /* tp_repr */
2323 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002324 0, /* tp_as_sequence */
Raymond Hettinger019a1482004-03-18 02:41:19 +00002325 0, /* tp_as_mapping */
2326 0, /* tp_hash */
2327 0, /* tp_call */
2328 0, /* tp_str */
2329 PyObject_GenericGetAttr, /* tp_getattro */
2330 0, /* tp_setattro */
2331 0, /* tp_as_buffer */
2332 Py_TPFLAGS_DEFAULT, /* tp_flags */
2333 0, /* tp_doc */
2334 0, /* tp_traverse */
2335 0, /* tp_clear */
2336 0, /* tp_richcompare */
2337 0, /* tp_weaklistoffset */
2338 PyObject_SelfIter, /* tp_iter */
2339 (iternextfunc)dictiter_iternextvalue, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002340 dictiter_methods, /* tp_methods */
2341 0,
Raymond Hettinger019a1482004-03-18 02:41:19 +00002342};
2343
2344static PyObject *dictiter_iternextitem(dictiterobject *di)
2345{
2346 PyObject *key, *value, *result = di->di_result;
Tim Peters9b10f7e2006-05-30 04:16:25 +00002347 register Py_ssize_t i, mask;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002348 register dictentry *ep;
2349 dictobject *d = di->di_dict;
2350
2351 if (d == NULL)
2352 return NULL;
2353 assert (PyDict_Check(d));
2354
2355 if (di->di_used != d->ma_used) {
2356 PyErr_SetString(PyExc_RuntimeError,
2357 "dictionary changed size during iteration");
2358 di->di_used = -1; /* Make this state sticky */
2359 return NULL;
2360 }
2361
2362 i = di->di_pos;
2363 if (i < 0)
2364 goto fail;
2365 ep = d->ma_table;
2366 mask = d->ma_mask;
2367 while (i <= mask && ep[i].me_value == NULL)
2368 i++;
2369 di->di_pos = i+1;
2370 if (i > mask)
2371 goto fail;
2372
2373 if (result->ob_refcnt == 1) {
2374 Py_INCREF(result);
2375 Py_DECREF(PyTuple_GET_ITEM(result, 0));
2376 Py_DECREF(PyTuple_GET_ITEM(result, 1));
2377 } else {
2378 result = PyTuple_New(2);
Tim Peters60b29962006-01-01 01:19:23 +00002379 if (result == NULL)
Raymond Hettinger019a1482004-03-18 02:41:19 +00002380 return NULL;
2381 }
Raymond Hettinger0ce6dc82004-03-18 08:38:00 +00002382 di->len--;
Raymond Hettinger019a1482004-03-18 02:41:19 +00002383 key = ep[i].me_key;
2384 value = ep[i].me_value;
2385 Py_INCREF(key);
2386 Py_INCREF(value);
2387 PyTuple_SET_ITEM(result, 0, key);
2388 PyTuple_SET_ITEM(result, 1, value);
2389 return result;
2390
2391fail:
2392 Py_DECREF(d);
2393 di->di_dict = NULL;
2394 return NULL;
2395}
2396
2397PyTypeObject PyDictIterItem_Type = {
2398 PyObject_HEAD_INIT(&PyType_Type)
2399 0, /* ob_size */
2400 "dictionary-itemiterator", /* tp_name */
2401 sizeof(dictiterobject), /* tp_basicsize */
2402 0, /* tp_itemsize */
2403 /* methods */
2404 (destructor)dictiter_dealloc, /* tp_dealloc */
2405 0, /* tp_print */
2406 0, /* tp_getattr */
2407 0, /* tp_setattr */
2408 0, /* tp_compare */
2409 0, /* tp_repr */
2410 0, /* tp_as_number */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002411 0, /* tp_as_sequence */
Raymond Hettinger019a1482004-03-18 02:41:19 +00002412 0, /* tp_as_mapping */
2413 0, /* tp_hash */
2414 0, /* tp_call */
2415 0, /* tp_str */
2416 PyObject_GenericGetAttr, /* tp_getattro */
2417 0, /* tp_setattro */
2418 0, /* tp_as_buffer */
2419 Py_TPFLAGS_DEFAULT, /* tp_flags */
2420 0, /* tp_doc */
2421 0, /* tp_traverse */
2422 0, /* tp_clear */
2423 0, /* tp_richcompare */
2424 0, /* tp_weaklistoffset */
2425 PyObject_SelfIter, /* tp_iter */
2426 (iternextfunc)dictiter_iternextitem, /* tp_iternext */
Raymond Hettinger6b27cda2005-09-24 21:23:05 +00002427 dictiter_methods, /* tp_methods */
2428 0,
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002429};