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.

Click filenames in stack trace to open locally in editor (#6556)

Yair Chuchemab5b66719c65
diff --git a/frontend/src/components/editor/output/MarimoTracebackOutput.tsx b/frontend/src/components/editor/output/MarimoTracebackOutput.tsx
index ff2a8e1fa5..0d65d2d9bd 100644
--- a/frontend/src/components/editor/output/MarimoTracebackOutput.tsx
+++ b/frontend/src/components/editor/output/MarimoTracebackOutput.tsx
@@ -108,7 +108,7 @@ export const MarimoTracebackOutput = ({
Fix with AI
</Button>
)}
- {tracebackInfo && !isWasm() && (
+ {tracebackInfo && tracebackInfo.kind === "cell" && !isWasm() && (
<Tooltip content={"Attach pdb to the exception point."}>
<Button
size="xs"
@@ -180,7 +180,7 @@ function lastLine(text: string): string {
export const replaceTracebackFilenames = (domNode: DOMNode) => {
const info = getTracebackInfo(domNode);
- if (info) {
+ if (info?.kind === "cell") {
const tooltipContent = <InsertBreakpointContent />;
return (
<span className="nb">
@@ -211,6 +211,21 @@ export const replaceTracebackFilenames = (domNode: DOMNode) => {
</span>
);
}
+ if (info?.kind === "file") {
+ return (
+ <div
+ className="inline-block cursor-pointer text-destructive hover:underline"
+ onClick={(_) => {
+ getRequestClient().openFile({
+ path: info.filePath,
+ lineNumber: info.lineNumber,
+ });
+ }}
+ >
+ <span className="nb">"{info.filePath}"</span>
+ </div>
+ );
+ }
};
export const replaceTracebackPrefix = (domNode: DOMNode) => {
diff --git a/frontend/src/core/codemirror/cells/traceback-decorations.ts b/frontend/src/core/codemirror/cells/traceback-decorations.ts
index 1191005ecd..ebaf2f841e 100644
--- a/frontend/src/core/codemirror/cells/traceback-decorations.ts
+++ b/frontend/src/core/codemirror/cells/traceback-decorations.ts
@@ -29,7 +29,7 @@ function createErrorDecorations(state: EditorState, errors: TracebackInfos) {
// Filter and sort errors by line number to ensure they're added in order
const relevantErrors = errors
- .filter((error) => error.cellId === cellId)
+ .filter((error) => error.kind === "cell" && error.cellId === cellId)
.sort((a, b) => a.lineNumber - b.lineNumber);
for (const error of relevantErrors) {
diff --git a/frontend/src/core/network/types.ts b/frontend/src/core/network/types.ts
index 42a563e986..f5f7683711 100644
--- a/frontend/src/core/network/types.ts
+++ b/frontend/src/core/network/types.ts
@@ -142,7 +142,7 @@ export interface EditRequests {
request: PreviewDataSourceConnectionRequest,
) => Promise<null>;
validateSQL: (request: ValidateSQLRequest) => Promise<null>;
- openFile: (request: { path: string }) => Promise<null>;
+ openFile: (request: { path: string; lineNumber?: number }) => Promise<null>;
getUsageStats: () => Promise<UsageResponse>;
// Debugger
sendPdb: (request: PdbRequest) => Promise<null>;
diff --git a/frontend/src/utils/__tests__/traceback.test.ts b/frontend/src/utils/__tests__/traceback.test.ts
index 0378179214..a163366f99 100644
--- a/frontend/src/utils/__tests__/traceback.test.ts
+++ b/frontend/src/utils/__tests__/traceback.test.ts
@@ -6,14 +6,20 @@ import { extractAllTracebackInfo } from "../traceback";
describe("traceback", () => {
test("extracts cell-link", () => {
const errors = extractAllTracebackInfo(Tracebacks.raw);
- expect(errors).toMatchInlineSnapshot(`
+ expect(
+ errors[0].kind === "file" &&
+ errors[0].filePath.endsWith("marimo/_runtime/executor.py"),
+ ).toBe(true);
+ expect(errors.slice(1)).toMatchInlineSnapshot(`
[
{
"cellId": "Hbol",
+ "kind": "cell",
"lineNumber": 4,
},
{
"cellId": "Hbol",
+ "kind": "cell",
"lineNumber": 2,
},
]
@@ -22,10 +28,15 @@ describe("traceback", () => {
test("extracts cell-link from assertion", () => {
const info = extractAllTracebackInfo(Tracebacks.assertion);
- expect(info).toMatchInlineSnapshot(`
+ expect(
+ info[0].kind === "file" &&
+ info[0].filePath.endsWith("marimo/_runtime/executor.py"),
+ ).toBe(true);
+ expect(info.slice(1)).toMatchInlineSnapshot(`
[
{
"cellId": "Hbol",
+ "kind": "cell",
"lineNumber": 1,
},
]
diff --git a/frontend/src/utils/traceback.ts b/frontend/src/utils/traceback.ts
index 6e15982021..6543314308 100644
--- a/frontend/src/utils/traceback.ts
+++ b/frontend/src/utils/traceback.ts
@@ -28,13 +28,38 @@ export const elementContainsMarimoCellFile = (domNode: Element) => {
);
};
-export interface TracebackInfo {
- cellId: CellId;
- lineNumber: number;
-}
+export type TracebackInfo =
+ | {
+ kind: "file";
+ filePath: string;
+ lineNumber: number;
+ }
+ | {
+ kind: "cell";
+ cellId: CellId;
+ lineNumber: number;
+ };
/**
* Extract the cell id and line number from a traceback DOM node.
+ *
+ * Example transformation:
+ *
+ * File <span class="nb">"/tmp/marimo_<number>/__marimo__cell_<CellId>.py"</span>
+ * , line <span class="n">1</span>...
+ *
+ * becomes
+ *
+ * { kind: "cell", cellId: <CellID>, lineNumber: 1 }
+ *
+ * or for files:
+ *
+ * File <span class="nb">"/path/to/file.py"</span>
+ * , line <span class="n">42</span>...
+ *
+ * becomes
+ *
+ * { kind: "file", filePath: "/path/to/file.py", lineNumber: 42 }
*/
export function getTracebackInfo(domNode: DOMNode): TracebackInfo | null {
// The traceback can be manipulated either in output render or in the pygments
@@ -57,7 +82,7 @@ export function getTracebackInfo(domNode: DOMNode): TracebackInfo | null {
if (
domNode instanceof Element &&
domNode.firstChild instanceof Text &&
- elementContainsMarimoCellFile(domNode)
+ matchesSelector(domNode, "span.nb")
) {
const nextSibling = domNode.next;
if (nextSibling && nextSibling instanceof Text) {
@@ -68,15 +93,22 @@ export function getTracebackInfo(domNode: DOMNode): TracebackInfo | null {
lineSibling.firstChild instanceof Text &&
matchesSelector(lineSibling, "span.m")
) {
- const cellId = /__marimo__cell_(\w+)_/.exec(
- domNode.firstChild.nodeValue,
- )?.[1];
const lineNumber = Number.parseInt(
lineSibling.firstChild.nodeValue || "0",
10,
);
- if (cellId && lineNumber) {
- return { cellId: cellId as CellId, lineNumber };
+ if (domNode.firstChild.nodeValue?.includes("__marimo__")) {
+ const cellId = /__marimo__cell_(\w+)_/.exec(
+ domNode.firstChild.nodeValue,
+ )?.[1] as CellId;
+ if (cellId && lineNumber) {
+ return { kind: "cell", cellId, lineNumber };
+ }
+ } else {
+ const filePath = /"(.+?)"/.exec(domNode.firstChild.nodeValue)?.[1];
+ if (filePath && lineNumber) {
+ return { kind: "file", filePath, lineNumber };
+ }
}
}
}
@@ -93,11 +125,8 @@ export function extractAllTracebackInfo(traceback: string): TracebackInfo[] {
replace: (domNode) => {
const info = getTracebackInfo(domNode);
if (info) {
- infos.push({
- cellId: info.cellId,
- lineNumber: info.lineNumber,
- });
- return `${info.cellId}:${info.lineNumber}`;
+ infos.push(info);
+ return "dummy";
}
},
});
diff --git a/marimo/_server/api/endpoints/file_explorer.py b/marimo/_server/api/endpoints/file_explorer.py
index bdd0fea3e4..07a9ed5543 100644
--- a/marimo/_server/api/endpoints/file_explorer.py
+++ b/marimo/_server/api/endpoints/file_explorer.py
@@ -253,7 +253,7 @@ async def open_file(
body = await parse_request(request, cls=FileOpenRequest)
try:
file_system.get_details(body.path)
- success = file_system.open_in_editor(body.path)
+ success = file_system.open_in_editor(body.path, body.line_number)
return SuccessResponse(success=success)
except Exception as e:
LOGGER.error(f"Error opening file: {e}")
diff --git a/marimo/_server/files/os_file_system.py b/marimo/_server/files/os_file_system.py
index e0c896c117..a481e014d7 100644
--- a/marimo/_server/files/os_file_system.py
+++ b/marimo/_server/files/os_file_system.py
@@ -319,7 +319,7 @@ class OSFileSystem(FileSystem):
results.sort(key=sort_key)
return results[:limit]
- def open_in_editor(self, path: str) -> bool:
+ def open_in_editor(self, path: str, line_number: int | None) -> bool:
try:
# First try to get editor from environment variable
editor = os.environ.get("EDITOR")
@@ -328,9 +328,17 @@ class OSFileSystem(FileSystem):
# otherwise it silently opens the terminal in the same window that is
# running marimo.
if editor and not _is_terminal_editor(editor):
+ args = (
+ [path]
+ if line_number is None
+ else editor_open_file_in_line_args(
+ editor, path, line_number
+ )
+ )
+
try:
# For GUI editors
- subprocess.run([editor, path])
+ subprocess.run([editor, *args])
return True
except Exception as e:
LOGGER.error(f"Error opening with EDITOR: {e}")
@@ -350,6 +358,17 @@ class OSFileSystem(FileSystem):
return False
+def editor_open_file_in_line_args(
+ editor: str, path: str, line_number: int
+) -> list[str]:
+ if editor == "code":
+ return ["--goto", f"{path}:{line_number}"]
+ elif editor == "subl":
+ return [f"{path}:{line_number}"]
+ else:
+ return [f"+{line_number}", path]
+
+
def natural_sort_file(file: FileInfo) -> list[Union[int, str]]:
return natural_sort(file.name)
diff --git a/marimo/_server/models/files.py b/marimo/_server/models/files.py
index 308ca735b0..f41e9c6838 100644
--- a/marimo/_server/models/files.py
+++ b/marimo/_server/models/files.py
@@ -32,6 +32,7 @@ class FileDetailsRequest(msgspec.Struct, rename="camel"):
class FileOpenRequest(msgspec.Struct, rename="camel"):
# The path of the file to open
path: str
+ line_number: Optional[int] = None
class FileTreeRequest(msgspec.Struct, rename="camel"):
diff --git a/packages/openapi/api.yaml b/packages/openapi/api.yaml
index b227cb216f..ec7cc076d3 100644
--- a/packages/openapi/api.yaml
+++ b/packages/openapi/api.yaml
@@ -1400,6 +1400,11 @@ components:
type: object
FileOpenRequest:
properties:
+ lineNumber:
+ anyOf:
+ - type: integer
+ - type: 'null'
+ default: null
path:
type: string
required:
diff --git a/packages/openapi/src/api.ts b/packages/openapi/src/api.ts
index a9559cc061..e229e3853a 100644
--- a/packages/openapi/src/api.ts
+++ b/packages/openapi/src/api.ts
@@ -3391,6 +3391,8 @@ export interface components {
};
/** FileOpenRequest */
FileOpenRequest: {
+ /** @default null */
+ lineNumber?: number | null;
path: string;
};
/** FileSearchRequest */