Miscellaneous

marimo.running_in_notebook

running_in_notebook() -> bool

Returns True if running in a marimo notebook, False otherwise

marimo.defs

defs() -> tuple[str, ...]

Get the definitions of the currently executing cell.

RETURNS	DESCRIPTION
tuple[str, ...]	tuple[str, ...]: A tuple of the currently executing cell's defs.

marimo.refs

refs() -> tuple[str, ...]

Get the references of the currently executing cell.

RETURNS	DESCRIPTION
tuple[str, ...]	tuple[str, ...]: A tuple of the currently executing cell's refs.

marimo.notebook_dir

notebook_dir() -> Path | None

Get the directory of the currently executing notebook.

RETURNS	DESCRIPTION
Path | None	pathlib.Path | None: A pathlib.Path object representing the directory of the current notebook, or None if the notebook's directory cannot be determined.

Examples:

data_file = mo.notebook_dir() / "data" / "example.csv"
# Use the directory to read a file
if data_file.exists():
    print(f"Found data file: {data_file}")
else:
    print("No data file found")

marimo.Thread

Thread(*args: Any, **kwargs: Any)

Bases: Thread

A Thread subclass that is aware of marimo internals.

mo.Thread has the same API as threading.Thread, but mo.Threads are able to communicate with the marimo frontend, whereas threading.Thread can't.

run

run() -> None