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.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
feat: enable passing in token password from file (#6974)
Dylan Madisetti17cfc88e7918
diff --git a/marimo/_cli/cli.py b/marimo/_cli/cli.pyindex 7679b41024..134eab0c29 100644--- a/marimo/_cli/cli.py+++ b/marimo/_cli/cli.py@@ -14,8 +14,6 @@ import clickimport marimo._cli.cli_validators as validatorsfrom marimo import _loggersfrom marimo._ast import codegen-from marimo._ast.load import get_notebook_status-from marimo._ast.parse import MarimoFileErrorfrom marimo._cli.config.commands import configfrom marimo._cli.convert.commands import convertfrom marimo._cli.development.commands import development@@ -23,17 +21,21 @@ from marimo._cli.envinfo import get_system_infofrom marimo._cli.export.commands import exportfrom marimo._cli.file_path import validate_namefrom marimo._cli.parse_args import parse_args-from marimo._cli.print import bold, green, red+from marimo._cli.print import redfrom marimo._cli.run_docker import (prompt_run_in_docker_container,)from marimo._cli.upgrade import check_for_updates, print_latest_version+from marimo._cli.utils import (+ check_app_correctness,+ check_app_correctness_or_convert,+ resolve_token,+)from marimo._config.settings import GLOBAL_SETTINGSfrom marimo._lint import run_checkfrom marimo._server.file_router import AppFileRouterfrom marimo._server.model import SessionModefrom marimo._server.start import start-from marimo._server.tokens import AuthTokenfrom marimo._tutorials import (Tutorial,create_temp_tutorial_file,@@ -58,84 +60,6 @@ def helpful_usage_error(self: Any, file: Any = None) -> None:click.echo(self.ctx.get_help(), file=file, color=color)-def check_app_correctness(filename: str, noninteractive: bool = True) -> None:- try:- status = get_notebook_status(filename).status- except (SyntaxError, MarimoFileError):- # Exit early if we can- if not noninteractive:- raise-- # This prints a more readable error message, without internal details- # e.g.- # Error: File "/my/bad/file.py", line 17- # x.- # ^- # SyntaxError: invalid syntax- from marimo._lint import collect_messages-- _, message = collect_messages(filename)- raise click.ClickException(message.strip()) from None-- if status == "invalid" and filename.endswith(".py"):- # fail for python scripts, almost certainly do not want to override contents- import os-- stem = os.path.splitext(os.path.basename(filename))[0]- raise click.ClickException(- f"Python script not recognized as a marimo notebook.\n\n"- f" {green('Tip:')} Try converting with"- "\n\n"- f" marimo convert {filename} -o {stem}_nb.py\n\n"- f" then open with marimo edit {stem}_nb.py"- ) from None-- # Only show the tip if we're in an interactive terminal- interactive = sys.stdin.isatty() and not noninteractive- if status == "invalid" and interactive:- click.echo(- green("tip")- + ": Use `"- + bold("marimo convert")- + "` to convert existing scripts.",- err=True,- )- click.confirm(- (- "The file is not detected as a marimo notebook, opening it may "- "overwrite its contents.\nDo you want to open it anyway?"- ),- default=False,- abort=True,- )-- if status == "has_errors":- # Provide a warning, but allow the user to open the notebook- _loggers.marimo_logger().warning(- "This notebook has errors, saving may lose data. Continuing anyway."- )---def check_app_correctness_or_convert(filename: str) -> None:- from marimo._convert.converters import MarimoConvert-- file = Path(filename)- code = file.read_text(encoding="utf-8")- try:- return check_app_correctness(filename, noninteractive=True)- except (click.ClickException, MarimoFileError):- # A click exception is raised if a python script could not be converted- code = MarimoConvert.from_non_marimo_python_script(- source=code, aggressive=True- ).to_py()- except SyntaxError:- # The file could not even be read as python- code = MarimoConvert.from_plain_text(source=code).to_py()- file.write_text(code, encoding="utf-8")-- file.write_text(code, encoding="utf-8")--click.exceptions.UsageError.show = helpful_usage_error # type: ignore@@ -159,18 +83,6 @@ def _key_value_bullets(items: list[tuple[str, str]]) -> str:return "\n".join(lines)-def _resolve_token(- token: bool, token_password: Optional[str]-) -> Optional[AuthToken]:- if token_password:- return AuthToken(token_password)- elif token is False:- # Empty means no auth- return AuthToken("")- # None means use the default (generated) token- return None--main_help_msg = "\n".join(["\b",@@ -377,6 +289,13 @@ edit_help_msg = "\n".join(type=str,help=token_password_message,)+ "--token-password-file",+ default=None,+ show_default=True,+ type=str,+ help="Path to file containing token password, or '-' for stdin. Mutually exclusive with --token-password.",+)@click.option("--base-url",default="",@@ -496,6 +415,7 @@ def edit(headless: bool,token: bool,token_password: Optional[str],+ token_password_file: Optional[str],base_url: str,allow_origins: Optional[tuple[str, ...]],skip_update_check: bool,@@ -515,8 +435,13 @@ def edit() -> None:from marimo._cli.sandbox import run_in_sandbox, should_run_in_sandbox+ pass_on_stdin = token_password_file == "-"# We support unix-style piping, e.g. cat notebook.py | marimo edit- if name is None and (stdin_contents := _get_stdin_contents()) is not None:+ if (+ not pass_on_stdin+ and name is None+ and (stdin_contents := _get_stdin_contents()) is not None+ ):temp_dir = tempfile.TemporaryDirectory()path = create_temp_notebook_file("notebook.py", "py", stdin_contents, temp_dir@@ -598,7 +523,11 @@ def edit(skew_protection=skew_protection,cli_args=parse_args(args),argv=list(args),- auth_token=_resolve_token(token, token_password),+ auth_token=resolve_token(+ token,+ token_password=token_password,+ token_password_file=token_password_file,+ ),base_url=base_url,allow_origins=allow_origins,redirect_console_to_browser=True,@@ -682,6 +611,13 @@ new_help_msg = "\n".join(type=str,help=token_password_message,)+ "--token-password-file",+ default=None,+ show_default=True,+ type=str,+ help="Path to file containing token password, or '-' for stdin. Mutually exclusive with --token-password.",+)@click.option("--base-url",default="",@@ -722,6 +658,7 @@ def new(headless: bool,token: bool,token_password: Optional[str],+ token_password_file: Optional[str],base_url: str,sandbox: Optional[bool],skew_protection: bool,@@ -800,7 +737,11 @@ def new(skew_protection=skew_protection,cli_args={},argv=[],- auth_token=_resolve_token(token, token_password),+ auth_token=resolve_token(+ token,+ token_password=token_password,+ token_password_file=token_password_file,+ ),base_url=base_url,redirect_console_to_browser=True,ttl_seconds=None,@@ -861,6 +802,13 @@ Example:type=str,help=token_password_message,)+ "--token-password-file",+ default=None,+ show_default=True,+ type=str,+ help="Path to file containing token password, or '-' for stdin. Mutually exclusive with --token-password.",+)@click.option("--include-code",is_flag=True,@@ -961,6 +909,7 @@ def run(headless: bool,token: bool,token_password: Optional[str],+ token_password_file: Optional[str],include_code: bool,session_ttl: int,watch: bool,@@ -1034,7 +983,11 @@ def run(allow_origins=allow_origins,cli_args=parse_args(args),argv=list(args),- auth_token=_resolve_token(token, token_password),+ auth_token=resolve_token(+ token,+ token_password=token_password,+ token_password_file=token_password_file,+ ),redirect_console_to_browser=redirect_console_to_browser,server_startup_command=server_startup_command,asset_url=asset_url,@@ -1112,6 +1065,13 @@ Recommended sequence:type=str,help=token_password_message,)+ "--token-password-file",+ default=None,+ show_default=True,+ type=str,+ help="Path to file containing token password, or '-' for stdin. Mutually exclusive with --token-password.",+)@click.option("--skew-protection/--no-skew-protection",is_flag=True,@@ -1132,6 +1092,7 @@ def tutorial(headless: bool,token: bool,token_password: Optional[str],+ token_password_file: Optional[str],skew_protection: bool,name: Tutorial,) -> None:@@ -1152,7 +1113,11 @@ def tutorial(skew_protection=skew_protection,cli_args={},argv=[],- auth_token=_resolve_token(token, token_password),+ auth_token=resolve_token(+ token,+ token_password=token_password,+ token_password_file=token_password_file,+ ),redirect_console_to_browser=False,ttl_seconds=None,)diff --git a/marimo/_cli/utils.py b/marimo/_cli/utils.pyindex 98b3c7179e..a2ea3101c1 100644--- a/marimo/_cli/utils.py+++ b/marimo/_cli/utils.py@@ -1,15 +1,19 @@# Copyright 2024 Marimo. All rights reserved.from __future__ import annotations+import sys+from pathlib import Pathfrom sys import stdout-from typing import TYPE_CHECKING+from typing import Optionalimport click+from marimo import _loggers+from marimo._ast.load import get_notebook_status+from marimo._ast.parse import MarimoFileError+from marimo._cli.print import bold, greenfrom marimo._config.settings import GLOBAL_SETTINGS--if TYPE_CHECKING:- from pathlib import Path+from marimo._server.tokens import AuthTokendef prompt_to_overwrite(path: Path) -> bool:@@ -28,3 +32,173 @@ def prompt_to_overwrite(path: Path) -> bool:)return True+++def resolve_token(+ token: bool,+ *,+ token_password: Optional[str],+ token_password_file: Optional[str],+) -> Optional[AuthToken]:+ token_password = resolve_token_password(+ token_password=token_password,+ token_password_file=token_password_file,+ )+ if token_password:+ return AuthToken(token_password)+ elif token is False:+ # Empty means no auth+ return AuthToken("")+ # None means use the default (generated) token+ return None+++def resolve_token_password(+ token_password: Optional[str],+ token_password_file: Optional[str],+) -> Optional[str]:+ """+ Resolve token password from mutually exclusive sources.++ Args:+ token_password: Direct password string (legacy)+ token_password_file: Path to file containing password, or '-' for stdin++ Returns:+ The resolved password string, or None if no password source provided++ Raises:+ click.UsageError: If multiple password sources are provided+ """+ # Enforce mutual exclusivity+ if token_password is not None and token_password_file is not None:+ raise click.UsageError(+ "Only one of --token-password or --token-password-file may be specified."+ )++ # Direct password (existing behavior)+ if token_password:+ return token_password++ # Read from file or stdin+ if token_password_file:+ password: str+ try:+ # Handle stdin special case+ if token_password_file == "-":+ if sys.stdin.isatty():+ password = click.prompt(+ "Enter token password", hide_input=True+ )+ else:+ password = sys.stdin.read().strip()+ if not password:+ raise click.UsageError(+ "No token password provided on stdin"+ )+ return password++ # Read from file+ with open(token_password_file, encoding="utf-8") as f:+ password = f.read().strip()+ if not password:+ raise click.UsageError(+ f"No token password found in file: {token_password_file}"+ )+ return password+ except click.UsageError:+ # Re-raise our own usage errors+ raise+ except FileNotFoundError:+ raise click.UsageError(+ f"Token password file not found: {token_password_file}"+ ) from None+ except PermissionError:+ raise click.UsageError(+ f"Permission denied reading token password file: {token_password_file}"+ ) from None+ except Exception as e:+ raise click.UsageError(+ f"Error reading token password from file: {e}"+ ) from None++ # No password source provided+ return None+++def check_app_correctness(filename: str, noninteractive: bool = True) -> None:+ try:+ status = get_notebook_status(filename).status+ except (SyntaxError, MarimoFileError):+ # Exit early if we can+ if not noninteractive:+ raise++ # This prints a more readable error message, without internal details+ # e.g.+ # Error: File "/my/bad/file.py", line 17+ # x.+ # ^+ # SyntaxError: invalid syntax+ from marimo._lint import collect_messages++ _, message = collect_messages(filename)+ raise click.ClickException(message.strip()) from None++ if status == "invalid" and filename.endswith(".py"):+ # fail for python scripts, almost certainly do not want to override contents+ import os++ stem = os.path.splitext(os.path.basename(filename))[0]+ raise click.ClickException(+ f"Python script not recognized as a marimo notebook.\n\n"+ f" {green('Tip:')} Try converting with"+ "\n\n"+ f" marimo convert {filename} -o {stem}_nb.py\n\n"+ f" then open with marimo edit {stem}_nb.py"+ ) from None++ # Only show the tip if we're in an interactive terminal+ interactive = sys.stdin.isatty() and not noninteractive+ if status == "invalid" and interactive:+ click.echo(+ green("tip")+ + ": Use `"+ + bold("marimo convert")+ + "` to convert existing scripts.",+ err=True,+ )+ click.confirm(+ (+ "The file is not detected as a marimo notebook, opening it may "+ "overwrite its contents.\nDo you want to open it anyway?"+ ),+ default=False,+ abort=True,+ )++ if status == "has_errors":+ # Provide a warning, but allow the user to open the notebook+ _loggers.marimo_logger().warning(+ "This notebook has errors, saving may lose data. Continuing anyway."+ )+++def check_app_correctness_or_convert(filename: str) -> None:+ from marimo._convert.converters import MarimoConvert++ file = Path(filename)+ code = file.read_text(encoding="utf-8")+ try:+ return check_app_correctness(filename, noninteractive=True)+ except (click.ClickException, MarimoFileError):+ # A click exception is raised if a python script could not be converted+ code = MarimoConvert.from_non_marimo_python_script(+ source=code, aggressive=True+ ).to_py()+ except SyntaxError:+ # The file could not even be read as python+ code = MarimoConvert.from_plain_text(source=code).to_py()+ file.write_text(code, encoding="utf-8")++ file.write_text(code, encoding="utf-8")diff --git a/tests/_cli/test_cli.py b/tests/_cli/test_cli.pyindex 251305b26d..082873188e 100644--- a/tests/_cli/test_cli.py+++ b/tests/_cli/test_cli.py@@ -309,6 +309,167 @@ def test_cli_edit_token() -> None:_check_contents(p, b'"serverToken": ', contents)+def test_cli_edit_token_password_file_stdin() -> None:+ # Test reading token password from stdin using --token-password-file -+ port = _get_port()+ p = subprocess.Popen(+ [+ "marimo",+ "edit",+ "-p",+ str(port),+ "--headless",+ "--token-password-file",+ "-",+ "--skip-update-check",+ ],+ stdin=subprocess.PIPE,+ )+ if p.stdin:+ p.stdin.write(b"secret_from_stdin")+ p.stdin.close()++ contents = _try_fetch(port, "localhost", "secret_from_stdin")+ _check_contents(p, b'"mode": "home"', contents)+ _check_contents(+ p,+ f'"version": "{get_version()}"'.encode(),+ contents,+ )+ _check_contents(p, b'"serverToken": ', contents)+++def test_cli_edit_token_password_mutual_exclusivity() -> None:+ # Test that --token-password and --token-password-file are mutually exclusive+ result = subprocess.run(+ [+ "marimo",+ "edit",+ "--headless",+ "--token-password",+ "secret1",+ "--token-password-file",+ "-",+ ],+ capture_output=True,+ text=True,+ )+ assert result.returncode != 0+ assert (+ "mutually exclusive" in result.stderr.lower()+ or "only one of" in result.stderr.lower()+ )+++def test_cli_run_token_password_file_stdin() -> None:+ # Test stdin with run command using --token-password-file -+ with _write_temp_notebook(+ """+ import marimo+ app = marimo.App()+ """+ ) as tmp_file:+ port = _get_port()+ p = subprocess.Popen(+ [+ "marimo",+ "run",+ tmp_file,+ "-p",+ str(port),+ "--headless",+ "--token",+ "--token-password-file",+ "-",+ ],+ stdin=subprocess.PIPE,+ )+ if p.stdin:+ p.stdin.write(b"run_secret")+ p.stdin.close()++ contents = _try_fetch(port, "localhost", "run_secret")+ _check_contents(p, b'"appConfig":', contents)+++def test_cli_edit_token_password_file_path() -> None:+ # Test reading token password from a file path+ with tempfile.NamedTemporaryFile(+ mode="w", delete=False, suffix=".txt"+ ) as password_file:+ password_file.write("file_secret")+ password_file_path = password_file.name++ try:+ port = _get_port()+ p = subprocess.Popen(+ [+ "marimo",+ "edit",+ "-p",+ str(port),+ "--headless",+ "--token-password-file",+ password_file_path,+ "--skip-update-check",+ ],+ )++ contents = _try_fetch(port, "localhost", "file_secret")+ _check_contents(p, b'"mode": "home"', contents)+ _check_contents(+ p,+ f'"version": "{get_version()}"'.encode(),+ contents,+ )+ _check_contents(p, b'"serverToken": ', contents)+ finally:+ os.unlink(password_file_path)+++def test_cli_edit_token_password_file_not_found() -> None:+ # Test that a non-existent file raises an error+ result = subprocess.run(+ [+ "marimo",+ "edit",+ "--headless",+ "--token-password-file",+ "/nonexistent/path/to/password.txt",+ ],+ capture_output=True,+ text=True,+ )+ assert result.returncode != 0+ assert "not found" in result.stderr.lower()+++def test_cli_edit_token_password_file_empty() -> None:+ # Test that an empty file raises an error+ with tempfile.NamedTemporaryFile(+ mode="w", delete=False, suffix=".txt"+ ) as password_file:+ # Write nothing to the file+ password_file_path = password_file.name++ try:+ result = subprocess.run(+ [+ "marimo",+ "edit",+ "--headless",+ "--token-password-file",+ password_file_path,+ ],+ capture_output=True,+ text=True,+ )+ assert result.returncode != 0+ assert "no token password" in result.stderr.lower()+ finally:+ os.unlink(password_file_path)++def test_cli_edit_directory() -> None:d = tempfile.TemporaryDirectory()port = _get_port()