如何在Python中制作一个不可变的Dict

378 阅读3分钟

Python 内置的集合类型有可变和不可变两种,但明显缺少一种。

可变版本不可变的版本
listtuple
setfrozenset
dict???

frozendict"在哪里? 它可能很有用......

早在2012年,PEP 416就为Python 3.3提出了一个frozendict 类型。该PEP被否决了,有几个很好的理由。理由包括关于不可变的dict的效用的几个问题,值得在你把它们添加到你的代码中之前检查一下。

但是PEP确实给了我们一个工具来模拟不可变的dicts。 types.MappingProxyType这个类型是dict 或其它映射的只读代理。Python 在内部使用这个类型来处理重要的字典,这就是为什么你不能随意修补内置类型。Python 3.3 的唯一变化是为用户代码暴露了这个类型。

(PEP 613重新建议添加一个类似于不可变的dict 的类型,称为frozenmap 。但它仍然是一个草案。)

如何使用MappingProxyType

为了创建一个 "不可变的 "dict,从dict中创建一个MappingProxyType ,而不保留对底层dict的任何引用。

from types import MappingProxyType

power_levels = MappingProxyType(
    {
        "Kevin": 9001,
        "Benny": 8000,
    }
)

你可以用所有常见的方法从映射代理中读取。

In [1]: power_levels["Kevin"]
Out[1]: 9001

In [2]: power_levels["Benny"]
Out[2]: 8000

In [3]: list(power_levels.keys())
Out[3]: ['Kevin', 'Benny']

但是,任何改变数值的尝试都会导致TypeError

In [4]: power_levels["Benny"] = 9200
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-4-39fccb3e4f76> in <module>
----> 1 power_levels["Benny"] = 9200

TypeError: 'mappingproxy' object does not support item assignment

因为没有对底层dict 的引用,所以它不能改变。dict 也不能通过MappingProxyType 的任何属性来访问,它的唯一引用是在一个不可见的 C 级指针中。

如果你第二个变量中保留了对dict 的引用,那么对它的任何变异都会显示在代理中。

In [5]: original = {"kevin": 9001}

In [6]: proxy = MappingProxyType(original)

In [7]: proxy["kevin"]
Out[7]: 9001

In [8]: original["kevin"] = 9002

In [9]: proxy["kevin"]
Out[9]: 9002

如何制作突变的副本

要创建一个有变化的映射代理的副本,可以使用 Python 3.9 的dict 合并操作,用一个新的 dict 合并映射代理,并将结果传递给MappingProxyType

In [10]: benny_better = MappingProxyType(power_levels | {"Benny": 9200})

In [11]: benny_better
Out[11]: mappingproxy({'Kevin': 9001, 'Benny': 9200})

对于更复杂的修改,你可以把映射代理复制到一个新的dict ,进行修改,然后把结果转换为映射代理。

In [12]: new_world = power_levels | {}

In [13]: del new_world["Benny"]

In [14]: del new_world["Kevin"]

In [15]: new_world["Bock"] = 100

In [16]: new_world = MappingProxyType(new_world)

In [17]: new_world
Out[17]: mappingproxy({'Bock': 100})

第三方软件包

有几个第三方包提供了不可变的数据结构,如immutablespyrsistent。 这些包有稍微好一点的API,但有不同的权衡,如性能和维护状态。如果MappingProxyType 不适合你,你可能想研究它们,但我鼓励尽可能地使用标准库。