Python字典之collections.OrderedDict

目录

1.OrderedDict基本用法示例

2.OrderedDict删除元素方法之popitem()

3.OrderedDict删除元素方法之pop()

---

Python中默认的字典dict是无序的，因为它是按照hash来存储的（Ps：好像从Python3.6开始也变得有序了），但是python中有个模块collections，里面有个子类orderedDict实现了对字典对象中元素的排序，它是有序的。OrderedDict的key会按照插入的顺序排列，不是key本身排序。

1.OrderedDict基本用法示例

简单来看一个示例：

import collections

cache = collections.OrderedDict()
cache["key1"] = {"k1": "v1"}
cache["key3"] = {"k3": "v3"}
cache["key2"] = {"k2": "v2"}


print(cache)
cache["key4"] = {"k4": "v4"}
print(cache)

输出结果：

OrderedDict([('key1', {'k1': 'v1'}), ('key3', {'k3': 'v3'}), ('key2', {'k2': 'v2'})])
OrderedDict([('key1', {'k1': 'v1'}), ('key3', {'k3': 'v3'}), ('key2', {'k2': 'v2'}), ('key4', {'k4': 'v4'})])

2.OrderedDict删除元素方法之popitem()

OrderedDict.popitem()可以完成元素的删除操作，有一个可选参数last（默认为True），当last为True时它从OrderedDict中删除最后一个键值对并返回该键值对，当last为False时它从OrderedDict中删除第一个键值对并返回该键值对。这个特性在Python缓存策略设置这块的应用其实还蛮多的。可以参考：Python 缓存机制之functools.lru_cache

last设置为False时

import collections

cache = collections.OrderedDict()
cache["key1"] = {"k1": "v1"}
cache["key2"] = {"k2": "v2"}
cache["key3"] = {"k3": "v3"}

print("cache before delete：{}".format(cache))
cache.popitem(last=False)
print("cache after delete：{}".format(cache))

运行结果：

cache before delete：OrderedDict([('key1', {'k1': 'v1'}), ('key2', {'k2': 'v2'}), ('key3', {'k3': 'v3'})])
cache after delete：OrderedDict([('key2', {'k2': 'v2'}), ('key3', {'k3': 'v3'})])

last设置为True时 

import collections

cache = collections.OrderedDict()
cache["key1"] = {"k1": "v1"}
cache["key2"] = {"k2": "v2"}
cache["key3"] = {"k3": "v3"}

print("cache before delete：{}".format(cache))
cache.popitem(last=True)
print("cache after delete：{}".format(cache))

 运行结果：

cache before delete：OrderedDict([('key1', {'k1': 'v1'}), ('key2', {'k2': 'v2'}), ('key3', {'k3': 'v3'})])
cache after delete：OrderedDict([('key1', {'k1': 'v1'}), ('key2', {'k2': 'v2'})])

Ps：如果字典已经为空，却调用了此方法，就报出KeyError异常，所以在写代码时需要捕获异常及处理一下。

3.OrderedDict删除元素方法之pop()

字典里面还有另一种常用的删除方法pop()，pop (key[,default])，其中，key是必选参数，必须给出，default是可选参数，可以不给出。如果键值key在字典中存在，删除dict[key]，返回 dict[key]的value值。
否则，如有给出default值则返回default值，如果default值没有给出，就会报出KeyError异常。
pop()方法至少接受一个参数，最多接受两个参数。

代码示例如下，尝试删除字典中存在的key（a）和不存在的key（e）

import collections

cache = collections.OrderedDict()
cache["a"] = 1
cache["b"] = 2
cache["c"] = 3
cache["d"] = 4

print("[1] cache before delete: {}".format(cache))
# 删除存在的key：a
cache.pop("a")
print("[2] cache after delete: {}".format(cache))
# 删除不存在的key：e
cache.pop("e")
print("[3] cache after delete: {}".format(cache))

输出结果如下：

[1] cache before delete: OrderedDict([('a', 1), ('b', 2), ('c', 3), ('d', 4)])
[2] cache after delete: OrderedDict([('b', 2), ('c', 3), ('d', 4)])
Traceback (most recent call last):
  File "/Users/xxxxxxx/demo.py", line 14, in <module>
    cache.pop("e")
KeyError: 'e'

可以看出，删除不存在的key时会抛出KeyError的异常，这种情况我们可以通过设置default值的方法来避免，示例如下：

示例代码如下：

import collections

cache = collections.OrderedDict()
cache["a"] = 1
cache["b"] = 2
cache["c"] = 3
cache["d"] = 4

print("[1] cache before delete: {}".format(cache))
# 删除存在的key：a
cache.pop("a")
print("[2] cache after delete: {}".format(cache))
# 删除不存在的key：e, 设置default默认值
cache.pop("e", None)
print("[3] cache after delete: {}".format(cache))

输出结果如下，可以看出这次删除不存在的key时值没有报错。

[1] cache before delete: OrderedDict([('a', 1), ('b', 2), ('c', 3), ('d', 4)])
[2] cache after delete: OrderedDict([('b', 2), ('c', 3), ('d', 4)])
[3] cache after delete: OrderedDict([('b', 2), ('c', 3), ('d', 4)])