“冻结的字典”是什么?
- 2025-01-16 08:37:00
- admin 原创
- 78
问题描述:
冻结集就是冻结集。
冻结列表可以是一个元组。
冻结的字典是什么? 不可变的、可哈希的字典。
我猜它可能是这样的collections.namedtuple
,但它更像是一个冻结键字典(半冻结的字典)。不是吗?
“frozendict”应该是一本冻结的词典,它应该具有keys
、、等,并支持、等values
。get
`in`for
更新:
它在那里: https: //www.python.org/dev/peps/pep-0603
解决方案 1:
Python 没有内置的 freezedict 类型。事实证明,这通常不会很有用(尽管它可能仍然比frozenset
现在更有用)。
需要这种类型的最常见原因是当记忆函数调用具有未知参数的函数时。存储字典的可哈希等效项(其中值是可哈希的)的最常见解决方案是类似这样的tuple(sorted(kwargs.items()))
。
这取决于排序是否有点疯狂。Python 无法肯定地保证排序会产生合理的结果。(但它不能保证太多其他东西,所以不要太担心。)
你可以很容易地制作某种类似于字典的包装器。它可能看起来像(在Python 3.10 及更高版本中,替换collections.Mapping
为collections.abc.Mapping
):
import collections
class FrozenDict(collections.Mapping):
"""Don't forget the docstrings!!"""
def __init__(self, *args, **kwargs):
self._d = dict(*args, **kwargs)
self._hash = None
def __iter__(self):
return iter(self._d)
def __len__(self):
return len(self._d)
def __getitem__(self, key):
return self._d[key]
def __hash__(self):
# It would have been simpler and maybe more obvious to
# use hash(tuple(sorted(self._d.iteritems()))) from this discussion
# so far, but this solution is O(n). I don't know what kind of
# n we are going to run into, but sometimes it's hard to resist the
# urge to optimize when it will gain improved algorithmic performance.
if self._hash is None:
hash_ = 0
for pair in self.items():
hash_ ^= hash(pair)
self._hash = hash_
return self._hash
它应该能很好地工作:
>>> x = FrozenDict(a=1, b=2)
>>> y = FrozenDict(a=1, b=2)
>>> x is y
False
>>> x == y
True
>>> x == {'a': 1, 'b': 2}
True
>>> d = {x: 'foo'}
>>> d[y]
'foo'
解决方案 2:
奇怪的是,虽然我们有很少用到的frozenset
,但仍然没有冻结映射。这个想法在PEP 416——添加一个冻结的dict内置类型中被拒绝了。这个想法可能会在以后的Python版本中重新讨论,请参阅PEP 603——向集合添加冻结映射类型。
因此 Python 2 对此的解决方案是:
def foo(config={'a': 1}):
...
似乎还是平常的样子:
def foo(config=None):
if config is None:
config = {'a': 1} # default config
...
在 Python 3 中你可以选择这个:
from types import MappingProxyType
default_config = {'a': 1}
DEFAULTS = MappingProxyType(default_config)
def foo(config=DEFAULTS):
...
现在,默认配置可以动态更新,但仍保持不变,而您希望通过传递代理使其不变。
因此,更改将按预期default_config
更新DEFAULTS
,但您无法写入映射代理对象本身。
不可否认的是,它与“不可变的、可哈希的字典”并不是同一个东西,但它可能是冻结字典某些用例的不错替代品。
解决方案 3:
假设字典的键和值本身是不可变的(例如字符串),那么:
>>> d
{'forever': 'atones', 'minks': 'cards', 'overhands': 'warranted',
'hardhearted': 'tartly', 'gradations': 'snorkeled'}
>>> t = tuple((k, d[k]) for k in sorted(d.keys()))
>>> hash(t)
1524953596
解决方案 4:
在普通的 Python 中没有frozendict
,但是你可以使用types.MappingProxyType
在 Python 3.3 中添加到标准库中的东西:
>>> from types import MappingProxyType
>>> foo = MappingProxyType({'a': 1})
>>> foo['a'] = 2
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'mappingproxy' object does not support item assignment
>>> foo
mappingproxy({'a': 1})
>>> # This is unhashable
>>> hash(foo)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: unhashable type: 'mappingproxy'
解决方案 5:
安装frozendict
pip install frozendict
使用它!
from frozendict import frozendict
def smth(param = frozendict({})):
pass
解决方案 6:
我每次写这样的函数时都会想到frozendict:
def do_something(blah, optional_dict_parm=None):
if optional_dict_parm is None:
optional_dict_parm = {}
解决方案 7:
以下是我一直在使用的代码。我将frozenset子类化。这样做的好处如下。
这是一个真正不可变的对象。不依赖于未来用户和开发人员的良好行为。
在常规字典和冻结字典之间来回转换非常简单。FrozenDict(orig_dict) --> 冻结字典。dict(frozen_dict) --> 常规字典。
2015 年 1 月 21 日更新:我于 2014 年发布的原始代码片段使用 for 循环来查找匹配的键。这非常慢。现在我整理了一个利用 frostyset 哈希功能的实现。键值对存储在特殊容器中,其中__hash__
和__eq__
函数仅基于键。与我于 2014 年 8 月在此处发布的代码不同,此代码也经过了正式的单元测试。
MIT 风格的许可证。
if 3 / 2 == 1:
version = 2
elif 3 / 2 == 1.5:
version = 3
def col(i):
''' For binding named attributes to spots inside subclasses of tuple.'''
g = tuple.__getitem__
@property
def _col(self):
return g(self,i)
return _col
class Item(tuple):
''' Designed for storing key-value pairs inside
a FrozenDict, which itself is a subclass of frozenset.
The __hash__ is overloaded to return the hash of only the key.
__eq__ is overloaded so that normally it only checks whether the Item's
key is equal to the other object, HOWEVER, if the other object itself
is an instance of Item, it checks BOTH the key and value for equality.
WARNING: Do not use this class for any purpose other than to contain
key value pairs inside FrozenDict!!!!
The __eq__ operator is overloaded in such a way that it violates a
fundamental property of mathematics. That property, which says that
a == b and b == c implies a == c, does not hold for this object.
Here's a demonstration:
[in] >>> x = Item(('a',4))
[in] >>> y = Item(('a',5))
[in] >>> hash('a')
[out] >>> 194817700
[in] >>> hash(x)
[out] >>> 194817700
[in] >>> hash(y)
[out] >>> 194817700
[in] >>> 'a' == x
[out] >>> True
[in] >>> 'a' == y
[out] >>> True
[in] >>> x == y
[out] >>> False
'''
__slots__ = ()
key, value = col(0), col(1)
def __hash__(self):
return hash(self.key)
def __eq__(self, other):
if isinstance(other, Item):
return tuple.__eq__(self, other)
return self.key == other
def __ne__(self, other):
return not self.__eq__(other)
def __str__(self):
return '%r: %r' % self
def __repr__(self):
return 'Item((%r, %r))' % self
class FrozenDict(frozenset):
''' Behaves in most ways like a regular dictionary, except that it's immutable.
It differs from other implementations because it doesn't subclass "dict".
Instead it subclasses "frozenset" which guarantees immutability.
FrozenDict instances are created with the same arguments used to initialize
regular dictionaries, and has all the same methods.
[in] >>> f = FrozenDict(x=3,y=4,z=5)
[in] >>> f['x']
[out] >>> 3
[in] >>> f['a'] = 0
[out] >>> TypeError: 'FrozenDict' object does not support item assignment
FrozenDict can accept un-hashable values, but FrozenDict is only hashable if its values are hashable.
[in] >>> f = FrozenDict(x=3,y=4,z=5)
[in] >>> hash(f)
[out] >>> 646626455
[in] >>> g = FrozenDict(x=3,y=4,z=[])
[in] >>> hash(g)
[out] >>> TypeError: unhashable type: 'list'
FrozenDict interacts with dictionary objects as though it were a dict itself.
[in] >>> original = dict(x=3,y=4,z=5)
[in] >>> frozen = FrozenDict(x=3,y=4,z=5)
[in] >>> original == frozen
[out] >>> True
FrozenDict supports bi-directional conversions with regular dictionaries.
[in] >>> original = {'x': 3, 'y': 4, 'z': 5}
[in] >>> FrozenDict(original)
[out] >>> FrozenDict({'x': 3, 'y': 4, 'z': 5})
[in] >>> dict(FrozenDict(original))
[out] >>> {'x': 3, 'y': 4, 'z': 5} '''
__slots__ = ()
def __new__(cls, orig={}, **kw):
if kw:
d = dict(orig, **kw)
items = map(Item, d.items())
else:
try:
items = map(Item, orig.items())
except AttributeError:
items = map(Item, orig)
return frozenset.__new__(cls, items)
def __repr__(self):
cls = self.__class__.__name__
items = frozenset.__iter__(self)
_repr = ', '.join(map(str,items))
return '%s({%s})' % (cls, _repr)
def __getitem__(self, key):
if key not in self:
raise KeyError(key)
diff = self.difference
item = diff(diff({key}))
key, value = set(item).pop()
return value
def get(self, key, default=None):
if key not in self:
return default
return self[key]
def __iter__(self):
items = frozenset.__iter__(self)
return map(lambda i: i.key, items)
def keys(self):
items = frozenset.__iter__(self)
return map(lambda i: i.key, items)
def values(self):
items = frozenset.__iter__(self)
return map(lambda i: i.value, items)
def items(self):
items = frozenset.__iter__(self)
return map(tuple, items)
def copy(self):
cls = self.__class__
items = frozenset.copy(self)
dupl = frozenset.__new__(cls, items)
return dupl
@classmethod
def fromkeys(cls, keys, value):
d = dict.fromkeys(keys,value)
return cls(d)
def __hash__(self):
kv = tuple.__hash__
items = frozenset.__iter__(self)
return hash(frozenset(map(kv, items)))
def __eq__(self, other):
if not isinstance(other, FrozenDict):
try:
other = FrozenDict(other)
except Exception:
return False
return frozenset.__eq__(self, other)
def __ne__(self, other):
return not self.__eq__(other)
if version == 2:
#Here are the Python2 modifications
class Python2(FrozenDict):
def __iter__(self):
items = frozenset.__iter__(self)
for i in items:
yield i.key
def iterkeys(self):
items = frozenset.__iter__(self)
for i in items:
yield i.key
def itervalues(self):
items = frozenset.__iter__(self)
for i in items:
yield i.value
def iteritems(self):
items = frozenset.__iter__(self)
for i in items:
yield (i.key, i.value)
def has_key(self, key):
return key in self
def viewkeys(self):
return dict(self).viewkeys()
def viewvalues(self):
return dict(self).viewvalues()
def viewitems(self):
return dict(self).viewitems()
#If this is Python2, rebuild the class
#from scratch rather than use a subclass
py3 = FrozenDict.__dict__
py3 = {k: py3[k] for k in py3}
py2 = {}
py2.update(py3)
dct = Python2.__dict__
py2.update({k: dct[k] for k in dct})
FrozenDict = type('FrozenDict', (frozenset,), py2)
解决方案 8:
子类化dict
我在 github 上看到了这个模式,想提一下:
class FrozenDict(dict):
def __init__(self, *args, **kwargs):
self._hash = None
super(FrozenDict, self).__init__(*args, **kwargs)
def __hash__(self):
if self._hash is None:
self._hash = hash(tuple(sorted(self.items()))) # iteritems() on py2
return self._hash
def _immutable(self, *args, **kws):
raise TypeError('cannot change object - object is immutable')
# makes (deep)copy alot more efficient
def __copy__(self):
return self
def __deepcopy__(self, memo=None):
if memo is not None:
memo[id(self)] = self
return self
__setitem__ = _immutable
__delitem__ = _immutable
pop = _immutable
popitem = _immutable
clear = _immutable
update = _immutable
setdefault = _immutable
使用示例:
d1 = FrozenDict({'a': 1, 'b': 2})
d2 = FrozenDict({'a': 1, 'b': 2})
d1.keys()
assert isinstance(d1, dict)
assert len(set([d1, d2])) == 1 # hashable
优点
支持
get()
、、(在 py2 上)以及所有开箱即用的功能,无需明确实现keys()
它们items()
`iteritems()`dict
内部使用
dict
,这意味着性能(dict
在 CPython 中用 c 编写)优雅、简单,没有黑魔法
isinstance(my_frozen_dict, dict)
返回 True - 尽管 Python 鼓励许多包使用duck-typeisinstance()
,但这可以节省许多调整和定制
缺点
任何子类都可以覆盖它或在内部访问它(你不能真正 100% 保护 Python 中的某些东西,你应该信任你的用户并提供良好的文档)。
如果您注重速度,则可能希望速度
__hash__
更快一些。
解决方案 9:
您可以使用frozendict
以下utilspie
包:
>>> from utilspie.collectionsutils import frozendict
>>> my_dict = frozendict({1: 3, 4: 5})
>>> my_dict # object of `frozendict` type
frozendict({1: 3, 4: 5})
# Hashable
>>> {my_dict: 4}
{frozendict({1: 3, 4: 5}): 4}
# Immutable
>>> my_dict[1] = 5
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/Users/mquadri/workspace/utilspie/utilspie/collectionsutils/collections_utils.py", line 44, in __setitem__
self.__setitem__.__name__, type(self).__name__))
AttributeError: You can not call '__setitem__()' for 'frozendict' object
根据文件:
freezedict(dict_obj):接受 dict 类型的 obj,并返回可哈希且不可变的 dict
解决方案 10:
它的主要缺点namedtuple
是需要在使用前进行指定,因此对于一次性使用的情况不太方便。
但是,有一种实用的解决方法可用于处理许多此类情况。假设您想要拥有以下字典的不可变等价物:
MY_CONSTANT = {
'something': 123,
'something_else': 456
}
可以像这样模拟:
from collections import namedtuple
MY_CONSTANT = namedtuple('MyConstant', 'something something_else')(123, 456)
甚至可以编写一个辅助函数来自动执行此操作:
def freeze_dict(data):
from collections import namedtuple
keys = sorted(data.keys())
frozen_type = namedtuple(''.join(keys), keys)
return frozen_type(**data)
a = {'foo':'bar', 'x':'y'}
fa = freeze_dict(data)
assert a['foo'] == fa.foo
当然,这只适用于平面字典,但实现递归版本应该不会太难。
解决方案 11:
是的,这是我的第二个答案,但这是一种完全不同的方法。第一个实现是纯 Python 的。这个是用 Cython 实现的。如果您知道如何使用和编译 Cython 模块,那么它与常规字典一样快。检索单个值大约需要 0.04 到 0.06 微秒。
这是文件“frozen_dict.pyx”
import cython
from collections import Mapping
cdef class dict_wrapper:
cdef object d
cdef int h
def __init__(self, *args, **kw):
self.d = dict(*args, **kw)
self.h = -1
def __len__(self):
return len(self.d)
def __iter__(self):
return iter(self.d)
def __getitem__(self, key):
return self.d[key]
def __hash__(self):
if self.h == -1:
self.h = hash(frozenset(self.d.iteritems()))
return self.h
class FrozenDict(dict_wrapper, Mapping):
def __repr__(self):
c = type(self).__name__
r = ', '.join('%r: %r' % (k,self[k]) for k in self)
return '%s({%s})' % (c, r)
__all__ = ['FrozenDict']
这是文件“setup.py”
from distutils.core import setup
from Cython.Build import cythonize
setup(
ext_modules = cythonize('frozen_dict.pyx')
)
如果你安装了 Cython,请将上述两个文件保存到同一目录中。在命令行中移动到该目录。
python setup.py build_ext --inplace
python setup.py install
你就该完成了。
解决方案 12:
freeze实现了可哈希化的、类型提示的冻结集合(字典、列表和集合),并且会以递归方式冻结您提供给它们的数据(如果可能)。
pip install frz
用法:
from freeze import FDict
a_mutable_dict = {
"list": [1, 2],
"set": {3, 4},
}
a_frozen_dict = FDict(a_mutable_dict)
print(repr(a_frozen_dict))
# FDict: {'list': FList: (1, 2), 'set': FSet: {3, 4}}
解决方案 13:
我需要在某一时刻访问某种全局常量类型的固定键,我决定采用如下方法:
class MyFrozenDict:
def __getitem__(self, key):
if key == 'mykey1':
return 0
if key == 'mykey2':
return "another value"
raise KeyError(key)
像使用它一样
a = MyFrozenDict()
print(a['mykey1'])
警告:我不建议在大多数情况下这样做,因为它会带来相当严重的后果。