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.

feat: preserve export filenames and media types (#10349)

Péter Gyarmatif83555ff0eee
diff --git a/frontend/src/__mocks__/requests.ts b/frontend/src/__mocks__/requests.ts
index 8ab35ebc11..f399f54166 100644
--- a/frontend/src/__mocks__/requests.ts
+++ b/frontend/src/__mocks__/requests.ts
@@ -64,10 +64,26 @@ export const MockRequestClient = {
getWorkspaceFiles: vi.fn().mockResolvedValue({ files: [] }),
getRunningNotebooks: vi.fn().mockResolvedValue({ files: [] }),
shutdownSession: vi.fn().mockResolvedValue({}),
- exportAsHTML: vi.fn().mockResolvedValue({ html: "" }),
- exportAsIPYNB: vi.fn().mockResolvedValue(""),
- exportAsMarkdown: vi.fn().mockResolvedValue({ markdown: "" }),
- exportAsPDF: vi.fn().mockResolvedValue(new Blob()),
+ exportAsHTML: vi.fn().mockResolvedValue({
+ contents: "",
+ filename: "notebook.html",
+ mediaType: "text/html; charset=utf-8",
+ }),
+ exportAsIPYNB: vi.fn().mockResolvedValue({
+ contents: "",
+ filename: "notebook.ipynb",
+ mediaType: "text/plain; charset=utf-8",
+ }),
+ exportAsMarkdown: vi.fn().mockResolvedValue({
+ contents: "",
+ filename: "notebook.md",
+ mediaType: "text/plain; charset=utf-8",
+ }),
+ exportAsPDF: vi.fn().mockResolvedValue({
+ contents: new Blob(),
+ filename: "notebook.pdf",
+ mediaType: "application/pdf",
+ }),
autoExportAsHTML: vi.fn().mockResolvedValue({}),
autoExportAsMarkdown: vi.fn().mockResolvedValue({}),
autoExportAsIPYNB: vi.fn().mockResolvedValue({}),
diff --git a/frontend/src/components/editor/actions/__tests__/pdf-export.test.ts b/frontend/src/components/editor/actions/__tests__/pdf-export.test.ts
index aa1ddc0585..5ea72a6f11 100644
--- a/frontend/src/components/editor/actions/__tests__/pdf-export.test.ts
+++ b/frontend/src/components/editor/actions/__tests__/pdf-export.test.ts
@@ -8,13 +8,11 @@ describe("runServerSidePDFDownload", () => {
const downloadPDF = vi.fn().mockResolvedValue(undefined);
await runServerSidePDFDownload({
- filename: "slides.py",
preset: "document",
downloadPDF,
});
expect(downloadPDF).toHaveBeenCalledWith({
- filename: "slides.py",
webpdf: false,
preset: "document",
includeInputs: true,
@@ -26,13 +24,11 @@ describe("runServerSidePDFDownload", () => {
const downloadPDF = vi.fn().mockResolvedValue(undefined);
await runServerSidePDFDownload({
- filename: "slides.py",
preset: "slides",
downloadPDF,
});
expect(downloadPDF).toHaveBeenCalledWith({
- filename: "slides.py",
webpdf: false,
preset: "slides",
includeInputs: true,
diff --git a/frontend/src/components/editor/actions/pdf-export.ts b/frontend/src/components/editor/actions/pdf-export.ts
index 473764c6b4..f540074db0 100644
--- a/frontend/src/components/editor/actions/pdf-export.ts
+++ b/frontend/src/components/editor/actions/pdf-export.ts
@@ -2,7 +2,6 @@
type Preset = "document" | "slides";
type DownloadPDF = (opts: {
- filename: string;
webpdf: boolean;
preset: Preset;
includeInputs: boolean;
@@ -10,14 +9,12 @@ type DownloadPDF = (opts: {
}) => Promise<void>;
export async function runServerSidePDFDownload(opts: {
- filename: string;
preset: Preset;
downloadPDF: DownloadPDF;
}): Promise<void> {
- const { filename, preset, downloadPDF } = opts;
+ const { preset, downloadPDF } = opts;
await downloadPDF({
- filename,
webpdf: false,
preset,
includeInputs: true,
diff --git a/frontend/src/components/editor/actions/useNotebookActions.tsx b/frontend/src/components/editor/actions/useNotebookActions.tsx
index a765fcd443..66771f8141 100644
--- a/frontend/src/components/editor/actions/useNotebookActions.tsx
+++ b/frontend/src/components/editor/actions/useNotebookActions.tsx
@@ -83,6 +83,7 @@ import {
ADD_PRINTING_CLASS,
downloadAsPDF,
downloadBlob,
+ downloadExportedFile,
downloadHTMLAsImage,
withLoadingToast,
} from "@/utils/download";
@@ -197,7 +198,6 @@ export function useNotebookActions() {
updateCellOutputs,
});
await runServerSidePDFDownload({
- filename,
preset,
downloadPDF: downloadAsPDF,
});
@@ -231,11 +231,8 @@ export function useNotebookActions() {
takeScreenshots: () => takeScreenshots({ progress }),
updateCellOutputs,
});
- const ipynb = await exportAsIPYNB({ download: false });
- downloadBlob(
- new Blob([ipynb], { type: "application/x-ipynb+json" }),
- Filenames.toIPYNB(document.title),
- );
+ const exportedFile = await exportAsIPYNB({ download: false });
+ downloadExportedFile(exportedFile);
};
await withLoadingToast("Downloading IPYNB...", runDownload);
@@ -255,7 +252,7 @@ export function useNotebookActions() {
toastNotebookMustBeNamed();
return;
}
- await downloadAsHTML({ filename, includeCode: true });
+ await downloadAsHTML({ includeCode: true });
},
},
{
@@ -266,7 +263,7 @@ export function useNotebookActions() {
toastNotebookMustBeNamed();
return;
}
- await downloadAsHTML({ filename, includeCode: false });
+ await downloadAsHTML({ includeCode: false });
},
},
{
@@ -275,11 +272,8 @@ export function useNotebookActions() {
),
label: "Download as Markdown",
handle: async () => {
- const md = await exportAsMarkdown({ download: false });
- downloadBlob(
- new Blob([md], { type: "text/plain" }),
- Filenames.toMarkdown(document.title),
- );
+ const exportedFile = await exportAsMarkdown({ download: false });
+ downloadExportedFile(exportedFile);
},
},
{
diff --git a/frontend/src/components/editor/renderers/vertical-layout/vertical-layout.tsx b/frontend/src/components/editor/renderers/vertical-layout/vertical-layout.tsx
index c1ce8d2fa0..4c087d1224 100644
--- a/frontend/src/components/editor/renderers/vertical-layout/vertical-layout.tsx
+++ b/frontend/src/components/editor/renderers/vertical-layout/vertical-layout.tsx
@@ -202,7 +202,7 @@ const ActionButtons: React.FC<{
if (!app) {
return;
}
- await downloadAsHTML({ filename: document.title, includeCode: true });
+ await downloadAsHTML({ includeCode: true });
};
const handleDownloadAsPython = async () => {
diff --git a/frontend/src/components/static-html/share-modal.tsx b/frontend/src/components/static-html/share-modal.tsx
index 7430046c27..290a85e611 100644
--- a/frontend/src/components/static-html/share-modal.tsx
+++ b/frontend/src/components/static-html/share-modal.tsx
@@ -40,7 +40,7 @@ export const ShareStaticNotebookModal: React.FC<{
e.preventDefault();
onClose();
- const html = await exportAsHTML({
+ const { contents: html } = await exportAsHTML({
download: false,
includeCode: true,
files: VirtualFileTracker.INSTANCE.filenames(),
diff --git a/frontend/src/core/network/__tests__/api.test.ts b/frontend/src/core/network/__tests__/api.test.ts
index 37368f15f9..f80a1e6bc9 100644
--- a/frontend/src/core/network/__tests__/api.test.ts
+++ b/frontend/src/core/network/__tests__/api.test.ts
@@ -94,4 +94,46 @@ describe("API", () => {
}),
).rejects.toBeInstanceOf(HTTPError);
});
+
+ it("preserves export metadata from response headers", async () => {
+ const response = new Response("markdown", {
+ headers: {
+ "Content-Disposition":
+ "attachment; filename*=UTF-8''r%C3%A9sum%C3%A9.qmd",
+ "Content-Type": "text/plain; charset=utf-8",
+ },
+ });
+
+ await expect(
+ API.handleExportResponse({ data: "markdown", response }),
+ ).resolves.toEqual({
+ contents: "markdown",
+ filename: "résumé.qmd",
+ mediaType: "text/plain; charset=utf-8",
+ });
+ });
+
+ it("rejects export responses without a filename", async () => {
+ await expect(
+ API.handleExportResponse({
+ data: "markdown",
+ response: new Response(null, {
+ headers: { "Content-Type": "text/plain" },
+ }),
+ }),
+ ).rejects.toThrow("Export response is missing a filename");
+ });
+
+ it("rejects export responses without a media type", async () => {
+ await expect(
+ API.handleExportResponse({
+ data: "markdown",
+ response: new Response(null, {
+ headers: {
+ "Content-Disposition": "attachment; filename*=UTF-8''notebook.md",
+ },
+ }),
+ }),
+ ).rejects.toThrow("Export response is missing a media type");
+ });
});
diff --git a/frontend/src/core/network/__tests__/requests-network.test.ts b/frontend/src/core/network/__tests__/requests-network.test.ts
index 0027025da1..288a379a4d 100644
--- a/frontend/src/core/network/__tests__/requests-network.test.ts
+++ b/frontend/src/core/network/__tests__/requests-network.test.ts
@@ -22,6 +22,7 @@ vi.mock("../api", async () => {
return {
...actual,
API: {
+ handleExportResponse: vi.fn((response) => response.data),
handleResponse: vi.fn((response) => response.data),
handleResponseReturnNull: vi.fn(() => null),
},
diff --git a/frontend/src/core/network/api.ts b/frontend/src/core/network/api.ts
index 084363cccc..5b48cae5b0 100644
--- a/frontend/src/core/network/api.ts
+++ b/frontend/src/core/network/api.ts
@@ -6,6 +6,7 @@ import { Logger } from "../../utils/Logger";
import { Strings } from "../../utils/strings";
import { getRuntimeManager } from "../runtime/config";
import type { RuntimeManager } from "../runtime/runtime";
+import type { ExportedFile } from "./types";
function getBaseUriWithoutQueryParams(): string {
// Remove query params and hash
@@ -15,6 +16,15 @@ function getBaseUriWithoutQueryParams(): string {
return url.toString();
}
+function getExportFilename(response: Response): string {
+ const contentDisposition = response.headers.get("Content-Disposition");
+ const match = contentDisposition?.match(/filename\*=UTF-8''([^;]+)/i);
+ if (!match) {
+ throw new Error("Export response is missing a filename");
+ }
+ return decodeURIComponent(match[1]);
+}
+
/**
* Wrapper around fetch that adds XSRF token and session ID to the request and
* strong types.
@@ -119,6 +129,23 @@ export const API = {
}
return Promise.resolve(response.data as T);
},
+ handleExportResponse: async <T extends BlobPart>(response: {
+ data?: T | undefined;
+ error?: Record<string, unknown>;
+ response: Response;
+ }): Promise<ExportedFile<T>> => {
+ const contents = await API.handleResponse<T>(response);
+ const mediaType = response.response.headers.get("Content-Type");
+ if (!mediaType) {
+ throw new Error("Export response is missing a media type");
+ }
+
+ return {
+ contents,
+ filename: getExportFilename(response.response),
+ mediaType,
+ };
+ },
handleResponseReturnNull: (response: {
error?: Record<string, unknown>;
response: Response;
diff --git a/frontend/src/core/network/requests-network.ts b/frontend/src/core/network/requests-network.ts
index 30e9d469ab..67619afa77 100644
--- a/frontend/src/core/network/requests-network.ts
+++ b/frontend/src/core/network/requests-network.ts
@@ -22,7 +22,7 @@ function multipartInit(formData: FormData) {
};
}
-const { handleResponse, handleResponseReturnNull } = API;
+const { handleExportResponse, handleResponse, handleResponseReturnNull } = API;
export function createNetworkRequests(): EditRequests & RunRequests {
const getClient = once(() => {
@@ -415,7 +415,7 @@ export function createNetworkRequests(): EditRequests & RunRequests {
parseAs: "text",
params: getParams(),
})
- .then(handleResponse);
+ .then(handleExportResponse);
},
exportAsMarkdown: async (request) => {
return getClient()
@@ -424,7 +424,7 @@ export function createNetworkRequests(): EditRequests & RunRequests {
parseAs: "text",
params: getParams(),
})
- .then(handleResponse);
+ .then(handleExportResponse);
},
exportAsIPYNB: async (request) => {
return getClient()
@@ -433,7 +433,7 @@ export function createNetworkRequests(): EditRequests & RunRequests {
parseAs: "text",
params: getParams(),
})
- .then(handleResponse);
+ .then(handleExportResponse);
},
exportAsPDF: async (request) => {
return getClient()
@@ -442,7 +442,7 @@ export function createNetworkRequests(): EditRequests & RunRequests {
parseAs: "blob",
params: getParams(),
})
- .then(handleResponse);
+ .then(handleExportResponse);
},
autoExportAsHTML: async (request) => {
return getClient()
diff --git a/frontend/src/core/network/types.ts b/frontend/src/core/network/types.ts
index feb4f5c7eb..221970a22c 100644
--- a/frontend/src/core/network/types.ts
+++ b/frontend/src/core/network/types.ts
@@ -23,6 +23,13 @@ export type ExportAsIPYNBRequest = schemas["ExportAsIPYNBRequest"];
export type ExportAsScriptRequest = schemas["ExportAsScriptRequest"];
export type ExportAsPDFRequest = schemas["ExportAsPDFRequest"];
export type UpdateCellOutputsRequest = schemas["UpdateCellOutputsRequest"];
+
+export interface ExportedFile<T extends BlobPart = BlobPart> {
+ contents: T;
+ filename: string;
+ mediaType: string;
+}
+
export type FileCopyRequest = schemas["FileCopyRequest"];
export type FileCopyResponse = schemas["FileCopyResponse"];
export type FileCreateRequest = schemas["FileCreateRequest"];
@@ -205,10 +212,14 @@ export interface EditRequests {
request: ShutdownSessionRequest,
) => Promise<RunningNotebooksResponse>;
// Export requests
- exportAsHTML: (request: ExportAsHTMLRequest) => Promise<string>;
- exportAsIPYNB: (request: ExportAsIPYNBRequest) => Promise<string>;
- exportAsMarkdown: (request: ExportAsMarkdownRequest) => Promise<string>;
- exportAsPDF: (request: ExportAsPDFRequest) => Promise<Blob>;
+ exportAsHTML: (request: ExportAsHTMLRequest) => Promise<ExportedFile<string>>;
+ exportAsIPYNB: (
+ request: ExportAsIPYNBRequest,
+ ) => Promise<ExportedFile<string>>;
+ exportAsMarkdown: (
+ request: ExportAsMarkdownRequest,
+ ) => Promise<ExportedFile<string>>;
+ exportAsPDF: (request: ExportAsPDFRequest) => Promise<ExportedFile<Blob>>;
autoExportAsHTML: (request: ExportAsHTMLRequest) => Promise<null>;
autoExportAsMarkdown: (request: ExportAsMarkdownRequest) => Promise<null>;
autoExportAsIPYNB: (request: ExportAsIPYNBRequest) => Promise<null>;
diff --git a/frontend/src/core/static/download-html.ts b/frontend/src/core/static/download-html.ts
index 5a0d9a89af..7429802601 100644
--- a/frontend/src/core/static/download-html.ts
+++ b/frontend/src/core/static/download-html.ts
@@ -1,31 +1,22 @@
/* Copyright 2026 Marimo. All rights reserved. */
-import { downloadBlob } from "@/utils/download";
-import { Filenames } from "@/utils/filenames";
-import { Paths } from "@/utils/paths";
+import { downloadExportedFile } from "@/utils/download";
import { getRequestClient } from "../network/requests";
import { VirtualFileTracker } from "./virtual-file-tracker";
/**
* Downloads the current notebook as an HTML file.
*/
-export async function downloadAsHTML(opts: {
- filename: string;
- includeCode: boolean;
-}) {
+export async function downloadAsHTML(opts: { includeCode: boolean }) {
const client = getRequestClient();
- const { filename, includeCode } = opts;
- const html = await client.exportAsHTML({
+ const { includeCode } = opts;
+ const exportedFile = await client.exportAsHTML({
download: true,
includeCode: includeCode,
files: VirtualFileTracker.INSTANCE.filenames(),
});
- const filenameWithoutPath = Paths.basename(filename) ?? "notebook.py";
- downloadBlob(
- new Blob([html], { type: "text/html" }),
- Filenames.toHTML(filenameWithoutPath),
- );
+ downloadExportedFile(exportedFile);
}
function updateAssetUrl(existingUrl: string, assetBaseUrl: string) {
diff --git a/frontend/src/core/wasm/bridge.ts b/frontend/src/core/wasm/bridge.ts
index 689080793e..f1b28a8cb8 100644
--- a/frontend/src/core/wasm/bridge.ts
+++ b/frontend/src/core/wasm/bridge.ts
@@ -19,6 +19,7 @@ import type {
EnvironmentInfo,
ExportAsHTMLRequest,
ExportAsMarkdownRequest,
+ ExportedFile,
FileCopyResponse,
FileCreateResponse,
FileDeleteResponse,
@@ -520,7 +521,7 @@ export class PyodideBridge implements RunRequests, EditRequests {
functionName: "export_html",
payload: request,
});
- return response as string;
+ return response as ExportedFile<string>;
};
exportAsMarkdown: EditRequests["exportAsMarkdown"] = async (
@@ -530,7 +531,7 @@ export class PyodideBridge implements RunRequests, EditRequests {
functionName: "export_markdown",
payload: request,
});
- return response as string;
+ return response as ExportedFile<string>;
};
previewDatasetColumn: EditRequests["previewDatasetColumn"] = async (
diff --git a/frontend/src/core/wasm/worker/types.ts b/frontend/src/core/wasm/worker/types.ts
index 1b61860634..1c69308c28 100644
--- a/frontend/src/core/wasm/worker/types.ts
+++ b/frontend/src/core/wasm/worker/types.ts
@@ -12,6 +12,7 @@ import type {
EnvironmentInfo,
ExportAsHTMLRequest,
ExportAsMarkdownRequest,
+ ExportedFile,
FileCopyRequest,
FileCopyResponse,
FileCreateRequest,
@@ -96,8 +97,10 @@ export interface RawBridge {
load_packages(request: string): Promise<string>;
read_file(request: string): Promise<string>;
set_interrupt_buffer(request: Uint8Array): Promise<string>;
- export_html(request: ExportAsHTMLRequest): Promise<string>;
- export_markdown(request: ExportAsMarkdownRequest): Promise<string>;
+ export_html(request: ExportAsHTMLRequest): Promise<ExportedFile<string>>;
+ export_markdown(
+ request: ExportAsMarkdownRequest,
+ ): Promise<ExportedFile<string>>;
}
export type BridgePayload<T extends keyof RawBridge> = T extends keyof RawBridge
diff --git a/frontend/src/utils/__tests__/download.test.tsx b/frontend/src/utils/__tests__/download.test.tsx
index f33a5fc6a5..74aa680769 100644
--- a/frontend/src/utils/__tests__/download.test.tsx
+++ b/frontend/src/utils/__tests__/download.test.tsx
@@ -8,6 +8,7 @@ import {
downloadAsPDF,
downloadByURL,
downloadCellOutputAsImage,
+ downloadExportedFile,
downloadHTMLAsImage,
getImageDataUrlForCell,
withLoadingToast,
@@ -195,7 +196,6 @@ describe("downloadAsPDF", () => {
await expect(
downloadAsPDF({
- filename: "path/to/notebook.py",
webpdf: false,
preset: "slides",
}),
@@ -572,6 +572,7 @@ describe("downloadByURL", () => {
afterEach(() => {
vi.restoreAllMocks();
+ vi.unstubAllGlobals();
});
it("should create anchor, set attributes, click, and remove", () => {
@@ -583,4 +584,26 @@ describe("downloadByURL", () => {
expect(mockAnchor.click).toHaveBeenCalled();
expect(mockAnchor.remove).toHaveBeenCalled();
});
+
+ it("downloads an exported file with its returned metadata", async () => {
+ let downloadedBlob: Blob | undefined;
+ vi.stubGlobal("URL", {
+ createObjectURL: vi.fn((blob: Blob) => {
+ downloadedBlob = blob;
+ return "blob:export";
+ }),
+ revokeObjectURL: vi.fn(),
+ });
+
+ downloadExportedFile({
+ contents: "notebook",
+ filename: "résumé.qmd",
+ mediaType: "text/plain; charset=utf-8",
+ });
+
+ expect(downloadedBlob?.type).toBe("text/plain; charset=utf-8");
+ expect(await downloadedBlob?.text()).toBe("notebook");
+ expect(mockAnchor.download).toBe("résumé.qmd");
+ expect(URL.revokeObjectURL).toHaveBeenCalledWith("blob:export");
+ });
});
diff --git a/frontend/src/utils/download.ts b/frontend/src/utils/download.ts
index 7aeb7fd8cf..d15197c88f 100644
--- a/frontend/src/utils/download.ts
+++ b/frontend/src/utils/download.ts
@@ -4,8 +4,8 @@ import React from "react";
import { toast } from "@/components/ui/use-toast";
import { type CellId, CellOutputId } from "@/core/cells/ids";
import { getRequestClient } from "@/core/network/requests";
+import type { ExportedFile } from "@/core/network/types";
import { Filenames } from "@/utils/filenames";
-import { Paths } from "@/utils/paths";
import { prettyError } from "./errors";
import { toPng } from "./html-to-image";
import { captureExternalIframes } from "./iframe";
@@ -191,6 +191,14 @@ export function downloadBlob(blob: Blob, filename: string) {
URL.revokeObjectURL(url);
}
+export function downloadExportedFile({
+ contents,
+ filename,
+ mediaType,
+}: ExportedFile) {
+ downloadBlob(new Blob([contents], { type: mediaType }), filename);
+}
+
export type PDFExportPreset = "document" | "slides";
/**
@@ -200,7 +208,6 @@ export type PDFExportPreset = "document" | "slides";
* Standard PDF requires Pandoc & TeX (~few GBs) but is of higher quality.
*/
export async function downloadAsPDF(opts: {
- filename: string;
webpdf: boolean;
preset?: PDFExportPreset;
includeInputs?: boolean;
@@ -210,7 +217,6 @@ export async function downloadAsPDF(opts: {
}) {
const client = getRequestClient();
const {
- filename,
webpdf,
preset = "document",
includeInputs = true,
@@ -220,7 +226,7 @@ export async function downloadAsPDF(opts: {
} = opts;
try {
- const pdfBlob = await client.exportAsPDF({
+ const exportedFile = await client.exportAsPDF({
webpdf,
preset,
includeInputs,
@@ -229,8 +235,7 @@ export async function downloadAsPDF(opts: {
rasterServer,
});
- const filenameWithoutPath = Paths.basename(filename);
- downloadBlob(pdfBlob, Filenames.toPDF(filenameWithoutPath));
+ downloadExportedFile(exportedFile);
} catch (error) {
toast({
title: "Failed to download",
diff --git a/marimo/_convert/common/filename.py b/marimo/_convert/common/filename.py
index 7e44f529b3..f01a21d34c 100644
--- a/marimo/_convert/common/filename.py
+++ b/marimo/_convert/common/filename.py
@@ -55,3 +55,12 @@ def make_download_headers(filename: str) -> dict[str, str]:
f"attachment; filename*=UTF-8''{encoded_filename}"
)
}
+
+
+def make_export_headers(filename: str, *, download: bool) -> dict[str, str]:
+ if download:
+ return make_download_headers(filename)
+ encoded_filename = quote(filename, safe="")
+ return {
+ "Content-Disposition": f"inline; filename*=UTF-8''{encoded_filename}"
+ }
diff --git a/marimo/_pyodide/pyodide_session.py b/marimo/_pyodide/pyodide_session.py
index baaeb01c1e..791528991b 100644
--- a/marimo/_pyodide/pyodide_session.py
+++ b/marimo/_pyodide/pyodide_session.py
@@ -3,7 +3,6 @@ from __future__ import annotations
import asyncio
import base64
-import json
import signal
from pathlib import Path
from typing import TYPE_CHECKING, Any, TypeVar, cast
@@ -37,6 +36,7 @@ from marimo._runtime.commands import (
from marimo._runtime.marimo_pdb import MarimoPdb
from marimo._schemas.export import (
ExportAsHTMLRequest,
+ ExportedFile,
to_html_export_options,
)
from marimo._schemas.export_options import (
@@ -395,7 +395,7 @@ class PyodideBridge:
def export_html(self, request: str) -> str:
parsed = self._parse(request, ExportAsHTMLRequest)
app = self.session.app_manager.app
- html, _filename = Exporter().export_as_html(
+ html, filename = Exporter().export_as_html(
HTMLExportRequest(
filename=self.session.app_manager.filename,
app_code=app.to_py(),
@@ -410,7 +410,13 @@ class PyodideBridge:
options=to_html_export_options(parsed),
)
)
- return json.dumps(html)
+ return self._dump(
+ ExportedFile(
+ contents=html,
+ filename=filename,
+ media_type="text/html; charset=utf-8",
+ )
+ )
def export_markdown(self, request: str) -> str:
del request
@@ -420,7 +426,13 @@ class PyodideBridge:
options=MarkdownExportOptions(),
)
)
- return json.dumps(result.text)
+ return self._dump(
+ ExportedFile(
+ contents=result.text,
+ filename=result.download_filename,
+ media_type="text/plain; charset=utf-8",
+ )
+ )
def _parse(self, request: str, cls: type[T]) -> T:
return parse_raw(request, cls)
diff --git a/marimo/_schemas/export.py b/marimo/_schemas/export.py
index d82af9398c..0363de5405 100644
--- a/marimo/_schemas/export.py
+++ b/marimo/_schemas/export.py
@@ -50,5 +50,11 @@ class ExportAsPDFRequest(msgspec.Struct, rename="camel"):
raster_server: PDFRasterServer = "static"
+class ExportedFile(msgspec.Struct, rename="camel"):
+ contents: str
+ filename: str
+ media_type: str
+
+
class UpdateCellOutputsRequest(msgspec.Struct, rename="camel"):
cell_ids_to_output: dict[CellId_t, MimeBundleTuple]
diff --git a/marimo/_server/api/endpoints/export.py b/marimo/_server/api/endpoints/export.py
index 79781c40d3..bc514c4041 100644
--- a/marimo/_server/api/endpoints/export.py
+++ b/marimo/_server/api/endpoints/export.py
@@ -17,6 +17,7 @@ from marimo import _loggers
from marimo._convert.common.filename import (
get_download_filename,
make_download_headers,
+ make_export_headers,
)
from marimo._dependencies.dependencies import DependencyManager
from marimo._export.exporter import (
@@ -131,15 +132,10 @@ async def export_as_html(
)
)
- if body.download:
- headers = make_download_headers(filename)
- else:
- headers = {}
-
# Download the HTML
return HTMLResponse(
content=html,
- headers=headers,
+ headers=make_export_headers(filename, download=body.download),
)
@@ -329,15 +325,12 @@ async def export_as_markdown(
)
)
- if body.download:
- headers = make_download_headers(result.download_filename)
- else:
- headers = {}
-
# Download the Markdown
return PlainTextResponse(
content=result.text,
- headers=headers,
+ headers=make_export_headers(
+ result.download_filename, download=body.download
+ ),
)
@@ -387,18 +380,14 @@ async def export_as_ipynb(
)
)
- if body.download:
- filename = get_download_filename(
- session.app_file_manager.filename, "ipynb"
- )
- headers = make_download_headers(filename)
- else:
- headers = {}
+ filename = get_download_filename(
+ session.app_file_manager.filename, "ipynb"
+ )
# Download the IPYNB
return PlainTextResponse(
content=ipynb,
- headers=headers,
+ headers=make_export_headers(filename, download=body.download),
)
diff --git a/marimo/_server/main.py b/marimo/_server/main.py
index bbfb92e962..6dafde1ddc 100644
--- a/marimo/_server/main.py
+++ b/marimo/_server/main.py
@@ -94,6 +94,7 @@ def create_starlette_app(
allow_credentials=allow_credentials,
allow_methods=["*"],
allow_headers=["*"],
+ expose_headers=["Content-Disposition"],
),
]
)
diff --git a/tests/_pyodide/test_pyodide_session.py b/tests/_pyodide/test_pyodide_session.py
index f3b06b9b24..78086b251c 100644
--- a/tests/_pyodide/test_pyodide_session.py
+++ b/tests/_pyodide/test_pyodide_session.py
@@ -1034,11 +1034,12 @@ def test_pyodide_bridge_export_html(
)
result = pyodide_bridge.export_html(request_json)
- html = json.loads(result)
+ exported_file = json.loads(result)
- assert isinstance(html, str)
+ assert exported_file["filename"] == "test.html"
+ assert exported_file["mediaType"] == "text/html; charset=utf-8"
# HTML should contain marimo-related content
- assert len(html) > 0
+ assert len(exported_file["contents"]) > 0
def test_pyodide_bridge_export_markdown(
@@ -1046,10 +1047,11 @@ def test_pyodide_bridge_export_markdown(
) -> None:
"""Test exporting markdown through the bridge."""
result = pyodide_bridge.export_markdown("{}")
- markdown = json.loads(result)
+ exported_file = json.loads(result)
- assert isinstance(markdown, str)
- assert len(markdown) > 0
+ assert exported_file["filename"] == "test.md"
+ assert exported_file["mediaType"] == "text/plain; charset=utf-8"
+ assert len(exported_file["contents"]) > 0
async def test_pyodide_bridge_read_snippets(
diff --git a/tests/_server/api/endpoints/test_export.py b/tests/_server/api/endpoints/test_export.py
index 440a1dfe41..e638fd1729 100644
--- a/tests/_server/api/endpoints/test_export.py
+++ b/tests/_server/api/endpoints/test_export.py
@@ -52,7 +52,7 @@ def test_export_html(client: TestClient) -> None:
session.app_file_manager.filename = "test.py"
response = client.post(
"/api/export/html",
- headers=HEADERS,
+ headers={**HEADERS, "Origin": "localhost"},
json={
"download": False,
"files": [],
@@ -62,6 +62,13 @@ def test_export_html(client: TestClient) -> None:
body = response.text
assert '<marimo-code hidden=""></marimo-code>' not in body
assert CODE in body
+ assert (
+ response.headers["content-disposition"]
+ == "inline; filename*=UTF-8''test.html"
+ )
+ assert response.headers["content-type"] == "text/html; charset=utf-8"
+ exposed_headers = response.headers["access-control-expose-headers"].lower()
+ assert "content-disposition" in exposed_headers
@with_session(SESSION_ID)
@@ -219,7 +226,7 @@ def test_export_markdown(client: TestClient) -> None:
@with_session(SESSION_ID)
-def test_export_markdown_download_uses_qmd_filename(
+def test_export_markdown_uses_qmd_filename(
client: TestClient, *, temp_marimo_file: str
) -> None:
qmd_path = Path(temp_marimo_file).with_suffix(".qmd")
@@ -232,13 +239,15 @@ def test_export_markdown_download_uses_qmd_filename(
"/api/export/markdown",
headers=HEADERS,
json={
- "download": True,
+ "download": False,
},
)
assert response.status_code == 200
assert "```{marimo .python" in response.text
+ assert response.headers["Content-Disposition"].startswith("inline;")
assert qmd_path.name in response.headers["Content-Disposition"]
+ assert response.headers["Content-Type"] == "text/plain; charset=utf-8"
@pytest.mark.skipif(
@@ -257,6 +266,11 @@ def test_export_ipynb(client: TestClient) -> None:
ipynb_json = json.loads(response.text)
assert "cells" in ipynb_json
assert ipynb_json["nbformat"] == 4
+ assert response.headers["content-disposition"].startswith(
+ "inline; filename*=UTF-8''"
+ )
+ assert response.headers["content-disposition"].endswith(".ipynb")
+ assert response.headers["content-type"] == "text/plain; charset=utf-8"
@with_read_session(SESSION_ID)
@@ -855,6 +869,10 @@ def test_export_pdf_endpoint(client: TestClient) -> None:
assert response.status_code == 200
assert response.content == b"mock_pdf_content"
assert response.headers["content-type"] == "application/pdf"
+ assert (
+ response.headers["content-disposition"]
+ == "attachment; filename*=UTF-8''test.pdf"
+ )
render_request = render_pdf_mock.await_args.args[0]
assert isinstance(render_request, PDFExportRequest)
assert render_request.options.include_inputs is False