Function get_context

marimo/_code_mode/_context.py:201–238

Return an `AsyncCodeModeContext` for the running kernel. Use as an async context manager:: async with cm.get_context() as ctx: ctx.create_cell("x = 1") Parameters ---------- skip_validation : bool, default False When False (the default), a dry-run compi

(
    *,
    skip_validation: bool = False,
    skip_staleness_check: bool = False,
)

def get_context(
    *,
    skip_validation: bool = False,
    skip_staleness_check: bool = False,
) -> AsyncCodeModeContext:
    """Return an `AsyncCodeModeContext` for the running kernel.

    Use as an async context manager::

        async with cm.get_context() as ctx:
            ctx.create_cell("x = 1")

    Parameters
    ----------
    skip_validation : bool, default False
        When False (the default), a dry-run compile check runs on exit
        to catch syntax errors, multiply-defined names, and cycles
        *before* any graph mutations are applied. The check is cheap
        and should almost never be disabled. Only set to True when you
        intentionally need to insert code that would fail validation
        (e.g. incomplete stubs the user plans to fix by hand).
    skip_staleness_check : bool, default False
        When False (the default), `edit_cell` raises
        :class:`StaleCellError` if the agent tries to overwrite a cell
        whose code has changed since the agent last read it (e.g. via
        `ctx.cells[cell_id].code`). Set to True to overwrite blindly —
        useful when the agent intentionally discards prior content.
    """
    runtime_ctx = _get_runtime_context()
    if not isinstance(runtime_ctx, KernelRuntimeContext):
        raise RuntimeError("code mode requires a running kernel context")
    cell_manager = runtime_ctx._app.cell_manager if runtime_ctx._app else None
    return AsyncCodeModeContext(
        runtime_ctx._kernel,
        cell_manager=cell_manager,
        skip_validation=skip_validation,
        skip_staleness_check=skip_staleness_check,
    )


class StaleCellError(RuntimeError):