defaultdict python_python中defaultdict方法的使用

預設值可以很友善

衆所周知，在Python中如果通路字典中不存在的鍵，會引發KeyError異常（JavaScript中如果對象中不存在某個屬性，則傳回undefined）。但是有時候，字典中的每個鍵都存在預設值是非常友善的。例如下面的例子：

strings = ('puppy', 'kitten', 'puppy', 'puppy','weasel', 'puppy', 'kitten', 'puppy')

counts={}for kw instrings:

counts[kw]+= 1

該例子統計strings中某個單詞出現的次數，并在counts字典中作記錄。單詞每出現一次，在counts相對應的鍵所存的值數字加1。但是事實上，運作這段代碼會抛出KeyError異常，出現的時機是每個單詞第一次統計的時候，因為Python的dict中不存在預設值的說法，可以在Python指令行中驗證：

>>> counts =dict()>>>counts

{}>>> counts['puppy'] += 1Traceback (most recent call last):

File"", line 1, in KeyError:'puppy'

使用判斷語句檢查

既然如此，首先可能想到的方法是在單詞第一次統計的時候，在counts中相應的鍵存下預設值1。這需要在處理的時候添加一個判斷語句：

strings = ('puppy', 'kitten', 'puppy', 'puppy','weasel', 'puppy', 'kitten', 'puppy')

counts={}for kw instrings:if kw not incounts:

counts[kw]= 1

else:

counts[kw]+= 1

#counts:#{'puppy': 5, 'weasel': 1, 'kitten': 2}

使用dict.setdefault()方法

也可以通過dict.setdefault()方法來設定預設值：

strings = ('puppy', 'kitten', 'puppy', 'puppy','weasel', 'puppy', 'kitten', 'puppy')

counts={}for kw instrings:

counts.setdefault(kw, 0)

counts[kw]+= 1

dict.setdefault()方法接收兩個參數，第一個參數是健的名稱，第二個參數是預設值。假如字典中不存在給定的鍵，則傳回參數中提供的預設值；反之，則傳回字典中儲存的值。利用dict.setdefault()方法的傳回值可以重寫for循環中的代碼，使其更加簡潔：

strings = ('puppy', 'kitten', 'puppy', 'puppy','weasel', 'puppy', 'kitten', 'puppy')

counts={}for kw instrings:

counts[kw]= counts.setdefault(kw, 0) + 1

使用collections.defaultdict類

以上的方法雖然在一定程度上解決了dict中不存在預設值的問題，但是這時候我們會想，有沒有一種字典它本身提供了預設值的功能呢？答案是肯定的，那就是collections.defaultdict。

defaultdict類就好像是一個dict，但是它是使用一個類型來初始化的：

>>> from collections importdefaultdict>>> dd =defaultdict(list)>>>dd

defaultdict(, {})

defaultdict類的初始化函數接受一個類型作為參數，當所通路的鍵不存在的時候，可以執行個體化一個值作為預設值：

>>> dd['foo']

[]>>>dd

defaultdict(, {'foo': []})>>> dd['bar'].append('quux')>>>dd

defaultdict(, {'foo': [], 'bar': ['quux']})

需要注意的是，這種形式的預設值隻有在通過dict[key]或者dict.__getitem__(key)通路的時候才有效，這其中的原因在下文會介紹。

>>> from collections importdefaultdict>>> dd =defaultdict(list)>>> 'something' indd

False>>> dd.pop('something')

Traceback (most recent call last):

File"", line 1, in KeyError:'pop(): dictionary is empty'

>>> dd.get('something')>>> dd['something']

[]

defaultdict類除了接受類型名稱作為初始化函數的參數之外，還可以使用任何不帶參數的可調用函數，到時該函數的傳回結果作為預設值，這樣使得預設值的取值更加靈活。下面用一個例子來說明，如何用自定義的不帶參數的函數zero()作為defaultdict類的初始化函數的參數：

>>> from collections importdefaultdict>>> defzero():

...return0

...>>> dd =defaultdict(zero)>>>dd

defaultdict(, {})>>> dd['foo']

0>>>dd

defaultdict(, {'foo': 0})

