如何在 Python 中将字典设为只读

Question

我有这样的课程：

class A:
    def __init__(self):
        self.data = {}

有时我想禁止self.data字段修改。

我在PEP-416 rejection notice 中读到有很多方法可以做到这一点。所以我想知道它们是什么。

我试过这个：

a = A()
a.data = types.MappingProxyType(a.data)

这应该可以，但首先，它的 python3.3+ 和第二，当我多次执行此“禁止”时，我得到了这个：

>>> a.data = types.MappingProxyType(a.data)
>>> a.data = types.MappingProxyType(a.data)
>>> a.data
mappingproxy(mappingproxy({}))

虽然我会“禁止”很多次，但最好只获得mappingproxy({})。检查isinstance(MappingProxyType) 是一个选项，但我认为可以存在其他选项。

谢谢

Answer 1

使用collections.Mapping 例如

import collections

class DictWrapper(collections.Mapping):

    def __init__(self, data):
        self._data = data

    def __getitem__(self, key): 
        return self._data[key]

    def __len__(self):
        return len(self._data)

    def __iter__(self):
        return iter(self._data)

Answer 2

这是快速（浅）只读字典的完整实现：​​

class ReadOnlyDict(dict):
    def __readonly__(self, *args, **kwargs):
        raise RuntimeError("Cannot modify ReadOnlyDict")
    __setitem__ = __readonly__
    __delitem__ = __readonly__
    pop = __readonly__
    popitem = __readonly__
    clear = __readonly__
    update = __readonly__
    setdefault = __readonly__
    del __readonly__

Answer 3

很简单，你只需覆盖默认字典的方法！
这是一个例子：

class ReadOnlyDict(dict):

    __readonly = False

    def readonly(self, allow=1):
        """Allow or deny modifying dictionary"""
        self.__readonly = bool(allow)

    def __setitem__(self, key, value):

        if self.__readonly:
            raise TypeError, "__setitem__ is not supported"
        return dict.__setitem__(self, key, value)

    def __delitem__(self, key):

        if self.__readonly:
            raise TypeError, "__delitem__ is not supported"
        return dict.__delitem__(self, key)

顺便说一句，您还可以删除.pop、.update 和其他您需要的方法。随便玩玩吧。

Answer 4

最好的方法是像这样从UserDict 派生：

from collections import UserDict

class MyReadOnlyDict(UserDict):
   def my_set(self, key, val, more_params):
       # do something special
       # custom logic etc
       self.data[key] = val

   def __setitem__(self, key, val):
       raise NotImplementedError('This dictionary cannot be updated')

   def __delitem__(self, key):
       raise NotImplementedError('This dictionary does not allow delete')

这种方法的优点是你的类中仍然可以有内部方法，可以通过访问self.data来更新字典。

Answer 5

怎么样？这是@mouad 答案的更新。

import json
from collections import OrderedDict
from collections.abc import Mapping


class ReadOnlyJsonObject(Mapping):
    def __init__(self, data, dumps_kw: dict=None, loads_kw: dict=None):
        if dumps_kw is None:
            dumps_kw = dict()
        if loads_kw is None:
            self._loads_kw = dict(object_pairs_hook=OrderedDict)
        else:
            self._loads_kw = loads_kw

        if isinstance(data, str):
            self._json_string = data
        else:
            self._json_string = json.dumps(data, **dumps_kw)

    @property
    def _data(self):
        return json.loads(self._json_string, **self._loads_kw)

    def __getitem__(self, key):
        return self._data[key]

    def __len__(self):
        return len(self._data)

    def __iter__(self):
        return iter(self._data)

    def __str__(self):
        return self._json_string

但不确定性能。我在实际项目中使用了这个https://github.com/patarapolw/AnkiTools/blob/master/AnkiTools/tools/defaults.py