Python 的 defaultdict 模塊和 namedtuple 模塊(xianglong.me)

在Python中有一些內置的數據類型，好比int, str, list, tuple, dict等。Python的collections模塊在這些內置數據類型的基礎上，提供了幾個額外的數據類型：namedtuple, defaultdict, deque, Counter, OrderedDict等，其中defaultdict和namedtuple是兩個很實用的擴展類型。defaultdict繼承自dict，namedtuple繼承自tuple。

1、defaultdict

1. 簡介

在使用Python原生的數據結構dict的時候，若是用d[key]這樣的方式訪問，當指定的key不存在時，是會拋出KeyError異常的。可是，若是使用defaultdict，只要你傳入一個默認的工廠方法，那麼請求一個不存在的key時， 便會調用這個工廠方法使用其結果來做爲這個key的默認值。

defaultdict在使用的時候須要傳一個工廠函數(function_factory)，defaultdict(function_factory)會構建一個相似dict的對象，該對象具備默認值，默認值經過調用工廠函數生成。

2. 示例

下面給一個defaultdict的使用示例：

In [1]: from collections import defaultdict

In [2]: s = [('xiaoming', 99), ('wu', 69), ('zhangsan', 80), ('lisi', 96), ('wu', 100), ('yuan', 98), ('xiaoming', 89)]

In [3]: d = defaultdict(list)

In [4]: for k, v in s:
   ...:     d[k].append(v)
   ...:     

In [5]: d
Out[5]: defaultdict(<type 'list'>, {'lisi': [96], 'xiaoming': [99, 89], 'yuan': [98], 'zhangsan': [80], 'wu': [69, 100]})

In [6]: for k, v in d.items():
   ...:     print '%s: %s' % (k, v)
   ...:     
lisi: [96]
xiaoming: [99, 89]
yuan: [98]
zhangsan: [80]
wu: [69, 100]

對Python比較熟悉的同窗能夠發現defaultdict(list)的用法和dict.setdefault(key, [])比較相似，上述代碼使用setdefault實現以下：

s = [('xiaoming', 99), ('wu', 69), ('zhangsan', 80), ('lisi', 96), ('wu', 100), ('yuan', 98), ('xiaoming', 89)]
d = {}

for k, v in s:
    d.setdefault(k, []).append(v)

3. 原理

從以上的例子中，咱們能夠基本了defaultdict的用法，下面咱們能夠經過help(defaultdict)瞭解一下defaultdict的原理。經過Python console打印出的help信息來看，咱們能夠發現defaultdict具備默認值主要是經過missing方法實現的，若是工廠函數不爲None，則經過工廠方法返回默認值，具體以下：

def __missing__(self, key):
    # Called by __getitem__ for missing key
    if self.default_factory is None:
        raise KeyError((key,))
    self[key] = value = self.default_factory()
    return value

從上面的說明中，咱們能夠發現一下幾個須要注意的地方：

1. missing方法是在調用getitem方法發現KEY不存在時才調用的，因此，defaultdict也只會在使用d[key]或者d.getitem(key)的時候纔會生成默認值；若是使用d.get(key)是不會返回默認值的，會出現KeyError；

2. defaultdict主要是經過missing方法實現，因此，咱們也能夠經過實現該方法來生成本身的defaultdict，代碼入下

   In [1]: class MyDefaultDict(dict):
      ...:     def __missing__(self, key):
      ...:         self[key] = 'default'
      ...:         return 'default'
      ...:     
   
   In [2]: my_default_dict = MyDefaultDict()
   
   In [3]: my_default_dict
   Out[3]: {}
   
   In [4]: print my_default_dict['test']
   default
   
   In [5]: my_default_dict
   Out[5]: {'test': 'default'}

4. 版本

defaultdict是在Python 2.5以後才加入的功能，在舊版本的Python中是不支持這個功能的，不過，知道了它的原理，咱們能夠本身實現一個defaultdict。

# http://code.activestate.com/recipes/523034/
try:
    from collections import defaultdict
except:
    class defaultdict(dict):

        def __init__(self, default_factory=None, *a, **kw):
            if (default_factory is not None and
                not hasattr(default_factory, '__call__')):
                raise TypeError('first argument must be callable')
            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):
            if self.default_factory is None:
                raise KeyError(key)
            self[key] = value = self.default_factory()
            return value

        def __reduce__(self):
            if self.default_factory is None:
                args = tuple()
            else:
                args = self.default_factory,
            return type(self), args, None, None, self.items()

        def copy(self):
            return self.__copy__()

        def __copy__(self):
            return type(self)(self.default_factory, self)

        def __deepcopy__(self, memo):
            import copy
            return type(self)(self.default_factory, copy.deepcopy(self.items()))

        def __repr__(self):
            return 'defaultdict(%s, %s)' % (self.default_factory, dict.__repr__(self))

2、namedtuple

namedtuple主要用來產生可使用名稱來訪問元素的數據對象，一般用來加強代碼的可讀性，在訪問一些tuple類型的數據時尤爲好用。其實，在大部分時候你應該使用namedtuple替代tuple，這樣可讓你的代碼更容易讀懂，更加pythonic。舉個例子：

from collections import namedtuple

# 變量名和namedtuple中的第一個參數通常保持一致，但也能夠不同
Student = namedtuple('Student', 'id name score')
# 或者 Student = namedtuple('Student', ['id', 'name', 'score'])

students = [(1, 'Wu', 90), (2, 'Xing', 89), (3, 'Yuan', 98), (4, 'Wang', 95)]

for s in students:
    stu = Student._make(s)
    print stu

# Output:
# Student(id=1, name='Wu', score=90)
# Student(id=2, name='Xing', score=89)
# Student(id=3, name='Yuan', score=98)
# Student(id=4, name='Wang', score=95)

在上面的例子中，Student就是一個namedtuple，它和tuple的使用方法同樣，能夠經過index直接取，並且是隻讀的。這種方式比tuple容易理解多了，能夠很清楚的知道每一個值表明的含義。

Over!