Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

1.9 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */

export const DEFAULT_CELL_NAME = "_";

const DISALLOWED_NAMES = new Set([
  // Generated with `python scripts/print_banned_cell_names.py`
  "__*",
  "marimo",
  "app",
  "False",
  "None",
  "True",
  "__peg_parser__",
  "and",
  "as",
  "assert",
  "async",
  "await",
  "break",
  "class",
  "continue",
  "def",
  "del",
  "elif",
  "else",
  "except",
  "finally",
  "for",
  "from",
  "global",
  "if",
  "import",
  "in",
  "is",
  "lambda",
  "nonlocal",
  "not",
  "or",
  "pass",
  "raise",
  "return",
  "try",
  "while",
  "with",
  "yield",
  "None",
  // Special case for the setup cell
  "setup",
]);

/**
 * Make's name pythonic - removes spaces, special characters and makes lowercase
 */
export function normalizeName(name: string, lowercase = true): string {
  name = name.trim();
  if (!name) {
    return DEFAULT_CELL_NAME;
  }
  // Cannot start with a number
  if (/^\d/.test(name)) {
    name = `_${name}`;
  }
  name = name.replaceAll(/\W/g, "_");
  return lowercase ? name.toLowerCase() : name;
}

/**
 * Get a non-conflicting name
 */
export function getValidName(name: string, existingNames: string[]): string {
  const set = new Set(existingNames);
  let result = name;

  const isValid = (name: string) => {
    return !set.has(name) && !DISALLOWED_NAMES.has(name);
  };

  if (isValid(name)) {
    return name;
  }

  let count = 1;
  while (!isValid(result)) {
    result = `${name}_${count}`;
    count++;
  }

  return result;
}

/**
 * Print the cell name if differs from DEFAULT_CELL_NAME
 */
export function displayCellName(name: string, cellIndex: number): string {
  if (isInternalCellName(name)) {
    return `cell-${cellIndex}`;
  }
  return name;
}

// Default cell names are "_" and "__" (for backwards compatibility)
export function isInternalCellName(name: string | undefined): boolean {
  if (!name) {
    return true;
  }
  return name === DEFAULT_CELL_NAME || name === "__";
}