Class SideEffect

marimo/_runtime/side_effect.py:13–42

class SideEffect(CellLifecycleItem):
    def __init__(self, key: str | bytes) -> None:
        self._key = key

    @property
    def key(self) -> bytes:
        assert self._key is not None
        if isinstance(self._key, bytes):
            return self._key
        return self._key.encode("utf-8")

    @property
    def hash(self) -> bytes:
        """Hash the lookup to a consistent size."""
        return hashlib.sha256(self.key).digest()

    def create(self, context: RuntimeContext | None) -> None:
        """NoOp for side effect.
        Typically hook to expose the object to the context, but the existence of
        the object is enough for side effect tracking.
        """
        del context

    def dispose(self, context: RuntimeContext, deletion: bool) -> bool:
        """Clean up and mark the object for deletion"""
        # Side effects can always be disposed since they are just a cell level
        # marker that some event has occurred.
        del context
        del deletion
        return True


class CellHash(CellLifecycleItem):