理解 Python 語言中的 defaultdict

原作者: Jason Kirtland
日期: January 13th, 2009
許可證: Creative Commons Attribution-Share Alike 3.0
原文鏈接(PPT): http://discorporate.us/jek/talks/defaultdict/
翻譯作者：kodango dangoakachan@foxmail.com
翻譯時(shí)間：March 17th, 2012

今天看到一篇講defaultdict的PPT，同時(shí)第一次見到__missing__()這個(gè)方法，好奇之下，仔細(xì)閱讀了這篇PPT。看完之后隨手做筆記，分享給有需要的人。準(zhǔn)確地說，這篇文章不是純粹的翻譯，因?yàn)樵谋旧碇皇且环軵PT。文章的大多數(shù)文字內(nèi)容，都是本人的閱讀心得。

默認(rèn)值可以很方便

眾所周知，在Python中如果訪問字典中不存在的鍵，會(huì)引發(fā)KeyError異常（JavaScript中如果對象中不存在某個(gè)屬性，則返回undefined）。但是有時(shí)候，字典中的每個(gè)鍵都存在默認(rèn)值是非常方便的。例如下面的例子：

 strings = ('puppy', 'kitten', 'puppy', 'puppy',
     ...:            'weasel', 'puppy', 'kitten', 'puppy')
     ...: counts = {}
     ...: 
     ...: for kw in strings:
     ...:     counts[kw] += 1

該例子統(tǒng)計(jì)strings中某個(gè)單詞出現(xiàn)的次數(shù)，并在counts字典中作記錄。單詞每出現(xiàn)一次，在counts相對應(yīng)的鍵所存的值數(shù)字加1。但是事實(shí)上，運(yùn)行這段代碼會(huì)拋出KeyError異常，出現(xiàn)的時(shí)機(jī)是每個(gè)單詞第一次統(tǒng)計(jì)的時(shí)候，因?yàn)镻ython的dict中不存在默認(rèn)值的說法，可以在Python命令行中驗(yàn)證：

>>> counts = dict()
>>> counts
{}
>>> counts['puppy'] += 1
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'puppy'

使用判斷語句檢查

既然如此，首先可能想到的方法是在單詞第一次統(tǒng)計(jì)的時(shí)候，在counts中相應(yīng)的鍵存下默認(rèn)值1。這需要在處理的時(shí)候添加一個(gè)判斷語句：

strings = ('puppy', 'kitten', 'puppy', 'puppy',
           'weasel', 'puppy', 'kitten', 'puppy')
counts = {}

for kw in strings:
    if kw not in counts:
        counts[kw] = 1
    else:
        counts[kw] += 1

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

使用dict.setdefault()方法

也可以通過dict.setdefault()方法來設(shè)置默認(rèn)值：

strings = ('puppy', 'kitten', 'puppy', 'puppy',
           'weasel', 'puppy', 'kitten', 'puppy')
counts = {}

for kw in strings:
    counts.setdefault(kw, 0)
    counts[kw] += 1 # 原PPT中這里有一個(gè)筆誤

dict.setdefault()方法接收兩個(gè)參數(shù)，第一個(gè)參數(shù)是健的名稱，第二個(gè)參數(shù)是默認(rèn)值。假如字典中不存在給定的鍵，則返回參數(shù)中提供的默認(rèn)值；反之，則返回字典中保存的值。利用dict.setdefault()方法的返回值可以重寫for循環(huán)中的代碼，使其更加簡潔：

strings = ('puppy', 'kitten', 'puppy', 'puppy',
           'weasel', 'puppy', 'kitten', 'puppy')
counts = {}

for kw in strings:
    counts[kw] = counts.setdefault(kw, 0) + 1

使用collections.defaultdict類

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

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

>>> from collections import defaultdict
>>> dd = defaultdict(list)
>>> dd
defaultdict(<type 'list'>, {})

defaultdict類的初始化函數(shù)接受一個(gè)類型作為參數(shù)，當(dāng)所訪問的鍵不存在的時(shí)候，可以實(shí)例化一個(gè)值作為默認(rèn)值：

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

需要注意的是，這種形式的默認(rèn)值只有在通過dict[key]或者dict.__getitem__(key)訪問的時(shí)候才有效，這其中的原因在下文會(huì)介紹。

>>> from collections import defaultdict
>>> dd = defaultdict(list)
>>> 'something' in dd
False
>>> dd.pop('something')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'pop(): dictionary is empty'
>>> dd.get('something')
>>> dd['something']
[]

該類除了接受類型名稱作為初始化函數(shù)的參數(shù)之外，還可以使用任何不帶參數(shù)的可調(diào)用函數(shù)，到時(shí)該函數(shù)的返回結(jié)果作為默認(rèn)值，這樣使得默認(rèn)值的取值更加靈活。下面用一個(gè)例子來說明，如何用自定義的不帶參數(shù)的函數(shù)zero()作為初始化函數(shù)的參數(shù)：

>>> from collections import defaultdict
>>> def zero():
...     return 0
...
>>> dd = defaultdict(zero)
>>> dd
defaultdict(<function zero at 0xb7ed2684>, {})
>>> dd['foo']
0
>>> dd
defaultdict(<function zero at 0xb7ed2684>, {'foo': 0})

