Python中的字典数据结构

关于我
一个有思想的程序猿，终身学习实践者，目前在一个创业团队任team lead，技术栈涉及Android、Python、Java和Go，这个也是我们团队的主要技术栈。
Github：https://github.com/hylinux1024
微信公众号：终身开发者(angrycode)

字典又称为哈希表(hashmap)、映射(map)，它是以key-value的方式进行存储，通过key进行存储、查找操作的效率非常高。在Python编码中字典也是非常非常常用的一种数据结构。
今天就看下Python中有哪些实现字典的数据结构。
本文中提到的代码都是Python3.7中执行的。

字典的存储其实很像一个数组。在字典中的key对象是必须实现__hash__和__eq__方法的。在字典在查找时会计算key的hash值，然后通过模运算快速的定位到“数组”的下标，如果这个下标只有一个元素，那么就直接返回该value；如果有多个元素都存储在同一个下标里面，就再使用__eq__方法进行比较，相同者返回。

0x00 dict

dict估计是最常用到的一种数据结构了，可以存储Python中的对象。

>>> d = {'one':1,'two':2,'three':33}
>>> d
{'one': 1, 'two': 2, 'three': 33}
# 在for循环中默认是遍历keys
>>> keys = [k for k in d]
>>> keys
['one', 'two', 'three']
# 也可以使用
>>> keys = [x for x in d.keys()]
>>> keys
['one', 'two', 'three']
# 遍历values
>>> values = [v for v in d.values()]
>>> values
[1, 2, 33]
# 如果要遍历key,value可以使用dict.items()方法，它返回一个(k,v)元组
>>> kvs = [(k,v) for k,v in d.items()]
>>> kvs
[('one', 1), ('two', 2), ('three', 33)]

现在Python3.6以上版本中的dict是非常强大的，遍历时会保持元素插入Python中的顺序

>>> d = {'z':2,'a':'111','b':0.99}
>>> d
# 输出时保持元素的插入顺序
{'z': 2, 'a': '111', 'b': 0.99}

当获取一个不存在的key，将会抛出KeyError。

>>> d['k']
Traceback (most recent call last):
  File "", line 1, in 
    d['k']
KeyError: 'k'

如果不想抛出异常错误信息，那么可以使用get方法，并可以指定当key不存在时，返回默认值。这个方法在实际的编码中也是非常实用的。

# 当`key`不存在时，指定返回默认值
>>> d.get('k',314)
314

例如在WEB应用解析服务器端返回的json数据时，常常会把json数据解析成一个字典，如果服务端的某个字段缺失了，而客户端使用下标的方法来进行访问元素时，就会出现KeyError。要让自己的程序更加健壮，那么就可以使用get方法。

0x01 collections.OrderedDict

OrderedDict能保持元素的存储顺序，如果你使用的Python版本还比较低，或者为了兼容旧版本的Python，而且你的需求中对元素的插入顺序比较重要的话，那么可以使用这个类。

>>> import collections
>>> d = collections.OrderedDict(one=1, two=2, three=3)
>>> d
OrderedDict([('one', 1), ('two', 2), ('three', 3)])
>>> d['one']
1
>>> d['four']
# 同样地，如果key不存在，也会抛出KeyError
KeyError: 'four'
>>> d.get('four',4)
4
>>> d.keys()
odict_keys(['one', 'two', 'three'])
>>> d.items()
odict_items([('one', 1), ('two', 2), ('three', 3)])

0x02 collections.defaultdict

当获取一个不存在的key时提供默认值。defaultdict在构造的时候就需要提供一个默认类型，用于当key不存在时，构造默认的类型。

例如我构造一个用户未读数列表，通过用户ID来获取用户的未读数，当在字典中没有找到用户ID时，默认的未读数就是0。

>>> from collections import defaultdict
# 使用defaultdict构造一个用户未读数字典，并传入int类型作为默认值的类型
>>> user_unreads = defaultdict(int)
# 给ID为123，121，120的用户添加的未读数
>>> user_unreads[123]=2
>>> user_unreads['121']=3
>>> user_unreads['120']=9
>>> user_unreads
defaultdict(, {123: 2, '121': 3, '120': 9})
>>> user_unreads['121']
3
# 当获取一个不存在的字典中的用户ID时，使用默认值
>>> user_unreads['129']
0

defaultdict构造函数还是可以使用其它类型，例如list

>>> dd = defaultdict(list)
>>> dd
defaultdict(, {})
>>> dd['user_list']
[]
>>> dd['user_list'].append('jack')
>>> dd['user_list'].append('tom')
>>> dd['user_list'].append('rose')
>>> dd
defaultdict(, {'user_list': ['jack', 'tom', 'rose']})

0x03 collections.ChainMap

ChainMap类可以方便地处理多个字典的操作。例如将两个字典拼接到一起

>>> from collections import ChainMap
>>> d1 = {'one': 1, 'two': 2}
>>> d2 = {'three': 3, 'four': 4}
>>> chain = ChainMap(d1, d2)
>>> chain
ChainMap({'one': 1, 'two': 2}, {'three': 3, 'four': 4})
>>> chain['two']
2
>>> chain['five']
# 获取一个不存在的key，会抛出KeyError
KeyError: 'five'

0x04 types.MappingProxyType

types.MappingProxyType类可以构造一个只读的字典，这个对数据的封装和控制非常有用。例如当我们不希望有人修改我们的数据时，可以考虑使用这个类。

该类内部其实是对内置dict的封装，对外提供一个只读接口，当被封装的类修改了，这MappingProxyType的对象也会发生变化。

>>> from types import MappingProxyType
# 构造一个普通的字典
>>> writable = {'one': 1, 'two': 2}
# 通过MappingProxyType构造函数封装字典
>>> read_only = MappingProxyType(writable)
>>> read_only['one']
1
>>> read_only['one'] = 23
# 如果对mappingproxy对象进行修改，则会抛出异常
TypeError: 'mappingproxy' object does not support item assignment
# 可以对原始对象进行修改，这个修改也会立刻响应到mappingproxy对象中去
>>> writable['one'] = 42
>>> read_only
mappingproxy({'one': 42, 'two': 2})

0x05 总结一下

一般来说，内置dict对象已经足以满足我们大部分的需求开发，这也是我们使用字典这种数据类型的首选的数据结构。如果你有其它一些特殊需求，可以看看这里列出的OrderedDict、defaultdict、ChainMap和MappingProxyType。

0x06 学习资料

• https://docs.python.org/3/library/collections.html#collections.OrderedDict
• Python Tricks: A Buffet of Awesome Python Features
  ——Dan Bader