👌 Return frozendict for stored Dict nodes

aiida/orm/nodes/data/dict.py

@@ -10,6 +10,8 @@
 """`Data` sub class to represent a dictionary."""
 import copy
 
+from frozendict import frozendict
+
 from aiida.common import exceptions
 
 from .base import to_aiida_type
@@ -62,15 +64,28 @@ def __init__(self, value=None, **kwargs):
             self.set_dict(dictionary)
 
     def __getitem__(self, key):
+        """Get the ``value`` of a key.
+
+        If the node is not stored, the value is returned as is (if present). Once the node is stored, we check if the
+        value is a dictionary and if so, we return a ``frozendict`` instance to prevent modifications. This is to
+        prevent the user from modifying the dictionary in place, which would not be reflected in the database.
+        """
         try:
-            return self.base.attributes.get(key)
+            value = self.base.attributes.get(key)
         except AttributeError as exc:
             raise KeyError from exc
 
+        if self.is_stored and isinstance(value, dict):
+            return frozendict(value)
+
+        return value
+
     def __setitem__(self, key, value):
+        """Set the ``value`` of a key."""
         self.base.attributes.set(key, value)
 
     def __eq__(self, other):
+        """Compare if the current node is equal to another node or to a dictionary."""
         if isinstance(other, Dict):
             return self.get_dict() == other.get_dict()
         return self.get_dict() == other

environment.yml

@@ -14,6 +14,7 @@ dependencies:
 - click~=8.1
 - disk-objectstore~=1.0
 - docstring_parser
+- frozendict~=2.3
 - get-annotations~=0.1
 - python-graphviz~=0.19
 - ipython>=7

pyproject.toml

@@ -33,6 +33,7 @@
     "click~=8.1",
     "disk-objectstore~=1.0",
     "docstring-parser",
+    "frozendict~=2.3",
     "get-annotations~=0.1;python_version<'3.10'",
     "graphviz~=0.19",
     "ipython>=7",