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.

refactor: centralize page configuration rendering (#11619)

Myles Scolnick7c0ac9884d85
diff --git a/marimo/_templates.py b/marimo/_templates.py
index bd15c83b32..e6b14ad93d 100644
--- a/marimo/_templates.py
+++ b/marimo/_templates.py
@@ -92,7 +92,19 @@ def _static_state_block(
)
-def _get_mount_config(
+def _get_frontend_config(
+ config: MarimoConfig | PartialMarimoConfig, *, readonly: bool
+) -> PartialMarimoConfig:
+ # Integration settings are only used by the editor.
+ excluded = {"ai", "completion", "mcp"} if readonly else set()
+ return cast(
+ PartialMarimoConfig,
+ {key: value for key, value in config.items() if key not in excluded},
+ )
+
+
+def _render_page_config(
+ html: str,
*,
filename: str | None,
cwd: str | None = None,
@@ -110,9 +122,11 @@ def _get_mount_config(
layout: LayoutConfig | None = None,
) -> str:
"""
- Return a JSON string with custom indentation and sorting.
+ Render the page configuration and legacy template placeholders.
"""
+ readonly = mode in ("read", "gallery")
+ frontend_config = _get_frontend_config(user_config, readonly=readonly)
options: dict[str, Any] = {
"filename": filename or "",
"cwd": cwd or "",
@@ -120,8 +134,10 @@ def _get_mount_config(
"mode": mode,
"version": version or get_version(),
"server_token": str(server_token),
- "user_config": user_config,
- "config_overrides": config_overrides,
+ "user_config": frontend_config,
+ "config_overrides": _get_frontend_config(
+ config_overrides, readonly=readonly
+ ),
"app_config": _del_none_or_empty(app_config.asdict())
if app_config
else {},
@@ -145,7 +161,7 @@ def _get_mount_config(
"hostEnabled": mode == "edit",
}
)
- return """{{
+ mount_config = """{{
"filename": {filename},
"cwd": {cwd},
"lspWorkspace": {lsp_workspace},
@@ -167,6 +183,14 @@ def _get_mount_config(
pair_config=pair_config,
).strip()
+ # Legacy placeholders are still used by the VS Code plugin.
+ html = html.replace("{{ version }}", options["version"])
+ html = html.replace(
+ "{{ user_config }}", _html_escape(json.dumps(frontend_config))
+ )
+ html = html.replace("{{ server_token }}", str(server_token))
+ return html.replace(MOUNT_CONFIG_TEMPLATE, mount_config)
+
def home_page_template(
html: str,
@@ -181,28 +205,19 @@ def home_page_template(
html = html.replace("{{ title }}", "marimo")
html = html.replace("{{ filename }}", "")
- # TODO(Trevor): Legacy, required by VS Code plugin. Remove when plugin is updated (see frontend/index.html)
- html = html.replace("{{ version }}", get_version())
- html = html.replace(
- "{{ user_config }}", _html_escape(json.dumps(user_config))
- )
- html = html.replace("{{ server_token }}", str(server_token))
-
html = _replace_asset_urls(html, asset_url)
app_mode: Literal["home", "gallery"] = (
"home" if mode == SessionMode.EDIT else "gallery"
)
- html = html.replace(
- MOUNT_CONFIG_TEMPLATE,
- _get_mount_config(
- filename=None,
- mode=app_mode,
- server_token=server_token,
- user_config=user_config,
- config_overrides=config_overrides,
- app_config=None,
- ),
+ html = _render_page_config(
+ html,
+ filename=None,
+ mode=app_mode,
+ server_token=server_token,
+ user_config=user_config,
+ config_overrides=config_overrides,
+ app_config=None,
)
# Add custom CSS from display config
@@ -319,31 +334,22 @@ def notebook_page_template(
html = html.replace("{{ filename }}", _html_escape(filename or ""))
- # TODO(Trevor): Legacy, required by VS Code plugin. Remove when plugin is updated (see frontend/index.html)
- html = html.replace("{{ version }}", get_version())
- html = html.replace(
- "{{ user_config }}", _html_escape(json.dumps(user_config))
- )
- html = html.replace("{{ server_token }}", str(server_token))
-
html = _replace_asset_urls(html, asset_url)
cwd = os.path.dirname(filepath) if filepath else None
- html = html.replace(
- MOUNT_CONFIG_TEMPLATE,
- _get_mount_config(
- filename=filename,
- cwd=cwd,
- lsp_workspace=lsp_workspace,
- mode="read" if mode == SessionMode.RUN else "edit",
- server_token=server_token,
- user_config=user_config,
- config_overrides=config_overrides,
- app_config=app_config,
- runtime_config=runtime_config,
- notebook_snapshot=notebook_snapshot,
- session_snapshot=session_snapshot,
- ),
+ html = _render_page_config(
+ html,
+ filename=filename,
+ cwd=cwd,
+ lsp_workspace=lsp_workspace,
+ mode="read" if mode == SessionMode.RUN else "edit",
+ server_token=server_token,
+ user_config=user_config,
+ config_overrides=config_overrides,
+ app_config=app_config,
+ runtime_config=runtime_config,
+ notebook_snapshot=notebook_snapshot,
+ session_snapshot=session_snapshot,
)
html = html.replace(
@@ -436,21 +442,19 @@ def static_notebook_template(
# but we do need some:
# - display.theme
# - display.cell_output
- html = html.replace(
- MOUNT_CONFIG_TEMPLATE,
- _get_mount_config(
- filename=filename,
- cwd=None, # We don't need the cwd for static notebooks
- mode="read",
- server_token=server_token,
- user_config=user_config,
- config_overrides=config_overrides,
- app_config=app_config,
- session_snapshot=session_snapshot,
- notebook_snapshot=notebook_snapshot,
- runtime_config=None,
- layout=layout,
- ),
+ html = _render_page_config(
+ html,
+ filename=filename,
+ cwd=None, # We don't need the cwd for static notebooks
+ mode="read",
+ server_token=server_token,
+ user_config=user_config,
+ config_overrides=config_overrides,
+ app_config=app_config,
+ session_snapshot=session_snapshot,
+ notebook_snapshot=notebook_snapshot,
+ runtime_config=None,
+ layout=layout,
)
html = html.replace(
@@ -557,23 +561,21 @@ def wasm_notebook_template(
)
body = body.replace("{{ filename }}", _html_escape("notebook.py"))
- body = body.replace(
- MOUNT_CONFIG_TEMPLATE,
- _get_mount_config(
- # WASM runtime currently expect this to be notebook.py instead of the actual filename
- filename="notebook.py",
- mode="edit" if mode == "edit" else "read",
- server_token=SkewProtectionToken("unused"),
- user_config=user_config,
- config_overrides=config_overrides,
- app_config=app_config,
- version=version,
- show_app_code=show_code,
- runtime_config=None,
- session_snapshot=session_snapshot,
- notebook_snapshot=notebook_snapshot,
- layout=layout,
- ),
+ body = _render_page_config(
+ body,
+ # WASM runtime currently expect this to be notebook.py instead of the actual filename
+ filename="notebook.py",
+ mode="edit" if mode == "edit" else "read",
+ server_token=SkewProtectionToken("unused"),
+ user_config=user_config,
+ config_overrides=config_overrides,
+ app_config=app_config,
+ version=version,
+ show_app_code=show_code,
+ runtime_config=None,
+ session_snapshot=session_snapshot,
+ notebook_snapshot=notebook_snapshot,
+ layout=layout,
)
wasm_attributes = "".join(
diff --git a/tests/_server/templates/snapshots/export1.txt b/tests/_server/templates/snapshots/export1.txt
index 8273821aa6..9b06bcd57b 100644
--- a/tests/_server/templates/snapshots/export1.txt
+++ b/tests/_server/templates/snapshots/export1.txt
@@ -100,7 +100,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"allow_provider_config": true, "custom_providers": {}, "enabled": true, "models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "auto_close_pairs": true, "copilot": false, "signature_hint_on_typing": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"layout": null,
diff --git a/tests/_server/templates/snapshots/export2.txt b/tests/_server/templates/snapshots/export2.txt
index 20a6bb4f22..f77c6017bd 100644
--- a/tests/_server/templates/snapshots/export2.txt
+++ b/tests/_server/templates/snapshots/export2.txt
@@ -100,7 +100,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"allow_provider_config": true, "custom_providers": {}, "enabled": true, "models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "auto_close_pairs": true, "copilot": false, "signature_hint_on_typing": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"layout": null,
diff --git a/tests/_server/templates/snapshots/export3.txt b/tests/_server/templates/snapshots/export3.txt
index 8582a6a7fe..800edcc53e 100644
--- a/tests/_server/templates/snapshots/export3.txt
+++ b/tests/_server/templates/snapshots/export3.txt
@@ -100,7 +100,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"allow_provider_config": true, "custom_providers": {}, "enabled": true, "models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "auto_close_pairs": true, "copilot": false, "signature_hint_on_typing": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"layout": null,
diff --git a/tests/_server/templates/snapshots/export4.txt b/tests/_server/templates/snapshots/export4.txt
index e3cac4fb67..8b412b3708 100644
--- a/tests/_server/templates/snapshots/export4.txt
+++ b/tests/_server/templates/snapshots/export4.txt
@@ -100,7 +100,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"allow_provider_config": true, "custom_providers": {}, "enabled": true, "models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "auto_close_pairs": true, "copilot": false, "signature_hint_on_typing": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"css_file": "custom.css", "sql_output": "auto", "width": "compact"},
"layout": null,
diff --git a/tests/_server/templates/snapshots/export5.txt b/tests/_server/templates/snapshots/export5.txt
index da29a09773..f6a05fdfe4 100644
--- a/tests/_server/templates/snapshots/export5.txt
+++ b/tests/_server/templates/snapshots/export5.txt
@@ -112,7 +112,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"allow_provider_config": true, "custom_providers": {}, "enabled": true, "models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "auto_close_pairs": true, "copilot": false, "signature_hint_on_typing": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"app_title": "My App", "html_head_file": "head.html", "sql_output": "auto", "width": "compact"},
"layout": null,
diff --git a/tests/_server/templates/snapshots/export6.txt b/tests/_server/templates/snapshots/export6.txt
index 682eef2274..bcec7905df 100644
--- a/tests/_server/templates/snapshots/export6.txt
+++ b/tests/_server/templates/snapshots/export6.txt
@@ -101,7 +101,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"allow_provider_config": true, "custom_providers": {}, "enabled": true, "models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "auto_close_pairs": true, "copilot": false, "signature_hint_on_typing": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "custom_css": ["custom1.css", "custom2.css"], "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "code_lens": true, "custom_css": ["custom1.css", "custom2.css"], "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"infer_types": "off", "line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "package_management": {"manager": "uv"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_csv_encoding": "utf-8", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "show_tracebacks": false, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"layout": null,
diff --git a/tests/_server/templates/test_templates.py b/tests/_server/templates/test_templates.py
index 562ad759c8..ed6ee84c76 100644
--- a/tests/_server/templates/test_templates.py
+++ b/tests/_server/templates/test_templates.py
@@ -1,13 +1,18 @@
from __future__ import annotations
+import html
import json
import shutil
import tempfile
import unittest
+from copy import deepcopy
+from functools import partial
from pathlib import Path
-from typing import Literal
+from typing import Literal, cast
from unittest.mock import patch
+import pytest
+
import marimo._templates as templates
from marimo._ast.app_config import _AppConfig
from marimo._config.config import (
@@ -32,7 +37,10 @@ from marimo._schemas.session import (
from marimo._server.tokens import SkewProtectionToken
from marimo._session.model import SessionMode
from marimo._utils.code import hash_code
-from tests._server.templates.utils import normalize_index_html
+from tests._server.templates.utils import (
+ normalize_index_html,
+ parse_mount_config,
+)
from tests.mocks import snapshotter
snapshot = snapshotter(__file__)
@@ -44,6 +52,175 @@ def _assert_no_leftover_replacements(result: str) -> None:
assert not has_replacement, f"Found {{}} in {result}"
+ ("page", "mode"),
+ [
+ ("notebook", SessionMode.EDIT),
+ ("notebook", SessionMode.RUN),
+ ("home", SessionMode.EDIT),
+ ("home", SessionMode.RUN),
+ ("wasm", SessionMode.EDIT),
+ ("wasm", SessionMode.RUN),
+ ("static", SessionMode.RUN),
+ ],
+)
[email protected]("with_overrides", [False, True])
+def test_page_config_by_mode(
+ mode: SessionMode, page: str, with_overrides: bool
+) -> None:
+ config = merge_default_config(
+ {
+ "display": {"theme": "dark", "locale": "français <>&\"'"},
+ "runtime": {"show_tracebacks": True},
+ "server": {"transport": "sse"},
+ "completion": {
+ "codeium_api_key": "completion-codeium-marker",
+ "api_key": "completion-custom-marker",
+ },
+ "ai": {
+ "open_ai": {
+ "api_key": "ai-key-marker",
+ "extra_headers": {"Authorization": "ai-header-marker"},
+ },
+ "custom_providers": {
+ "custom": {
+ "extra_headers": {"X-Token": "custom-header-marker"}
+ }
+ },
+ },
+ }
+ )
+ config["mcp"] = {
+ "mcpServers": {
+ "local": {
+ "command": "example",
+ "env": {"TOKEN": "mcp-env-marker"},
+ },
+ "remote": {
+ "url": "https://example.com/mcp",
+ "headers": {"Authorization": "mcp-header-marker"},
+ },
+ }
+ }
+ original_config = deepcopy(config)
+ template = (Path(__file__).parent / "data" / "index.html").read_text()
+ template += (
+ '<marimo-user-config data-config="{{ user_config }}">'
+ "<marimo-version>{{ version }}</marimo-version>"
+ "<marimo-server-token>{{ server_token }}</marimo-server-token>"
+ )
+ overrides = cast(
+ PartialMarimoConfig,
+ {
+ "display": {"locale": "français <>&\"'"},
+ "ai": {"rules": "override-ai-marker"},
+ "completion": {},
+ "mcp": {"mcpServers": {}},
+ }
+ if with_overrides
+ else {},
+ )
+ original_overrides = deepcopy(overrides)
+ if page == "home":
+ render = partial(
+ templates.home_page_template,
+ base_url="",
+ server_token=SkewProtectionToken("token"),
+ mode=mode,
+ )
+ elif page == "wasm":
+ render = partial(
+ templates.wasm_notebook_template,
+ version="1.0.0",
+ filename="notebook.py",
+ app_config=_AppConfig(),
+ mode="run" if mode == SessionMode.RUN else "edit",
+ code="",
+ show_code=False,
+ )
+ elif page == "static":
+ render = partial(
+ templates.static_notebook_template,
+ server_token=SkewProtectionToken("token"),
+ app_config=_AppConfig(),
+ filepath=None,
+ code="",
+ code_hash="",
+ session_snapshot=NotebookSessionV1(
+ version=VERSION,
+ metadata=NotebookSessionMetadata(marimo_version="1.0.0"),
+ cells=[],
+ ),
+ notebook_snapshot=NotebookV1(
+ version=VERSION,
+ metadata=NotebookMetadata(marimo_version="1.0.0"),
+ cells=[],
+ ),
+ files={},
+ )
+ else:
+ render = partial(
+ templates.notebook_page_template,
+ base_url="",
+ server_token=SkewProtectionToken("token"),
+ app_config=_AppConfig(),
+ filename=None,
+ mode=mode,
+ )
+ result = render(
+ html=template, user_config=config, config_overrides=overrides
+ )
+
+ mount_config = parse_mount_config(result)
+ expected = dict(original_config)
+ expected_overrides = dict(original_overrides)
+ if mode == SessionMode.RUN:
+ for key in ("ai", "completion", "mcp"):
+ del expected[key]
+ expected_overrides.pop(key, None)
+ assert "-marker" not in result
+
+ assert mount_config["config"] == expected
+ assert mount_config["configOverrides"] == expected_overrides
+ legacy_config = result.split('data-config="', 1)[1].split('"', 1)[0]
+ assert json.loads(html.unescape(legacy_config)) == expected
+ assert (
+ f"<marimo-version>{mount_config['version']}</marimo-version>" in result
+ )
+ assert (
+ f"<marimo-server-token>{mount_config['serverToken']}</marimo-server-token>"
+ in result
+ )
+ _assert_no_leftover_replacements(result)
+ assert config == original_config
+ assert overrides == original_overrides
+
+
[email protected]("mode", ["edit", "home", "read", "gallery"])
[email protected]("legacy", [False, True])
+def test_page_config_empty(
+ mode: Literal["edit", "home", "read", "gallery"], legacy: bool
+) -> None:
+ template = (
+ "{{ user_config }}" if legacy else templates.MOUNT_CONFIG_TEMPLATE
+ )
+ result = templates._render_page_config(
+ template,
+ filename=None,
+ mode=mode,
+ user_config=MarimoConfig(),
+ config_overrides={},
+ server_token=SkewProtectionToken("token"),
+ app_config=None,
+ )
+ if legacy:
+ assert result == "{}"
+ else:
+ config = json.loads(result)
+ assert config["config"] == {}
+ assert config["configOverrides"] == {}
+
+
class TestNotebookPageTemplate(unittest.TestCase):
def setUp(self) -> None:
tmp_path = Path(tempfile.mkdtemp())
@@ -1208,7 +1385,9 @@ class TestWasmNotebookTemplate(unittest.TestCase):
assert self.filename.name in result
assert self.mode in result
- assert json.dumps(self.user_config, sort_keys=True) in result
+ config = parse_mount_config(result)["config"]
+ assert config["display"] == self.user_config["display"]
+ assert {"ai", "completion", "mcp"}.isdisjoint(config)
assert '<marimo-wasm hidden="">' in result
assert "__MARIMO_EXPORT_CONTEXT__" in result
assert '<marimo-code hidden="">' in result
diff --git a/tests/_server/test_templates_filename.py b/tests/_server/test_templates_filename.py
index 23f400b873..46f23ee739 100644
--- a/tests/_server/test_templates_filename.py
+++ b/tests/_server/test_templates_filename.py
@@ -9,8 +9,9 @@ from marimo._ast.app_config import _AppConfig
from marimo._config.config import MarimoConfig, PartialMarimoConfig
from marimo._server.tokens import SkewProtectionToken
from marimo._templates import (
- _get_mount_config,
+ MOUNT_CONFIG_TEMPLATE,
_html_escape,
+ _render_page_config,
json_script,
)
from tests.mocks import EDGE_CASE_FILENAMES
@@ -59,16 +60,17 @@ class TestTemplateFilenameHandling:
"filename",
[*EDGE_CASE_FILENAMES, None],
)
- def test_get_mount_config_filename_handling(
+ def test_render_page_config_filename_handling(
self, filename: str | None
) -> None:
- """Test _get_mount_config function with problematic filenames."""
+ """Test _render_page_config function with problematic filenames."""
server_token = SkewProtectionToken("test-token")
user_config = MarimoConfig()
config_overrides = PartialMarimoConfig()
app_config = _AppConfig()
- result = _get_mount_config(
+ result = _render_page_config(
+ MOUNT_CONFIG_TEMPLATE,
filename=filename,
mode="edit",
server_token=server_token,
@@ -258,7 +260,7 @@ class TestJsonScriptEscaping:
class TestMountConfigInjectionPrevention:
- """Test _get_mount_config prevents injection attacks in all fields."""
+ """Test _render_page_config prevents injection attacks in all fields."""
@pytest.mark.parametrize(
"malicious_filename",
@@ -278,7 +280,8 @@ class TestMountConfigInjectionPrevention:
config_overrides = PartialMarimoConfig()
app_config = _AppConfig()
- result = _get_mount_config(
+ result = _render_page_config(
+ MOUNT_CONFIG_TEMPLATE,
filename=malicious_filename,
mode="edit",
server_token=server_token,
@@ -315,7 +318,8 @@ class TestMountConfigInjectionPrevention:
config_overrides = PartialMarimoConfig()
app_config = _AppConfig(app_title=malicious_title)
- result = _get_mount_config(
+ result = _render_page_config(
+ MOUNT_CONFIG_TEMPLATE,
filename="test.py",
mode="edit",
server_token=server_token,