利用collections.defaultdict來解決最初的單詞統(tǒng)計(jì)問題，代碼如下：

from collections import defaultdict

strings = ('puppy', 'kitten', 'puppy', 'puppy',
           'weasel', 'puppy', 'kitten', 'puppy')
counts = defaultdict(lambda: 0)  # 使用lambda來定義簡單的函數(shù)

for s in strings:
    counts[s] += 1

defaultdict 類是如何實(shí)現(xiàn)的

通過上面的內(nèi)容，想必大家已經(jīng)了解了defaultdict類的用法，那么在defaultdict類中又是如何來實(shí)現(xiàn)默認(rèn)值的功能呢？這其中的關(guān)鍵是使用了看__missing__()這個(gè)方法：

>>> from collections import defaultdict
>>> print defaultdict.__missing__.__doc__
__missing__(key) # Called by __getitem__ for missing key; pseudo-code:
  if self.default_factory is None: raise KeyError(key)
  self[key] = value = self.default_factory()
  return value

通過查看__missing__()方法的docstring，可以看出當(dāng)使用__getitem__()方法訪問一個(gè)不存在的鍵時(shí)(dict[key]這種形式實(shí)際上是__getitem__()方法的簡化形式)，會(huì)調(diào)用__missing__()方法獲取默認(rèn)值，并將該鍵添加到字典中去。

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

文檔中介紹，從2.5版本開始，如果派生自dict的子類定義了__missing__()方法，當(dāng)訪問不存在的鍵時(shí)，dict[key]會(huì)調(diào)用__missing__()方法取得默認(rèn)值。

從中可以看出，雖然dict支持__missing__()方法，但是在dict本身是不存在這個(gè)方法的，而是需要在派生的子類中自行實(shí)現(xiàn)這個(gè)方法?？梢院唵蔚尿?yàn)證這一點(diǎn)：

>>> print dict.__missing__.__doc__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: type object 'dict' has no attribute '__missing__'

同時(shí)，我們可以進(jìn)一步的做實(shí)驗(yàn)，定義一個(gè)子類Missing并實(shí)現(xiàn)__missing__()方法:

>>> class Missing(dict):
...     def __missing__(self, key):
...         return 'missing'
...
>>> d = Missing()
>>> d
{}
>>> d['foo']
'missing'
>>> d
{}

返回結(jié)果反映了__missing__()方法確實(shí)發(fā)揮了作用。在此基礎(chǔ)上，我們稍許修改__missing__()方法,使得該子類同defautldict類一樣為不存在的鍵設(shè)置一個(gè)默認(rèn)值：

>>> class Defaulting(dict):
...     def __missing__(self, key):
...         self[key] = 'default'
...         return 'default'
...
>>> d = Defaulting()
>>> d
{}
>>> d['foo']
'default'
>>> d
{'foo': 'default'}

在舊版本的 Python 中實(shí)現(xiàn) defaultdict 的功能

defaultdict類是從2.5版本之后才添加的，在一些舊版本中并不支持它，因此為舊版本實(shí)現(xiàn)一個(gè)兼容的defaultdict類是必要的。這其實(shí)很簡單，雖然性能可能未必如2.5版本中自帶的defautldict類好，但在功能上是一樣的。

首先，__getitem__()方法需要在訪問鍵失敗時(shí)，調(diào)用__missing__()方法：

class defaultdict(dict):
    def __getitem__(self, key):
        try:
            return dict.__getitem__(self, key)
        except KeyError:
            return self.__missing__(key)

其次，需要實(shí)現(xiàn)__missing__()方法用來設(shè)置默認(rèn)值：


class defaultdict(dict):
    def __getitem__(self, key):
        try:
            return dict.__getitem__(self, key)
        except KeyError:
            return self.__missing__(key)

    def __missing__(self, key):
        self[key] = value = self.default_factory()
        return value

然后，defaultdict類的初始化函數(shù)__init__()需要接受類型或者可調(diào)用函數(shù)參數(shù):

class defaultdict(dict):
    def __init__(self, default_factory=None, *a, **kw):
        dict.__init__(self, *a, **kw)
        self.default_factory = default_factory

    def __getitem__(self, key):
        try:
            return dict.__getitem__(self, key)
        except KeyError:
            return self.__missing__(key)

    def __missing__(self, key):
        self[key] = value = self.default_factory()
        return value

最后，綜合以上內(nèi)容，通過以下方式完成兼容新舊Python版本的代碼：


try:
    from collections import defaultdict
except ImportError:
    class defaultdict(dict):
      def __init__(self, default_factory=None, *a, **kw):
          dict.__init__(self, *a, **kw)
          self.default_factory = default_factory

      def __getitem__(self, key):
          try:
              return dict.__getitem__(self, key)
          except KeyError:
              return self.__missing__(key)

      def __missing__(self, key):
          self[key] = value = self.default_factory()
          return value

轉(zhuǎn)自：http://kodango.com/understand-defaultdict-in-python

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容