Merge pull request #287 from matthiasdiener/pickle-reduce

Do not store cached hash value when pickling
corenting · Dec 16, 2023 · 1d9225d · 1d9225d
2 parents c9504d0 + f3ca52d
commit 1d9225d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/immutabledict/__init__.py b/immutabledict/__init__.py
@@ -11,6 +11,7 @@
     KeysView,
     Mapping,
     Optional,
+    Tuple,
     Type,
     TypeVar,
     ValuesView,
@@ -45,6 +46,11 @@ def __new__(cls, *args: Any, **kwargs: Any) -> immutabledict[_K, _V]:  # noqa: D
         setattr(inst, "_hash", None)
         return inst
 
+    def __reduce__(self) -> Tuple[Any, ...]:
+        # Do not store the cached hash value when pickling
+        # as the value might change across Python invocations.
+        return (self.__class__, (self._dict,))
+
     def __getitem__(self, key: _K) -> _V:
         return self._dict[key]