Что такое "замороженный дикт"? - PullRequest
135 голосов
/ 24 апреля 2010
  • замороженный набор - фрозенцет.
  • Замороженный список может быть кортежем.
  • Каким будет замороженный дикт? Неизменный, бескомпромиссный диктат.

Полагаю, это может быть что-то вроде collections.namedtuple, но это больше похоже на диктат замороженных клавиш (полузамороженный диктант). Не так ли?

"frozendict" должен быть замороженным словарем, он должен иметь keys, values, get и т. Д. И поддерживать in, for и т. Д.

Ответы [ 14 ]

102 голосов
/ 24 апреля 2010

Python не имеет встроенного типа frozendict. Оказывается, это не будет полезно слишком часто (хотя, вероятно, это будет полезно чаще, чем frozenset).

Самая распространенная причина, по которой такой тип нужен, - запоминание вызовов функций для функций с неизвестными аргументами. Наиболее распространенное решение для хранения хешируемого эквивалента dict (где значения могут быть хешируемыми) выглядит как tuple(sorted(kwargs.iteritems())).

Это зависит от того, что сортировка не слишком сумасшедшая. Python не может положительно обещать, что сортировка приведет к чему-то разумному здесь. (Но это не может обещать много другого, поэтому не надо слишком сильно его потеть.)


Вы могли бы достаточно легко сделать какую-то обертку, которая работает очень похоже на диктовку. Это может выглядеть примерно так:

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:
            self._hash = 0
            for pair in self.iteritems():
                self._hash ^= hash(pair)
        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'
51 голосов
/ 04 июня 2015

Любопытно, что хотя у нас редко встречается frozenset в python, все еще нет замороженного отображения. Идея была отклонена в PEP 416 .

Итак, решение Python 2 для этого:

def foo(config={'a': 1}):
    ...

Все еще кажется несколько отсталым:

def foo(config=None):
    if config is None:
        config = default_config = {'a': 1}
    ...

В python3 у вас есть опция this :

from types import MappingProxyType

default_config = {'a': 1}
DEFAULTS = MappingProxyType(default_config)

def foo(config=DEFAULTS):
    ...

Теперь стандартная конфигурация может обновляться динамически, но оставаться неизменной там, где вы хотите, чтобы она была неизменной, вместо этого передавая прокси.

Таким образом, изменения в default_config обновят DEFAULTS, как и ожидалось, но вы не можете записать в сам объект сопоставления прокси.

По общему признанию, это не совсем то же самое, что и "неизменный, легко изменяемый диктат", - но это достойный заменитель, учитывая те же варианты использования, для которых мы могли бы захотеть заморозить.

18 голосов
/ 24 апреля 2010

Если предположить, что ключи и значения словаря сами по себе неизменны (например, строки), то:

>>> 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
9 голосов
/ 26 августа 2018

Нет fronzedict, но вы можете использовать MappingProxyType, который был добавлен в стандартную библиотеку с Python 3.3:

>>> from types import MappingProxyType
>>> foo = MappingProxyType({'a': 1})
>>> foo
mappingproxy({'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})
9 голосов
/ 15 августа 2014

Вот код, который я использовал. Я подкласс заморозил. Преимущества этого следующие.

  1. Это действительно неизменный объект. Не полагаться на хорошее поведение будущих пользователей и разработчиков.
  2. Легко конвертировать туда и обратно между обычным словарем и замороженным словарем. FrozenDict (orig_dict) -> замороженный словарь. dict (frozen_dict) -> обычный dict.

Обновление 21 января 2015: исходный фрагмент кода, который я разместил в 2014 году, использовал цикл for для поиска подходящего ключа. Это было невероятно медленно. Теперь я собрал реализацию, которая использует возможности хеширования frozenset. Пары ключ-значение хранятся в специальных контейнерах, где функции __hash__ и __eq__ основаны только на ключе. Этот код также был официально протестирован модульно, в отличие от того, что я разместил здесь в августе 2014 года.

Лицензия в стиле 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)
5 голосов
/ 01 апреля 2011

Я думаю о frozendict каждый раз, когда пишу такую ​​функцию:

def do_something(blah, optional_dict_parm=None):
    if optional_dict_parm is None:
        optional_dict_parm = {}
4 голосов
/ 28 декабря 2016

Вы можете использовать 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

Согласно документу :

frozendict (dict_obj) : Принимает obj типа dict и возвращает хешируемый и неизменный dict

3 голосов
/ 03 июня 2016

Основным недостатком 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

Конечно, это работает только для плоских диктовок, но не должно быть слишком сложно реализовать рекурсивную версию.

3 голосов
/ 15 апреля 2015

Да, это мой второй ответ, но это совершенно другой подход. Первая реализация была на чистом питоне. Этот в 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

И вам пора.

2 голосов
/ 20 июня 2018

Установка frozendict

pip install frozendict

Используйте это!

from frozendict import frozendict

def smth(param = frozendict({})):
    pass
...