利用collections.defaultdict來解決最初的單詞統計問題，代碼如下：

from collections importdefaultdict

strings= ('puppy', 'kitten', 'puppy', 'puppy','weasel', 'puppy', 'kitten', 'puppy')

counts= defaultdict(lambda: 0) #使用lambda來定義簡單的函數

for s instrings:

counts[s]+= 1

defaultdict類是如何實作的

通過上面的内容，想必大家已經了解了defaultdict類的用法，那麼在defaultdict類中又是如何來實作預設值的功能呢？這其中的關鍵是使用了看__missing__()這個方法：

>>> from collections importdefaultdict>>> print defaultdict.__missing__.__doc__

__missing__(key) #Called by __getitem__ for missing key; pseudo-code:

if self.default_factory is None: raiseKeyError(key)

self[key]= value =self.default_factory()return value

通過檢視__missing__()方法的docstring，可以看出當使用__getitem__()方法通路一個不存在的鍵時(dict[key]這種形式實際上是__getitem__()方法的簡化形式)，會調用__missing__()方法擷取預設值，并将該鍵添加到字典中去。

關于__missing__()方法的具體介紹可以參考Python官方文檔中的"Mapping Types — dict"一節。

文檔中介紹，從2.5版本開始，如果派生自dict的子類定義了__missing__()方法，當通路不存在的鍵時，dict[key]會調用__missing__()方法取得預設值。

從中可以看出，雖然dict支援__missing__()方法，但是在dict本身是不存在這個方法的，而是需要在派生的子類中自行實作這個方法。可以簡單的驗證這一點：

>>> print dict.__missing__.__doc__Traceback (most recent call last):

File"", line 1, in AttributeError: type object'dict' has no attribute '__missing__'

同時，我們可以進一步的做實驗，定義一個子類Missing并實作__missing__()方法:

>>> classMissing(dict):

...def __missing__(self, key):

...return 'missing'...>>> d =Missing()>>>d

{}>>> d['foo']'missing'

>>>d

{}

傳回結果反映了__missing__()方法确實發揮了作用。在此基礎上，我們稍許修改__missing__()方法,使得該子類同defautldict類一樣為不存在的鍵設定一個預設值：

>>> classDefaulting(dict):

...def __missing__(self, key):

... self[key]= 'default'...return 'default'...>>> d =Defaulting()>>>d

{}>>> d['foo']'default'

>>>d

{'foo': 'default'}

在舊版本的Python中實作類defaultdict的功能

defaultdict類是從2.5版本之後才添加的，在一些舊版本中并不支援它，是以為舊版本實作一個相容的defaultdict類是必要的。這其實很簡單，雖然性能可能未必如2.5版本中自帶的defautldict類好，但在功能上是一樣的。

首先，__getitem__()方法需要在通路鍵失敗時，調用__missing__()方法：

classdefaultdict(dict):def __getitem__(self, key):try:return dict.__getitem__(self, key)exceptKeyError:return self.__missing__(key)

其次，需要實作__missing__()方法用來設定預設值：

classdefaultdict(dict):def __getitem__(self, key):try:return dict.__getitem__(self, key)exceptKeyError:return self.__missing__(key)def __missing__(self, key):

self[key]= value =self.default_factory()return value

然後，defaultdict類的初始化函數__init__()需要接受類型或者可調用函數參數:

classdefaultdict(dict):def __init__(self, default_factory=None, *a, **kw):

dict.__init__(self, *a, **kw)

self.default_factory=default_factorydef __getitem__(self, key):try:return dict.__getitem__(self, key)exceptKeyError:return self.__missing__(key)def __missing__(self, key):

self[key]= value =self.default_factory()return value

最後，綜合以上内容，通過以下方式完成相容新舊Python版本的代碼：

try:from collections importdefaultdictexceptImportError:classdefaultdict(dict):def __init__(self, default_factory=None, *a, **kw):

dict.__init__(self, *a, **kw)

self.default_factory=default_factorydef __getitem__(self, key):try:return dict.__getitem__(self, key)exceptKeyError:return self.__missing__(key)def __missing__(self, key):

self[key]= value =self.default_factory()return value