immutabledict icon indicating copy to clipboard operation
immutabledict copied to clipboard

A fork of frozendict, an immutable wrapper around dictionaries for Python3

immutabledict

PyPI Conda PyPI - Python Version

License Build Codecov PyPI - Downloads

A fork of frozendict, an immutable wrapper around dictionaries.

It implements the complete mapping interface and can be used as a drop-in replacement for dictionaries where immutability is desired. The immutabledict constructor mimics dict, and all of the expected interfaces (iter, len, repr, hash, getitem) are provided. Note that an immutabledict does not guarantee the immutability of its values, so the utility of hash method is restricted by usage.

The only difference is that the copy() method of immutable takes variable keyword arguments, which will be present as key/value pairs in the new, immutable copy.

Installation

Available as immutabledict on :

  • pypi
  • conda-forge (community-maintained, not an official release)

Example

from immutabledict import immutabledict

my_item = immutabledict({"a": "value", "b": "other_value"})
print(my_item["a"]) # Print "value"

Differences with frozendict

  • Dropped support of EOL Python versions (version 1.0.0 supports Python 3.5, versions <= 2.2.1 supports Python 3.6)
  • Fixed collections.Mapping deprecation warning
  • Typing
  • PEP 584 union operators