Python中的defaultdict方法

字典（dictionary）是Python中一种经常使用的数据类型。不一样于其余由数字索引的序列，字典是用"键"（key）来索引的。一般表示为dict(key: val, ...)，有如下特征：

• 键能够是任何不可变（immutable）数据类型，如数字，字符串和仅包含不可变数据类型的元组
• 每一个键必须是惟一的
• 字典中每一项的顺序是任意的

---

1. KeyError异常

在Python中若是访问字典里不存在的键，会出现KeyError异常。有些时候，字典中每一个键都存在默认值是很方便的，例以下面的例子：

>>> bag = ['apple', 'orange', 'cherry', 'apple',
...        'apple', 'cherry', 'blueberry'}]
>>> count = {}
>>> for fruit in bag:
...     count[fruit] += 1
...
Traceback (most recent call last):
    File "<stdin>", line 2, in <module>
KeyError: 'apple'

上例统计列表bag中单词出现次数，并记录在字典count中。单词没出现一次，count中对应的键值会增长一。可是在实习运行代码时，每当单词第一次被统计就会出现'KeyError'异常，这是由于它并不在字典count中，Python中dict对象并不存在默认值。

---

2. 使用判断语句检查

所以，在单词第一次被统计时，须要在count中给每一个键设定一个默认值1，这能够用一个判断语句来实现：

>>> for fruit in bag:
...     if fruit not in count:    #若是不存在，添加
...             count[fruit] = 1
...     else:
...             count[fruit] += 1
...
>>> count
{'apple': 3, 'blueberry': 1, 'orange': 1, 'cherry': 2}

---

3. 使用dict.setdefault()方法

dict.setdefault(key[,default])方法接受两个参数，第一个是键的名称，第二个参数是默认值。在调用时若是键存在字典中，会返回它的值；若是不存在，则会自动把它添加进字典中并返回默认值，default的默认值为None。此外，default的值还能够是列表，元组，集合和字典等。

>>> d = {'a': 1, 'b': 2}
>>> d.setdefault('a')    #键存在并返回他的值
1
>>> d.setdefault('c', 3)     #添加键-值
3
>>> d.setdefault('d')    #只添加键，默认值为None
>>> d
{'a': 1, 'b': 2, 'c': 3, 'd': None}

接下来用它来实现上一个例子：

>>> count = {}
>>> for fruit in bag:
...     count.setdefault(fruit, 0)
...     count[fruit] += 1
...
>>> count
{'apple': 3, 'orange': 1, 'cherry': 2, 'blueberry': 1}

或者更简洁一些：

>>> for fruit in bag:
...     count[fruit] = count.setdefault(fruit, 0) + 1

---

4. 使用collections.defaultdict类

class collections.defaultdict([default_factory[, ...]])

defaultdict是Python内建dict类的一个子类，第一个参数为default_factory属性提供初始值，默认为None。它覆盖一个方法并添加一个可写实例变量。它的其余功能与dict相同，但会为一个不存在的键提供默认值，从而避免KeyError异常。以前例子的实现以下：

>>> from collections import defaultdict
>>> count = defaultdict(int)
>>> for fruit in bag:
...     count[fruit] += 1
...
>>> count
defaultdict(<class 'int'>, {'apple': 3, 'orange': 1, 'cherry': 2, 'blueberry': 1})

4.1. 类型名称做为初始化函数参数

首先它能够接受类型名称来做为初始化函数的参数，好比以前的例子中以int类名称做为参数。除了标准dict操做，它还支持__missing__(key)方法，经过参考官方文档，它的机制以下：

若是default_factory为None，会抛出以key为参数的KeyError异常。

>>> d = defaultdict()    #default_factory为None
>>> d['eric']
Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
KeyError: 'eric'

若是default_factory不为None， 此处原文为：

" It is called without arguments to provide a default value for the given key, this value is inserted in the dictionary for the key, and returned."。
大概翻译了下：它会在不接收任何参数的状况下被调用，来为给定的键提供默认值，这个值会被添加进字典并被返回。

>>> d = defaultdict(list)    #default_factory是列表名称
>>> d['eric']    #访问一个不存在的键
[]            #添加并返回默认值（一个空列表）
>>> d
defaultdict(<class 'list'>, {'eric': []})

由于defaultdict是dict的一个子类，事实上访问一个不存在的键时，dict类中的__getitem__方法会调用子类中__missing__()方法（但它不能直接被dict的实例调用），而且返回或抛出__missing__()方法所返回的值和抛出的异常。所以，若是调用default_factory引起一个异常，该异常传播不变（propagated unchanged）。

请注意除__getitem__()以外的任何操做都不会调用__missing __()。 这意味着像正常的字典同样，get()将返回None做为默认值，而不是使用default_factory。

另外，还能够给字典中的键映射多个值，具体方法是把多个值储存在另外一个容器里（如列表，元组，字典等）。是否使用列表或集合的选择取决于预期用途：使用列表来保存每一项的插入顺序；若是要消除重复的项（不关心顺序），可使用元组。

>>> from collections import defaultdict
>>> d = defaultdict(list)
>>> for i in [1,2,3]:
...     d['eric'].append(i)
...
>>> d
defaultdict(<class 'list'>, {'eric': [1, 2, 3]})

>>> d['amy'] = {}
>>> d['amy']['a'] = 1
>>> d
defaultdict(<class 'list'>, {'eric': [1, 2, 3], 'amy': {'a': 1}})

能够看出，给定默认值的类型以后并不意味着字典中全部值都必须是此类型，也能够是其余类型。还能使用相应的方法来对行操做，如列表的append和pop等方法。

4.2. 可调用函数做为初始化函数参数

除了接受类型名称做为初始化函数的参数以外，还可使用任何不带参数的可调用函数，并以该函数返回值做为默认值。例如，定义函数zero()让默认值为0：

>>> from collections import defaultdict
>>> def zero():
...     return 0
...
>>> d = defaultdict(zero)
>>> d['eric']
0
>>> d
defaultdict(<function zero at 0x100662e18>, {'eric': 0})

或者使用lambda函数：

>>> d = defaultdict(lambda: 0)
>>> d['amy']
0
>>> d
defaultdict(<function <lambda> at 0x1019d3d90>, {'amy': 0})

须要注意的是， defaultdict接受的参数必须是可调用的。若直接传递数字0，就会出现TyptError的异常。

>>> d = defaultdict(0)
Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
TypeError: first argument must be callable or None

---

声明：

文章仅供学习及参考，禁止转载。

参考：

• Python3.6: defaultdict
• Python中defaultdict方法的使用