Python标准库——collections模块的Counter类

最近在看一本名叫《Python Algorithm: Mastering Basic Algorithms in the Python Language》的书，刚好看到提到这个Counter类（P84的Listing 4.6下的Tip）。

1.collections模块

collections模块自Python 2.4版本开始被引入，包含了dict、set、list、tuple以外的一些特殊的容器类型，分别是：

OrderedDict类：排序字典，是字典的子类。引入自2.7。
namedtuple()函数：命名元组，是一个工厂函数。引入自2.6。
Counter类：为hashable对象计数，是字典的子类。引入自2.7。
deque：双向队列。引入自2.4。
defaultdict：使用工厂函数创建字典，使不用考虑缺失的字典键。引入自2.5。

文档参见：http://docs.python.org/2/library/collections.html。

2.Counter类

Counter类的目的是用来跟踪值出现的次数。它是一个无序的容器类型，以字典的键值对形式存储，其中元素作为key，其计数作为value。计数值可以是任意的Interger（包括0和负数）。Counter类和其他语言的bags或multisets很相似。

2.1 创建

下面的代码说明了Counter类创建的四种方法：

>>> c = Counter()  # 创建一个空的Counter类
>>> c = Counter('gallahad')  # 从一个可iterable对象（list、tuple、dict、字符串等）创建
>>> c = Counter({'a': 4, 'b': 2})  # 从一个字典对象创建
>>> c = Counter(a=4, b=2)  # 从一组键值对创建

>>> c = Counter() # 创建一个空的Counter类

>>> c = Counter('gallahad') # 从一个可iterable对象（list、tuple、dict、字符串等）创建

>>> c = Counter({'a': 4, 'b': 2}) # 从一个字典对象创建

>>> c = Counter(a=4, b=2) # 从一组键值对创建

2.2 计数值的访问与缺失的键

当所访问的键不存在时，返回0，而不是KeyError；否则返回它的计数。

>>> c = Counter("abcdefgab")
>>> c["a"]
2
>>> c["c"]
1
>>> c["h"]
0

>>> c = Counter("abcdefgab")

>>> c["a"]

>>> c["c"]

>>> c["h"]

2.3 计数器的更新（update和subtract）

可以使用一个iterable对象或者另一个Counter对象来更新键值。

计数器的更新包括增加和减少两种。其中，增加使用update()方法：

>>> c = Counter('which')
>>> c.update('witch')  # 使用另一个iterable对象更新
>>> c['h']
3
>>> d = Counter('watch')
>>> c.update(d)  # 使用另一个Counter对象更新
>>> c['h']
4

>>> c = Counter('which')

>>> c.update('witch') # 使用另一个iterable对象更新

>>> c['h']

>>> d = Counter('watch')

>>> c.update(d) # 使用另一个Counter对象更新

>>> c['h']

减少则使用subtract()方法：

>>> c = Counter('which')
>>> c.subtract('witch')  # 使用另一个iterable对象更新
>>> c['h']
1
>>> d = Counter('watch')
>>> c.subtract(d)  # 使用另一个Counter对象更新
>>> c['a']
-1

>>> c = Counter('which')

>>> c.subtract('witch') # 使用另一个iterable对象更新

>>> c['h']

>>> d = Counter('watch')

>>> c.subtract(d) # 使用另一个Counter对象更新

>>> c['a']

-1

2.4 键的删除

当计数值为0时，并不意味着元素被删除，删除元素应当使用del。

>>> c = Counter("abcdcba")
>>> c
Counter({'a': 2, 'c': 2, 'b': 2, 'd': 1})
>>> c["b"] = 0
>>> c
Counter({'a': 2, 'c': 2, 'd': 1, 'b': 0})
>>> del c["a"]
>>> c
Counter({'c': 2, 'b': 2, 'd': 1})

>>> c = Counter("abcdcba")

>>> c

Counter({'a': 2, 'c': 2, 'b': 2, 'd': 1})

>>> c["b"] = 0

>>> c

Counter({'a': 2, 'c': 2, 'd': 1, 'b': 0})

>>> del c["a"]

>>> c

Counter({'c': 2, 'b': 2, 'd': 1})

2.5 elements()

返回一个迭代器。元素被重复了多少次，在该迭代器中就包含多少个该元素。元素排列无确定顺序，个数小于1的元素不被包含。

>>> c = Counter(a=4, b=2, c=0, d=-2)
>>> list(c.elements())
['a', 'a', 'a', 'a', 'b', 'b']

>>> c = Counter(a=4, b=2, c=0, d=-2)

>>> list(c.elements())

['a', 'a', 'a', 'a', 'b', 'b']

2.6 most_common([n])

返回一个TopN列表。如果n没有被指定，则返回所有元素。当多个元素计数值相同时，排列是无确定顺序的。

>>> c = Counter('abracadabra')
>>> c.most_common()
[('a', 5), ('r', 2), ('b', 2), ('c', 1), ('d', 1)]
>>> c.most_common(3)
[('a', 5), ('r', 2), ('b', 2)]

>>> c = Counter('abracadabra')

>>> c.most_common()

[('a', 5), ('r', 2), ('b', 2), ('c', 1), ('d', 1)]

>>> c.most_common(3)

[('a', 5), ('r', 2), ('b', 2)]

2.7 fromkeys

未实现的类方法。

2.8 浅拷贝copy

