Is it safe to use frozen set as Dict key?

balki picture balki · Feb 17, 2015 · Viewed 25.3k times · Source

It obviously works but are there cases where two sets of same elements happen to add two entries in Dict? I guess I got this condition earlier and changed my code from frozenset(...) to tuple(sorted(frozenset(...))). Can someone who knows how Dict and frozenset implementation confirm if that is required or not?

Answer

Friendly King picture Friendly King · Feb 17, 2015

Is it safe to use a frozenset as a dict key? Yes.

According to the docs, Frozenset is hashable because it's immutable. This would imply that it can be used as the key to a dict, because the prerequisite for a key is that it is hashable.

From the FrozenSet docs

The frozenset type is immutable and hashable — its contents cannot be altered after it is created; it can therefore be used as a dictionary key or as an element of another set.

And redundantly, from the Dictionary docs:

...keys, which can be any immutable type


To clarify, a set (by definition), frozen or not, does not preserve order. They are stored internally with order not taken into account and with duplicate elements removed, so two sets built in different orders would be equivalent keys in a dictionary – they are the same.

>>> frozenset([1,2,2,3,3]) == frozenset([3,2,1,1,1])
True

and likewise,

>>> d = {}
>>> d[frozenset([1,1,2,3])] = 'hello'
>>> d[frozenset([1,2,3,3])]
'hello'
>>> d[frozenset([3,3,3,2,1,1,1])]
'hello'
>>> d[frozenset([2,1,3])]
'hello'