Are dictionary .keys() and .values() always in the same order?

Question

It looks like the lists returned by the keys() and values() methods of a dictionary are always a 1-to-1 mapping (assuming the dictionary is not altered between calling the two methods).

For example:

>>> d = {'one': 1, 'two': 2, 'three': 3}
>>> k, v = list(d.keys()), list(d.values())
>>> for i in range(len(k)):
...     print(d[k[i]] == v[i])
... 
True
True
True

If you do not alter the dictionary between calling keys() and calling values(), is it wrong to assume the above for-loop will always print True?

In CPython 3.7 (and up, presumably) you may rely on the iteration order of a dictionary matching insertion order. https://mail.python.org/pipermail/python-dev/2017-December/151283.html — BallpointBen, Apr 19 '18 at 18:47
@BallpointBen it's in CPython 3.6 and up and all other Python implementations starting with Python 3.7 — Boris Verkhovskiy, May 19 '20 at 14:43

score 457 · Accepted Answer · edited Dec 19 '16 at 13:03

457

Found this:

If items(), keys(), values(), iteritems(), iterkeys(), and itervalues() are called with no intervening modifications to the dictionary, the lists will directly correspond.

On 2.x documentation and 3.x documentation.

edited Dec 19 '16 at 13:03

David Fraser

6,475
1
40
56

answered May 07 '09 at 15:45

nosklo

217,122
57
293
297

7

apparently the statement in the 3.x documentation is clearer: "the order of items will directly correspond" – Shaohua Li May 08 '16 at 03:49
10

This text is missing in the 3.7 documentation. I can only assume it's because "Dict keeps insertion order" in 3.7: https://mail.python.org/pipermail/python-dev/2017-December/151283.html – EliadL Jan 23 '19 at 16:40
1

Correct; before, the iteration order wasn't predictable, but it was *consistent*. Predictable iteration order implies consistency. – chepner Mar 24 '22 at 01:06
@chepner "consistent" meaning that if I call `values()` after `keys()`, it is guaranteed that the order of `values()` is the same as the order of `keys()`? – robertspierre Oct 13 '22 at 06:55

score 103 · Answer 2 · edited Dec 10 '20 at 14:11

103

Yes, what you observed is indeed a guaranteed property -- keys(), values() and items() return lists in congruent order if the dict is not altered. iterkeys() &c also iterate in the same order as the corresponding lists.

edited Dec 10 '20 at 14:11

vvvvv

25,404
19
49
81

answered May 07 '09 at 14:49

Alex Martelli

854,459
170
1,222
1,395

1

However, in case the list *is* altered, Pandas `dataframe` offers an alternative where items can be updated or deleted, and the order and the index locations of the items in a dict-like structure remain fixed. – Ville Mar 18 '19 at 01:40

Bjorn · Answer 3 · 2014-06-03T14:50:20.190

51

Yes it is guaranteed in python 2.x:

If keys, values and items views are iterated over with no intervening modifications to the dictionary, the order of items will directly correspond.

edited Jun 03 '14 at 14:50

answered May 07 '09 at 15:20

Bjorn

69,215
39
136
164

Boris Verkhovskiy · Answer 4 · 2019-04-24T17:58:56.723

18

Yes. Starting with CPython 3.6, dictionaries return items in the order you inserted them.

Ignore the part that says this is an implementation detail. This behaviour is guaranteed in CPython 3.6 and is required for all other Python implementations starting with Python 3.7.

edited Apr 24 '19 at 17:58

answered Dec 16 '17 at 19:16

Boris Verkhovskiy

14,854
11
100
103

score 7 · Answer 5 · answered Jun 25 '18 at 09:06

7

Good references to the docs. Here's how you can guarantee the order regardless of the documentation / implementation:

k, v = zip(*d.iteritems())

answered Jun 25 '18 at 09:06

Sassa NF

5,306
15
22

1

In python3.x, use dict.items() – Good Will Mar 28 '19 at 20:14

score 5 · Answer 6 · answered May 07 '09 at 15:10

According to http://docs.python.org/dev/py3k/library/stdtypes.html#dictionary-view-objects , the keys(), values() and items() methods of a dict will return corresponding iterators whose orders correspond. However, I am unable to find a reference to the official documentation for python 2.x for the same thing.

So as far as I can tell, the answer is yes, but only in python 3.0+

score 4 · Answer 7 · answered May 07 '09 at 15:21

For what it's worth, some heavy used production code I have written is based on this assumption and I never had a problem with it. I know that doesn't make it true though :-)

If you don't want to take the risk I would use iteritems() if you can.

for key, value in myDictionary.iteritems():
    print key, value

Gregory Sky · Answer 8 · 2022-06-30T15:55:08.977

I would agree with others that in python 3.6+ it should stay the same if unaffected by user.

an example from my code few days ago:

ips = { '001' : '199.250.178.14', '002' : '199.18.2.89', '003' : '109.251.63.21' }
def run(self):
    for x, y in self.ips.items():
                try:
                    subprocess.check_call(
                    ['ping', '-n', '1', y],
                    stdout=DEVNULL,  # suppress output
                    stderr=DEVNULL
                    )
                except subprocess.CalledProcessError:
                    nextServer = ('HUB ' + x + ' is OFFLINE   ' + " IP:   " + y)

and the output is always of the same order, exactly as i inputted it i.e. only offline servers will show up in order: HUB 003 is OFFLINE IP: 109.251.63.21 becasue first two are reachable

Hope that clears it out

score -1 · Answer 9 · answered Jul 12 '17 at 16:10

I wasn't satisfied with these answers since I wanted to ensure the exported values had the same ordering even when using different dicts.

Here you specify the key order upfront, the returned values will always have the same order even if the dict changes, or you use a different dict.

keys = dict1.keys()
ordered_keys1 = [dict1[cur_key] for cur_key in keys]
ordered_keys2 = [dict2[cur_key] for cur_key in keys]

Are dictionary .keys() and .values() always in the same order?

9 Answers9

Linked

Related