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.

pass down user-config for /snippets (#6583)

Myles Scolnick058d34978044
diff --git a/marimo/_pyodide/pyodide_session.py b/marimo/_pyodide/pyodide_session.py
index dc16f8142a..06c70642a9 100644
--- a/marimo/_pyodide/pyodide_session.py
+++ b/marimo/_pyodide/pyodide_session.py
@@ -261,7 +261,7 @@ class PyodideBridge:
return self._dump(response)
async def read_snippets(self) -> str:
- snippets = await read_snippets()
+ snippets = await read_snippets(self.session._initial_user_config)
return self._dump(snippets)
async def format(self, request: str) -> str:
diff --git a/marimo/_server/api/endpoints/documentation.py b/marimo/_server/api/endpoints/documentation.py
index 37c5115129..07b327af98 100644
--- a/marimo/_server/api/endpoints/documentation.py
+++ b/marimo/_server/api/endpoints/documentation.py
@@ -3,7 +3,10 @@ from __future__ import annotations
from typing import TYPE_CHECKING
+from starlette.authentication import requires
+
from marimo import _loggers
+from marimo._server.api.deps import AppState
from marimo._server.router import APIRouter
from marimo._snippets.snippets import Snippets, read_snippets
@@ -15,12 +18,14 @@ LOGGER = _loggers.marimo_logger()
# Router for documentation
router = APIRouter()
-
+# Cache snippets once per server instance
_SNIPPETS: list[Snippets] = []
@router.get("/snippets")
+@requires("edit")
async def load_snippets(
+ *,
request: Request,
) -> Snippets:
"""
@@ -32,7 +37,8 @@ async def load_snippets(
schema:
$ref: "#/components/schemas/Snippets"
"""
- del request
+ app_state = AppState(request)
+ config = app_state.require_current_session().config_manager.get_config()
if not _SNIPPETS:
- _SNIPPETS.append(await read_snippets())
+ _SNIPPETS.append(await read_snippets(config))
return _SNIPPETS[0]
diff --git a/marimo/_snippets/snippets.py b/marimo/_snippets/snippets.py
index e995be0de0..1a6359c496 100644
--- a/marimo/_snippets/snippets.py
+++ b/marimo/_snippets/snippets.py
@@ -9,7 +9,7 @@ import msgspec
from marimo import _loggers
from marimo._ast.load import load_app
-from marimo._config.manager import get_default_config_manager
+from marimo._config.config import MarimoConfig
from marimo._utils.paths import marimo_package_path
LOGGER = _loggers.marimo_logger()
@@ -30,10 +30,10 @@ class Snippets(msgspec.Struct, rename="camel"):
snippets: list[Snippet]
-async def read_snippets() -> Snippets:
+async def read_snippets(config: MarimoConfig) -> Snippets:
snippets: list[Snippet] = []
- for file in read_snippet_filenames_from_config():
+ for file in read_snippet_filenames_from_config(config):
app = load_app(file)
assert app is not None
sections: list[SnippetSection] = []
@@ -51,14 +51,14 @@ async def read_snippets() -> Snippets:
if not title and "# " in code:
title = get_title_from_code(code)
- ret = cell.run()
- if isinstance(ret, Awaitable):
- output, _defs = await ret
- else:
- output, _defs = ret
- sections.append(
- SnippetSection(html=output.text, id=cell._cell.cell_id)
- )
+ ret = cell.run()
+ if isinstance(ret, Awaitable):
+ output, _defs = await ret
+ else:
+ output, _defs = ret
+ sections.append(
+ SnippetSection(html=output.text, id=cell._cell.cell_id)
+ )
else:
sections.append(
SnippetSection(code=code, id=cell._cell.cell_id)
@@ -102,9 +102,10 @@ def is_markdown(code: str) -> bool:
return code.strip().startswith("mo.md")
-def read_snippet_filenames_from_config() -> Generator[str, Any, None]:
+def read_snippet_filenames_from_config(
+ config: MarimoConfig,
+) -> Generator[str, Any, None]:
# Get custom snippets path from config if present
- config = get_default_config_manager(current_path=None).get_config()
custom_paths = config.get("snippets", {}).get("custom_paths", [])
include_default_snippets = config.get("snippets", {}).get(
"include_default_snippets", True
diff --git a/tests/_server/api/endpoints/test_documentation.py b/tests/_server/api/endpoints/test_documentation.py
index 3d8343402e..0da799e3fe 100644
--- a/tests/_server/api/endpoints/test_documentation.py
+++ b/tests/_server/api/endpoints/test_documentation.py
@@ -1,9 +1,18 @@
# Copyright 2024 Marimo. All rights reserved.
from starlette.testclient import TestClient
+from tests._server.mocks import token_header, with_session
+SESSION_ID = "session-123"
+HEADERS = {
+ "Marimo-Session-Id": SESSION_ID,
+ **token_header("fake-token"),
+}
+
+
+@with_session(SESSION_ID)
def test_snippets(client: TestClient) -> None:
- response = client.get("/api/documentation/snippets")
+ response = client.get("/api/documentation/snippets", headers=HEADERS)
assert response.status_code == 200, response.text
content = response.json()
assert content["snippets"] is not None
@@ -12,7 +21,7 @@ def test_snippets(client: TestClient) -> None:
# call the endpoint a second time and make sure the
# same snippets are retrieved
- response = client.get("/api/documentation/snippets")
+ response = client.get("/api/documentation/snippets", headers=HEADERS)
assert response.status_code == 200, response.text
content = response.json()
assert content["snippets"] is not None
diff --git a/tests/_snippets/test_snippets.py b/tests/_snippets/test_snippets.py
index b57e9d4dfd..05fb561793 100644
--- a/tests/_snippets/test_snippets.py
+++ b/tests/_snippets/test_snippets.py
@@ -2,6 +2,7 @@ from __future__ import annotations
import pytest
+from marimo._config.config import merge_default_config
from marimo._snippets.snippets import (
get_title_from_code,
read_snippet_filenames,
@@ -11,7 +12,7 @@ from marimo._utils.platform import is_windows
async def test_snippets() -> None:
- snippets = await read_snippets()
+ snippets = await read_snippets(merge_default_config({}))
assert len(snippets.snippets) > 0
# All have titles
for s in snippets.snippets: