共计 3424 个字符,预计需要花费 9 分钟才能阅读完成。
collections
是 Python 内建的一个集合模块,提供了许多有用的集合类。
namedtuple
我们知道 tuple
可以表示不变集合,例如,一个点的二维坐标就可以表示成:
>>> p = (1, 2)
但是,看到 (1, 2)
,很难看出这个tuple
是用来表示一个坐标的。
定义一个 class
又小题大做了,这时,namedtuple
就派上了用场:
>>> from collections import namedtuple
>>> Point = namedtuple('Point', ['x', 'y'])
>>> p = Point(1, 2)
>>> p.x
1
>>> p.y
2
namedtuple
是一个函数,它用来创建一个自定义的 tuple
对象,并且规定了 tuple
元素的个数,并可以用属性而不是索引来引用 tuple
的某个元素。
这样一来,我们用 namedtuple
可以很方便地定义一种数据类型,它具备 tuple 的不变性,又可以根据属性来引用,使用十分方便。
可以验证创建的 Point
对象是 tuple
的一种子类:
>>> isinstance(p, Point)
True
>>> isinstance(p, tuple)
True
类似的,如果要用坐标和半径表示一个圆,也可以用 namedtuple
定义:
# namedtuple('名称', [属性 list]):
Circle = namedtuple('Circle', ['x', 'y', 'r'])
deque
使用 list
存储数据时,按索引访问元素很快,但是插入和删除元素就很慢了,因为 list
是线性存储,数据量大的时候,插入和删除效率很低。
deque
是为了高效实现插入和删除操作的双向列表,适合用于队列和栈:
>>> from collections import deque
>>> q = deque(['a', 'b', 'c'])
>>> q.append('x')
>>> q.appendleft('y')
>>> q
deque(['y', 'a', 'b', 'c', 'x'])
deque
除了实现 list 的 append()
和pop()
外,还支持 appendleft()
和popleft()
,这样就可以非常高效地往头部添加或删除元素。
defaultdict
使用 dict
时,如果引用的 Key 不存在,就会抛出KeyError
。如果希望 key 不存在时,返回一个默认值,就可以用defaultdict
:
>>> from collections import defaultdict
>>> dd = defaultdict(lambda: 'N/A')
>>> dd['key1'] = 'abc'
>>> dd['key1'] # key1 存在
'abc'
>>> dd['key2'] # key2 不存在,返回默认值
'N/A'
注意默认值是调用函数返回的,而函数在创建 defaultdict
对象时传入。
除了在 Key 不存在时返回默认值,defaultdict
的其他行为跟 dict
是完全一样的。
OrderedDict
使用 dict
时,Key 是无序的。在对 dict
做迭代时,我们无法确定 Key 的顺序。
如果要保持 Key 的顺序,可以用OrderedDict
:
>>> from collections import OrderedDict
>>> d = dict([('a', 1), ('b', 2), ('c', 3)])
>>> d # dict 的 Key 是无序的
{'a': 1, 'c': 3, 'b': 2}
>>> od = OrderedDict([('a', 1), ('b', 2), ('c', 3)])
>>> od # OrderedDict 的 Key 是有序的
OrderedDict([('a', 1), ('b', 2), ('c', 3)])
注意,OrderedDict
的 Key 会按照插入的顺序排列,不是 Key 本身排序:
>>> od = OrderedDict()
>>> od['z'] = 1
>>> od['y'] = 2
>>> od['x'] = 3
>>> list(od.keys()) # 按照插入的 Key 的顺序返回
['z', 'y', 'x']
OrderedDict
可以实现一个 FIFO(先进先出)的 dict,当容量超出限制时,先删除最早添加的 Key:
from collections import OrderedDict
class LastUpdatedOrderedDict(OrderedDict):
def __init__(self, capacity):
super(LastUpdatedOrderedDict, self).__init__()
self._capacity = capacity
def __setitem__(self, key, value):
containsKey = 1 if key in self else 0
if len(self) - containsKey >= self._capacity:
last = self.popitem(last=False)
print('remove:', last)
if containsKey:
del self[key]
print('set:', (key, value))
else:
print('add:', (key, value))
OrderedDict.__setitem__(self, key, value)
ChainMap
ChainMap
可以把一组 dict
串起来并组成一个逻辑上的 dict
。ChainMap
本身也是一个 dict,但是查找的时候,会按照顺序在内部的 dict 依次查找。
什么时候使用 ChainMap
最合适?举个例子:应用程序往往都需要传入参数,参数可以通过命令行传入,可以通过环境变量传入,还可以有默认参数。我们可以用 ChainMap
实现参数的优先级查找,即先查命令行参数,如果没有传入,再查环境变量,如果没有,就使用默认参数。
下面的代码演示了如何查找 user
和color
这两个参数:
from collections import ChainMap
import os, argparse
# 构造缺省参数:
defaults = {'color': 'red',
'user': 'guest'
}
# 构造命令行参数:
parser = argparse.ArgumentParser()
parser.add_argument('-u', '--user')
parser.add_argument('-c', '--color')
namespace = parser.parse_args()
command_line_args = {k: v for k, v in vars(namespace).items() if v }
# 组合成 ChainMap:
combined = ChainMap(command_line_args, os.environ, defaults)
# 打印参数:
print('color=%s' % combined['color'])
print('user=%s' % combined['user'])
没有任何参数时,打印出默认参数:
$ python3 use_chainmap.py
color=red
user=guest
当传入命令行参数时,优先使用命令行参数:
$ python3 use_chainmap.py -u bob
color=red
user=bob
同时传入命令行参数和环境变量,命令行参数的优先级较高:
$ user=admin color=green python3 use_chainmap.py -u bob
color=green
user=bob
Counter
Counter
是一个简单的计数器,例如,统计字符出现的个数:
>>> from collections import Counter
>>> c = Counter('programming')
>>> for ch in 'programming':
... c[ch] = c[ch] + 1
...
>>> c
Counter({'g': 2, 'm': 2, 'r': 2, 'a': 1, 'i': 1, 'o': 1, 'n': 1, 'p': 1})
>>> c.update('hello') # 也可以一次性 update
>>> c
Counter({'r': 2, 'o': 2, 'g': 2, 'm': 2, 'l': 2, 'p': 1, 'a': 1, 'i': 1, 'n': 1, 'h': 1, 'e': 1})
Counter
实际上也是 dict
的一个子类,上面的结果可以看出每个字符出现的次数。
小结
collections
模块提供了一些有用的集合类,可以根据需要选用。
参考源码
use_collections.py