>>> c = Counter("abcdcba")
>>> c
Counter({'a': 2, 'c': 2, 'b': 2, 'd': 1})
>>> d = c.copy()
>>> d
Counter({'a': 2, 'c': 2, 'b': 2, 'd': 1})

>>> c = Counter("abcdcba")

>>> c

Counter({'a': 2, 'c': 2, 'b': 2, 'd': 1})

>>> d = c.copy()

>>> d

Counter({'a': 2, 'c': 2, 'b': 2, 'd': 1})

2.9 算术和集合操作

+、-、&、|操作也可以用于Counter。其中&和|操作分别返回两个Counter对象各元素的最小值和最大值。需要注意的是，得到的Counter对象将删除小于1的元素。

>>> c = Counter(a=3, b=1)
>>> d = Counter(a=1, b=2)
>>> c + d  # c[x] + d[x]
Counter({'a': 4, 'b': 3})
>>> c - d  # subtract（只保留正数计数的元素）
Counter({'a': 2})
>>> c & d  # 交集:  min(c[x], d[x])
Counter({'a': 1, 'b': 1})
>>> c | d  # 并集:  max(c[x], d[x])
Counter({'a': 3, 'b': 2})

>>> c = Counter(a=3, b=1)

>>> d = Counter(a=1, b=2)

>>> c + d # c[x] + d[x]

Counter({'a': 4, 'b': 3})

>>> c - d # subtract（只保留正数计数的元素）

Counter({'a': 2})

>>> c & d # 交集: min(c[x], d[x])

Counter({'a': 1, 'b': 1})

>>> c | d # 并集: max(c[x], d[x])

Counter({'a': 3, 'b': 2})

3.常用操作

下面是一些Counter类的常用操作，来源于Python官方文档

sum(c.values())  # 所有计数的总数
c.clear()  # 重置Counter对象，注意不是删除
list(c)  # 将c中的键转为列表
set(c)  # 将c中的键转为set
dict(c)  # 将c中的键值对转为字典
c.items()  # 转为(elem, cnt)格式的列表
Counter(dict(list_of_pairs))  # 从(elem, cnt)格式的列表转换为Counter类对象
c.most_common()[:-n:-1]  # 取出计数最少的n-1个元素
c += Counter()  # 移除0和负值

sum(c.values()) # 所有计数的总数

c.clear() # 重置Counter对象，注意不是删除

list(c) # 将c中的键转为列表

set(c) # 将c中的键转为set

dict(c) # 将c中的键值对转为字典

c.items() # 转为(elem, cnt)格式的列表

Counter(dict(list_of_pairs)) # 从(elem, cnt)格式的列表转换为Counter类对象

c.most_common()[:-n:-1] # 取出计数最少的n-1个元素

c += Counter() # 移除0和负值

本文内容遵从CC3.0版权协议，转载请注明：转自Pythoner

本文链接地址：Python标准库——collections模块的Counter类

- alyfrisk
- 2013/09/02 1:44下午
- 回复
- 引用
什么时候用collections呢？
- - alexkh
  - 2014/12/02 10:26上午
  - 回复
  - 引用
  用于计数的，很方便。
  
  博主的介绍的也很详细，例子很实用，多谢了！
- mink
- 2015/04/15 1:54下午
- 回复
- 引用
感谢博主分享, 英语不行看官文有点麻烦，看博主的一目了然啊
- Nicoder
- 2016/09/08 11:20上午
- 回复
- 引用
po主用的什么编辑器？我稀饭~
- 逆小苍
- 2017/03/24 3:35下午
- 回复
- 引用
博主您好，非常感谢您的分享，劣者有一疑惑：
您在上面2.6 most_common([n]) 中提到当多个元素计数值相同时，按照字母序排列。
但是看下面输出
>>> c = Counter(‘abracadabra’)
>>> c.most_common()
[(‘a’, 5), (‘r’, 2), (‘b’, 2), (‘c’, 1), (‘d’, 1)]
其中 r 和 b的计数值相等; c和d的计数值相等
如果是按照字母升序似乎应该输出[(‘a’, 5), (‘b’, 2), (‘r’, 2), (‘c’, 1), (‘d’, 1)]
如果是按照字母降序似乎应该输出[(‘a’, 5), (‘r’, 2), (‘b’, 2), (‘d’, 1), (‘c’, 1)]
如果是在字符串中出现的先后顺序似乎应该输出[(‘a’, 5), (‘b’, 2), (‘r’, 2), (‘c’, 1), (‘d’, 1)]
但实际的输出结果 [(‘a’, 5), (‘r’, 2), (‘b’, 2), (‘c’, 1), (‘d’, 1)] 显然与字母序并不符合
是否此处在计数值相等的情况下是随机排列的？
- - alioth310
  - 2017/03/27 10:51上午
  - 回复
  - 引用
  抱歉，这里写错了，应该是任意排列的。（官方文档原文是：Elements with equal counts are ordered arbitrarily）
  - 逆小苍
    
    2017/03/27 4:30下午
    - 回复
    - 引用
    博主客气了
- 莫莫雨
- 2017/09/02 9:39上午
- 回复
- 引用
c.most_common()[:-n:-1] # 取出计数最少的n个元素
这个好像是最少的n-1个
- - alioth310
  - 2017/09/04 10:33上午
  - 回复
  - 引用
  你说得对，这里写错了，感谢提醒