Method create_cell

marimo/_code_mode/_context.py:1037–1114

Queue a new cell. Returns the new cell's ID. The returned ID can be used in subsequent operations within the same batch (e.g. as an `after` target for the next cell). Cells are not executed automatically. Use `run_cell` to queue them for execution:: cid

(
        self,
        code: str,
        *,
        before: str | None = None,
        after: str | None = None,
        hide_code: bool = True,
        disabled: bool = False,
        column: int | None = None,
        name: str | None = None,
    )

        return cell_id, name

    def create_cell(
        self,
        code: str,
        *,
        before: str | None = None,
        after: str | None = None,
        hide_code: bool = True,
        disabled: bool = False,
        column: int | None = None,
        name: str | None = None,
    ) -> CellId_t:
        """Queue a new cell. Returns the new cell's ID.

        The returned ID can be used in subsequent operations within the
        same batch (e.g. as an `after` target for the next cell).

        Cells are not executed automatically. Use `run_cell` to queue
        them for execution::

            cid = ctx.create_cell("x = 1")
            ctx.run_cell(cid)

        Examples:
            ```python
            # Append at the end
            cid = ctx.create_cell("import pandas as pd")

            # Chain cells in order
            cid2 = ctx.create_cell("df = pd.read_csv('data.csv')", after=cid)
            ctx.create_cell("df.head()", after=cid2)

            # Create and run
            cid = ctx.create_cell("x = 1")
            ctx.run_cell(cid)
            ```

        Args:
            code (str): Python source code for the cell.
            before (str, optional): Insert before this cell (ID or name).
                Mutually exclusive with `after`.
            after (str, optional): Insert after this cell (ID or name).
                Mutually exclusive with `before`.
            hide_code (bool): Collapse the code editor in the UI.
                Defaults to True.
            disabled (bool): Prevent the cell from executing.
                Defaults to False.
            column (int, optional): Column index for multi-column layouts.
            name (str, optional): Cell names are a human-facing label,
                reserved for special cases (e.g. `"setup"`). Prefer
                referencing cells by the returned cell ID unless
                naming is important for the user.
        """
        self._require_entered()
        if before is not None and after is not None:
            raise ValueError("Cannot specify both 'before' and 'after'")

        cell_id, resolved_name = self._resolve_new_cell(name)