How to “perfectly” override a dict?

by

You can write an object that behaves like a dict quite easily with ABCs (Abstract Base Classes) from the collections.abc module. It even tells you if you missed a method, so below is the minimal version that shuts the ABC up.

from collections.abc import MutableMapping


class TransformedDict(MutableMapping):
    """A dictionary that applies an arbitrary key-altering
       function before accessing the keys"""

    def __init__(self, *args, **kwargs):
        self.store = dict()
        self.update(dict(*args, **kwargs))  # use the free update to set keys

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

    def __setitem__(self, key, value):
        self.store[self._keytransform(key)] = value

    def __delitem__(self, key):
        del self.store[self._keytransform(key)]

    def __iter__(self):
        return iter(self.store)
    
    def __len__(self):
        return len(self.store)

    def _keytransform(self, key):
        return key

You get a few free methods from the ABC:

class MyTransformedDict(TransformedDict):

    def _keytransform(self, key):
        return key.lower()


s = MyTransformedDict([('Test', 'test')])

assert s.get('TEST') is s['test']   # free get
assert 'TeSt' in s                  # free __contains__
                                    # free setdefault, __eq__, and so on

import pickle
# works too since we just use a normal dict
assert pickle.loads(pickle.dumps(s)) == s

I wouldn’t subclass dict (or other builtins) directly. It often makes no sense, because what you actually want to do is implement the interface of a dict. And that is exactly what ABCs are for.

More Related Contents:

  1. Why is the order in dictionaries and sets arbitrary?
  2. In Python, when to use a Dictionary, List or Set?
  3. Why can a Python dict have multiple keys with the same hash?
  4. Remove string in python dictionary value
  5. Using lambda function in python
  6. What are the differences between type() and isinstance()?
  7. Create a dictionary with comprehension
  8. Loop through all nested dictionary values?
  9. Find all occurrences of a key in nested dictionaries and lists
  10. Access an arbitrary element in a dictionary in Python
  11. Merging two CSV files using Python
  12. Converting Dictionary to List? [duplicate]
  13. Why aren’t Python sets hashable?
  14. How to sort IP addresses stored in dictionary in Python?
  15. Why doesn’t requests.get() return? What is the default timeout that requests.get() uses?
  16. Accessing dictionary items by position in Python 3.6+ efficiently
  17. Unpack dictionary from Pandas Column
  18. Change values in dict of nested dicts using items in a list?
  19. Python set interpetation of 1 and True
  20. How to search if dictionary value contains certain string with Python
  21. Recursive diff of two dictionaries (keys and values)?
  22. Mapping over values in a python dictionary
  23. Using python map and other functional tools
  24. How does a Python set([]) check if two objects are equal? What methods does an object need to define to customise this?
  25. How expensive are Python dictionaries to handle?
  26. Mapping dictionary value to list
  27. Elegant way to remove items from sequence in Python? [duplicate]
  28. How to change all the dictionary keys in a for loop with d.items()?
  29. How can I combine dictionaries with the same keys?
  30. How to sort a list of dictionaries by a value of the dictionary in Python?

Leave a Comment