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: export slides as PDF (#8523)

Péter Gyarmati546a30484d7f
diff --git a/docs/guides/apps.md b/docs/guides/apps.md
index 5e06adc82b..6cf9448208 100644
--- a/docs/guides/apps.md
+++ b/docs/guides/apps.md
@@ -88,6 +88,7 @@ Unlike the grid layout, the slides are much less customizable:
- The order of the slides is determined by the order of the cells in the notebook.
- The slides do not support drag-and-drop rearrangement or resizing.
- All outputs are shown and all code is hidden.
+- For PDF export, use `marimo export pdf notebook.py --as=slides --raster-server=live` for slide-style output with better capture compatibility.
If you need more control over the layout, please file an issue on [GitHub](https://github.com/marimo-team/marimo/issues),
so we can properly prioritize this feature.
diff --git a/docs/guides/exporting.md b/docs/guides/exporting.md
index 42c483d9cf..291304a3b2 100644
--- a/docs/guides/exporting.md
+++ b/docs/guides/exporting.md
@@ -188,6 +188,23 @@ marimo export pdf examples/outputs/live_raster.py \
playwright install chromium
```
+To export as a slide deck PDF, use the slides preset:
+
+```bash
+marimo export pdf notebook.py -o notebook.pdf --as=slides --raster-server=live
+```
+
+`--raster-server=live` is recommended for slide exports because it better preserves
+slide aspect ratio and captures widget-heavy outputs more reliably.
+
+Available presets:
+
+- `--as=document`: Standard document PDF (default)
+- `--as=slides`: Slide-style PDF using reveal.js print layout
+
+If a notebook uses slides layout and `--as` is omitted, marimo keeps
+document export as the default and prints a CLI hint for `--as=slides`.
+
If you export to a Jupyter notebook, you can leverage various Jupyter ecosystem tools. For PDFs, you will
need to have [Pandoc](https://nbconvert.readthedocs.io/en/latest/install.html#installing-pandoc) and [TeX](https://nbconvert.readthedocs.io/en/latest/install.html#installing-tex) installed. The examples below use `uvx`, which you can obtain by [installing `uv`](https://docs.astral.sh/uv/getting-started/installation/).
@@ -234,7 +251,7 @@ You can also use other tools that work with Jupyter notebooks:
This feature is experimental. Enable it in **Settings > Experimental > Better PDF Export**.
You can export your notebook to PDF directly from the command palette (Ctrl+K) by clicking
-**Download as PDF**. This uses `nbconvert` under the hood and will attempt the
+**Download as PDF** or **Download as Slide PDF**. This uses `nbconvert` under the hood and will attempt the
following:
1. **Standard PDF export** (requires [Pandoc](https://nbconvert.readthedocs.io/en/latest/install.html#installing-pandoc) and [TeX](https://nbconvert.readthedocs.io/en/latest/install.html#installing-tex)) — produces higher quality PDFs
diff --git a/frontend/src/components/editor/actions/__tests__/pdf-export.test.ts b/frontend/src/components/editor/actions/__tests__/pdf-export.test.ts
new file mode 100644
index 0000000000..eca4275577
--- /dev/null
+++ b/frontend/src/components/editor/actions/__tests__/pdf-export.test.ts
@@ -0,0 +1,42 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import { describe, expect, it, vi } from "vitest";
+import { runServerSidePDFDownload } from "../pdf-export";
+
+describe("runServerSidePDFDownload", () => {
+ it("downloads document preset via backend PDF endpoint", async () => {
+ const downloadPDF = vi.fn().mockResolvedValue(undefined);
+
+ await runServerSidePDFDownload({
+ filename: "slides.py",
+ preset: "document",
+ downloadPDF,
+ });
+
+ expect(downloadPDF).toHaveBeenCalledWith({
+ filename: "slides.py",
+ webpdf: true,
+ preset: "document",
+ includeInputs: false,
+ rasterServer: "live",
+ });
+ });
+
+ it("downloads slides preset via backend PDF endpoint", async () => {
+ const downloadPDF = vi.fn().mockResolvedValue(undefined);
+
+ await runServerSidePDFDownload({
+ filename: "slides.py",
+ preset: "slides",
+ downloadPDF,
+ });
+
+ expect(downloadPDF).toHaveBeenCalledWith({
+ filename: "slides.py",
+ webpdf: true,
+ preset: "slides",
+ includeInputs: false,
+ rasterServer: "live",
+ });
+ });
+});
diff --git a/frontend/src/components/editor/actions/pdf-export.ts b/frontend/src/components/editor/actions/pdf-export.ts
new file mode 100644
index 0000000000..cb4cbca54f
--- /dev/null
+++ b/frontend/src/components/editor/actions/pdf-export.ts
@@ -0,0 +1,26 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+type Preset = "document" | "slides";
+type DownloadPDF = (opts: {
+ filename: string;
+ webpdf: boolean;
+ preset: Preset;
+ includeInputs: boolean;
+ rasterServer: "live" | "static";
+}) => Promise<void>;
+
+export async function runServerSidePDFDownload(opts: {
+ filename: string;
+ preset: Preset;
+ downloadPDF: DownloadPDF;
+}): Promise<void> {
+ const { filename, preset, downloadPDF } = opts;
+
+ await downloadPDF({
+ filename,
+ webpdf: true,
+ preset,
+ includeInputs: false,
+ rasterServer: "live",
+ });
+}
diff --git a/frontend/src/components/editor/actions/useNotebookActions.tsx b/frontend/src/components/editor/actions/useNotebookActions.tsx
index 9f5eaf5c33..e4d9ded011 100644
--- a/frontend/src/components/editor/actions/useNotebookActions.tsx
+++ b/frontend/src/components/editor/actions/useNotebookActions.tsx
@@ -56,10 +56,6 @@ import { disabledCellIds } from "@/core/cells/utils";
import { useResolvedMarimoConfig } from "@/core/config/config";
import { getFeatureFlag } from "@/core/config/feature-flag";
import { Constants } from "@/core/constants";
-import {
- updateCellOutputsWithScreenshots,
- useEnrichCellOutputs,
-} from "@/core/export/hooks";
import { useLayoutActions, useLayoutState } from "@/core/layout/layout";
import { useTogglePresenting } from "@/core/layout/useTogglePresenting";
import { kioskModeAtom, viewStateAtom } from "@/core/mode";
@@ -78,7 +74,6 @@ import {
} from "@/utils/download";
import { Filenames } from "@/utils/filenames";
import { Objects } from "@/utils/objects";
-import type { ProgressState } from "@/utils/progress";
import { newNotebookURL } from "@/utils/urls";
import { useRunAllCells } from "../cell/useRunCells";
import { useChromeActions, useChromeState } from "../chrome/state";
@@ -88,6 +83,7 @@ import { commandPaletteAtom } from "../controls/state";
import { AddDatabaseDialogContent } from "../database/add-database-form";
import { displayLayoutName, getLayoutIcon } from "../renderers/layout-select";
import { LAYOUT_TYPES } from "../renderers/types";
+import { runServerSidePDFDownload } from "./pdf-export";
import type { ActionButton } from "./types";
import { useCopyNotebook } from "./useCopyNotebook";
import { useHideAllMarkdownCode } from "./useHideAllMarkdownCode";
@@ -122,16 +118,13 @@ export function useNotebookActions() {
const setCommandPaletteOpen = useSetAtom(commandPaletteAtom);
const setSettingsDialogOpen = useSetAtom(settingDialogAtom);
const setKeyboardShortcutsOpen = useSetAtom(keyboardShortcutsAtom);
- const { exportAsMarkdown, readCode, saveCellConfig, updateCellOutputs } =
- useRequestClient();
+ const { exportAsMarkdown, readCode, saveCellConfig } = useRequestClient();
const hasDisabledCells = useAtomValue(hasDisabledCellsAtom);
const canUndoDeletes = useAtomValue(canUndoDeletesAtom);
const { selectedLayout } = useLayoutState();
const { setLayoutView } = useLayoutActions();
const togglePresenting = useTogglePresenting();
- const takeScreenshots = useEnrichCellOutputs();
-
// Fallback: if sharing is undefined, both are enabled by default
const sharingHtmlEnabled = resolvedConfig.sharing?.html ?? true;
const sharingWasmEnabled = resolvedConfig.sharing?.wasm ?? true;
@@ -141,6 +134,7 @@ export function useNotebookActions() {
// Default export uses browser print, which is better in present mode
const pdfDownloadEnabled =
isServerSidePdfExportEnabled || viewState.mode === "present";
+ const isSlidesLayout = selectedLayout === "slides";
const renderCheckboxElement = (checked: boolean) => (
<div className="w-8 flex justify-end">
@@ -148,6 +142,39 @@ export function useNotebookActions() {
</div>
);
+ const renderRecommendedElement = (recommended: boolean) => {
+ if (!recommended) {
+ return null;
+ }
+ return (
+ <span className="ml-3 shrink-0 rounded-full border border-emerald-200 bg-emerald-50 px-2 py-0.5 text-[10px] font-semibold uppercase tracking-wide text-emerald-700">
+ Recommended
+ </span>
+ );
+ };
+
+ const downloadServerSidePDF = async ({
+ preset,
+ title,
+ }: {
+ preset: "document" | "slides";
+ title: string;
+ }) => {
+ if (!filename) {
+ toastNotebookMustBeNamed();
+ return;
+ }
+
+ const runDownload = async () => {
+ await runServerSidePDFDownload({
+ filename,
+ preset,
+ downloadPDF: downloadAsPDF,
+ });
+ };
+ await withLoadingToast(title, runDownload);
+ };
+
const actions: ActionButton[] = [
{
icon: <DownloadIcon size={14} strokeWidth={1.5} />,
@@ -226,45 +253,60 @@ export function useNotebookActions() {
},
},
{
+ divider: true,
icon: <FileIcon size={14} strokeWidth={1.5} />,
label: "Download as PDF",
- disabled: !pdfDownloadEnabled,
- tooltip: pdfDownloadEnabled ? undefined : (
- <span>
- Only available in app view. <br />
- Toggle with: {renderShortcut("global.hideCode", false)}
- </span>
- ),
- handle: async () => {
- if (isServerSidePdfExportEnabled) {
- if (!filename) {
- toastNotebookMustBeNamed();
- return;
- }
+ handle: NOOP_HANDLER,
+ disabled: !pdfDownloadEnabled && !isServerSidePdfExportEnabled,
+ dropdown: [
+ {
+ icon: <FileIcon size={14} strokeWidth={1.5} />,
+ label: "Document Layout",
+ rightElement: renderRecommendedElement(!isSlidesLayout),
+ disabled: !pdfDownloadEnabled,
+ tooltip: pdfDownloadEnabled ? undefined : (
+ <span>
+ Only available in app view. <br />
+ Toggle with: {renderShortcut("global.hideCode", false)}
+ </span>
+ ),
+ handle: async () => {
+ if (isServerSidePdfExportEnabled) {
+ await downloadServerSidePDF({
+ preset: "document",
+ title: "Downloading Document PDF...",
+ });
+ return;
+ }
- const downloadPDF = async (progress: ProgressState) => {
- await updateCellOutputsWithScreenshots({
- takeScreenshots: () => takeScreenshots({ progress }),
- updateCellOutputs,
- });
- await downloadAsPDF({
- filename: filename,
- webpdf: false,
+ const beforeprint = new Event("export-beforeprint");
+ const afterprint = new Event("export-afterprint");
+ function print() {
+ window.dispatchEvent(beforeprint);
+ setTimeout(() => window.print(), 0);
+ setTimeout(() => window.dispatchEvent(afterprint), 0);
+ }
+ print();
+ },
+ },
+ {
+ icon: <FileIcon size={14} strokeWidth={1.5} />,
+ label: "Slides Layout",
+ rightElement: renderRecommendedElement(isSlidesLayout),
+ disabled: !isServerSidePdfExportEnabled,
+ tooltip: isServerSidePdfExportEnabled ? undefined : (
+ <span>
+ Requires Better PDF Export in Settings &gt; Experimental.
+ </span>
+ ),
+ handle: async () => {
+ await downloadServerSidePDF({
+ preset: "slides",
+ title: "Downloading Slides PDF...",
});
- };
- await withLoadingToast("Downloading PDF...", downloadPDF);
- return;
- }
-
- const beforeprint = new Event("export-beforeprint");
- const afterprint = new Event("export-afterprint");
- function print() {
- window.dispatchEvent(beforeprint);
- setTimeout(() => window.print(), 0);
- setTimeout(() => window.dispatchEvent(afterprint), 0);
- }
- print();
- },
+ },
+ },
+ ],
},
],
},
diff --git a/frontend/src/components/editor/controls/notebook-menu-dropdown.tsx b/frontend/src/components/editor/controls/notebook-menu-dropdown.tsx
index 7af741a9a7..d713512a46 100644
--- a/frontend/src/components/editor/controls/notebook-menu-dropdown.tsx
+++ b/frontend/src/components/editor/controls/notebook-menu-dropdown.tsx
@@ -106,6 +106,37 @@ export const NotebookMenuDropdown: React.FC<Props> = ({
return item;
};
+ const renderAction = (action: ActionButton) => {
+ if (action.hidden || action.redundant) {
+ return null;
+ }
+
+ if (action.dropdown) {
+ return (
+ <DropdownMenuSub key={action.label}>
+ <DropdownMenuSubTrigger
+ data-testid={`notebook-menu-dropdown-${action.label}`}
+ disabled={action.disabled}
+ >
+ {renderLabel(action)}
+ </DropdownMenuSubTrigger>
+ <DropdownMenuPortal>
+ <DropdownMenuSubContent>
+ {action.dropdown.map((childAction) => (
+ <React.Fragment key={childAction.label}>
+ {childAction.divider && <DropdownMenuSeparator />}
+ {renderAction(childAction)}
+ </React.Fragment>
+ ))}
+ </DropdownMenuSubContent>
+ </DropdownMenuPortal>
+ </DropdownMenuSub>
+ );
+ }
+
+ return renderLeafAction(action);
+ };
+
return (
<DropdownMenu modal={false}>
<DropdownMenuTrigger asChild={true} disabled={disabled}>
@@ -113,38 +144,10 @@ export const NotebookMenuDropdown: React.FC<Props> = ({
</DropdownMenuTrigger>
<DropdownMenuContent align="end" className="print:hidden w-[240px]">
{actions.map((action) => {
- if (action.hidden || action.redundant) {
- return null;
- }
-
- if (action.dropdown) {
- return (
- <DropdownMenuSub key={action.label}>
- <DropdownMenuSubTrigger
- data-testid={`notebook-menu-dropdown-${action.label}`}
- >
- {renderLabel(action)}
- </DropdownMenuSubTrigger>
- <DropdownMenuPortal>
- <DropdownMenuSubContent>
- {action.dropdown.map((action) => {
- return (
- <React.Fragment key={action.label}>
- {action.divider && <DropdownMenuSeparator />}
- {renderLeafAction(action)}
- </React.Fragment>
- );
- })}
- </DropdownMenuSubContent>
- </DropdownMenuPortal>
- </DropdownMenuSub>
- );
- }
-
return (
<React.Fragment key={action.label}>
{action.divider && <DropdownMenuSeparator />}
- {renderLeafAction(action)}
+ {renderAction(action)}
</React.Fragment>
);
})}
diff --git a/frontend/src/core/network/__tests__/requests-network.test.ts b/frontend/src/core/network/__tests__/requests-network.test.ts
index bc17090b4a..dcfd8aea37 100644
--- a/frontend/src/core/network/__tests__/requests-network.test.ts
+++ b/frontend/src/core/network/__tests__/requests-network.test.ts
@@ -92,5 +92,26 @@ describe("createNetworkRequests", () => {
process.env.NODE_ENV = originalEnv;
});
+
+ it("exportAsPDF should pass preset through to the API", async () => {
+ const requests = createNetworkRequests();
+ await requests.exportAsPDF({
+ webpdf: false,
+ preset: "slides",
+ includeInputs: false,
+ } as any);
+
+ expect(mockClient.POST).toHaveBeenCalledWith(
+ "/api/export/pdf",
+ expect.objectContaining({
+ body: expect.objectContaining({
+ webpdf: false,
+ preset: "slides",
+ includeInputs: false,
+ }),
+ parseAs: "blob",
+ }),
+ );
+ });
});
});
diff --git a/frontend/src/utils/__tests__/download.test.tsx b/frontend/src/utils/__tests__/download.test.tsx
index 791e2c168c..2226ef23fd 100644
--- a/frontend/src/utils/__tests__/download.test.tsx
+++ b/frontend/src/utils/__tests__/download.test.tsx
@@ -3,6 +3,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import type { CellId } from "@/core/cells/ids";
import { CellOutputId } from "@/core/cells/ids";
import {
+ downloadAsPDF,
downloadByURL,
downloadCellOutputAsImage,
downloadHTMLAsImage,
@@ -10,11 +11,21 @@ import {
withLoadingToast,
} from "../download";
+const { mockExportAsPDF } = vi.hoisted(() => ({
+ mockExportAsPDF: vi.fn(),
+}));
+
// Mock html-to-image
vi.mock("html-to-image", () => ({
toPng: vi.fn(),
}));
+vi.mock("@/core/network/requests", () => ({
+ getRequestClient: () => ({
+ exportAsPDF: mockExportAsPDF,
+ }),
+}));
+
// Mock the toast module
const mockDismiss = vi.fn();
const mockUpdate = vi.fn();
@@ -41,6 +52,7 @@ vi.mock("@/utils/Logger", () => ({
vi.mock("@/utils/filenames", () => ({
Filenames: {
toPNG: (name: string) => `${name}.png`,
+ toPDF: (name: string) => `${name}.pdf`,
},
}));
@@ -174,6 +186,33 @@ describe("withLoadingToast", () => {
});
});
+describe("downloadAsPDF", () => {
+ beforeEach(() => {
+ vi.clearAllMocks();
+ });
+
+ it("should send the preset in export request payload", async () => {
+ mockExportAsPDF.mockRejectedValue(new Error("network"));
+
+ await expect(
+ downloadAsPDF({
+ filename: "path/to/notebook.py",
+ webpdf: false,
+ preset: "slides",
+ }),
+ ).rejects.toThrow("network");
+
+ expect(mockExportAsPDF).toHaveBeenCalledWith({
+ webpdf: false,
+ preset: "slides",
+ includeInputs: false,
+ rasterizeOutputs: true,
+ rasterScale: 4,
+ rasterServer: "static",
+ });
+ });
+});
+
describe("getImageDataUrlForCell", () => {
const mockDataUrl = "data:image/png;base64,mockbase64data";
let mockElement: HTMLElement;
diff --git a/frontend/src/utils/download.ts b/frontend/src/utils/download.ts
index 827b1cc96a..d816de10bb 100644
--- a/frontend/src/utils/download.ts
+++ b/frontend/src/utils/download.ts
@@ -188,6 +188,8 @@ export function downloadBlob(blob: Blob, filename: string) {
URL.revokeObjectURL(url);
}
+export type PDFExportPreset = "document" | "slides";
+
/**
* Download the current notebook as a PDF file.
*
@@ -197,13 +199,31 @@ export function downloadBlob(blob: Blob, filename: string) {
export async function downloadAsPDF(opts: {
filename: string;
webpdf: boolean;
+ preset?: PDFExportPreset;
+ includeInputs?: boolean;
+ rasterizeOutputs?: boolean;
+ rasterScale?: number;
+ rasterServer?: "static" | "live";
}) {
const client = getRequestClient();
- const { filename, webpdf } = opts;
+ const {
+ filename,
+ webpdf,
+ preset = "document",
+ includeInputs = false,
+ rasterizeOutputs = true,
+ rasterScale = 4,
+ rasterServer = "static",
+ } = opts;
try {
const pdfBlob = await client.exportAsPDF({
webpdf,
+ preset,
+ includeInputs,
+ rasterizeOutputs,
+ rasterScale,
+ rasterServer,
});
const filenameWithoutPath = Paths.basename(filename);
diff --git a/marimo/_cli/export/commands.py b/marimo/_cli/export/commands.py
index cef25328c1..5aebdf786c 100644
--- a/marimo/_cli/export/commands.py
+++ b/marimo/_cli/export/commands.py
@@ -27,6 +27,7 @@ from marimo._server.export import (
export_as_md,
export_as_script,
export_as_wasm,
+ notebook_uses_slides_layout,
run_app_then_export_as_html,
run_app_then_export_as_ipynb,
run_app_then_export_as_pdf,
@@ -525,6 +526,10 @@ Optionally pass CLI args to the notebook:
marimo export pdf notebook.py -o notebook.pdf -- -arg1 foo -arg2 bar
+Export PDFs in a specific format such as slides:
+
+ marimo export pdf notebook.py -o notebook.pdf --as=slides
+
Requires nbformat and nbconvert to be installed.
""",
)
@@ -570,7 +575,18 @@ Requires nbformat and nbconvert to be installed.
default="static",
help=(
"Server mode used for raster capture. Use 'static' (default) for "
- "faster captures, or 'live' if outputs require a live Python connection."
+ "faster captures, or 'live' if outputs require a live Python connection. "
+ "For --as=slides, 'live' is recommended."
+ ),
+)
+ "--as",
+ "export_as",
+ type=click.Choice(["document", "slides"]),
+ default=None,
+ help=(
+ "PDF export preset. Use `slides` for reveal.js slide-style output. "
+ "If omitted, marimo exports as a standard document PDF."
),
)
@click.option(
@@ -618,6 +634,7 @@ def pdf(
rasterize_outputs: bool,
raster_scale: float,
raster_server: str,
+ export_as: Literal["document", "slides"] | None,
sandbox: Optional[bool],
force: bool,
args: tuple[str],
@@ -676,8 +693,26 @@ def pdf(
additional_tip="Requires uv.",
) from None
+ if export_as is None and notebook_uses_slides_layout(MarimoPath(name)):
+ echo(
+ f"{green('Tip:')} Notebook is using slides layout. "
+ "Use --as=slides for slide-style PDF export.",
+ err=True,
+ )
+
cli_args = parse_args(args) if include_outputs else {}
rasterization_enabled = include_outputs and rasterize_outputs
+ if (
+ export_as == "slides"
+ and rasterization_enabled
+ and raster_server.lower() != "live"
+ ):
+ echo(
+ f"{green('Tip:')} For --as=slides, prefer --raster-server=live "
+ "for better aspect-ratio capture and widget compatibility.",
+ err=True,
+ )
+
if rasterization_enabled:
try:
DependencyManager.playwright.require(
@@ -710,6 +745,7 @@ def pdf(
include_outputs=include_outputs,
include_inputs=include_inputs,
webpdf=webpdf,
+ export_as=export_as,
cli_args=cli_args,
argv=list(args) if include_outputs else None,
rasterization_options=rasterization_options,
diff --git a/marimo/_server/api/endpoints/export.py b/marimo/_server/api/endpoints/export.py
index 820384088a..4b3f432a9b 100644
--- a/marimo/_server/api/endpoints/export.py
+++ b/marimo/_server/api/endpoints/export.py
@@ -463,11 +463,41 @@ async def export_as_pdf(*, request: Request) -> Response:
detail="File must have a name before exporting",
)
- pdf_data = Exporter().export_as_pdf(
+ from marimo._server.export._pdf_raster import (
+ PDFRasterizationOptions,
+ collect_pdf_png_fallbacks,
+ )
+
+ raster_options = PDFRasterizationOptions(
+ enabled=body.rasterize_outputs,
+ scale=body.raster_scale,
+ server_mode=body.raster_server,
+ )
+
+ png_fallbacks = await collect_pdf_png_fallbacks(
app=session.app_file_manager.app,
session_view=session.session_view,
- webpdf=body.webpdf,
+ filename=session.app_file_manager.filename,
+ filepath=session.app_file_manager.path,
+ options=raster_options,
)
+
+ exporter = Exporter()
+ if body.preset == "slides":
+ pdf_data = await exporter.export_as_slides_pdf(
+ app=session.app_file_manager.app,
+ session_view=session.session_view,
+ png_fallbacks=png_fallbacks,
+ include_inputs=body.include_inputs,
+ )
+ else:
+ pdf_data = exporter.export_as_pdf(
+ app=session.app_file_manager.app,
+ session_view=session.session_view,
+ png_fallbacks=png_fallbacks,
+ webpdf=body.webpdf,
+ include_inputs=body.include_inputs,
+ )
if pdf_data is None:
raise HTTPException(
status_code=HTTPStatus.SERVER_ERROR, detail="Failed to export PDF"
diff --git a/marimo/_server/export/__init__.py b/marimo/_server/export/__init__.py
index ac71ff9550..60d44603cd 100644
--- a/marimo/_server/export/__init__.py
+++ b/marimo/_server/export/__init__.py
@@ -32,7 +32,10 @@ from marimo._runtime.commands import AppMetadata, SerializedCLIArgs
from marimo._schemas.serialization import NotebookSerialization
from marimo._server.export.exporter import Exporter
from marimo._server.file_router import AppFileRouter
-from marimo._server.models.export import ExportAsHTMLRequest
+from marimo._server.models.export import (
+ ExportAsHTMLRequest,
+ ExportPDFPreset,
+)
from marimo._server.models.models import InstantiateNotebookRequest
from marimo._session.model import ConnectionState, SessionMode
from marimo._session.notebook import AppFileManager
@@ -176,6 +179,25 @@ def export_as_wasm(
)
+def notebook_uses_slides_layout(filepath: MarimoPath) -> bool:
+ """Return whether a notebook declares the slides layout."""
+ try:
+ file_router = AppFileRouter.from_filename(filepath)
+ file_key = file_router.get_unique_file_key()
+ if file_key is None:
+ return False
+ file_manager = file_router.get_file_manager(file_key)
+ layout_config = file_manager.read_layout_config()
+ return layout_config is not None and layout_config.type == "slides"
+ except Exception as e:
+ LOGGER.debug(
+ "Unable to infer notebook layout for %s: %s",
+ filepath.absolute_name,
+ e,
+ )
+ return False
+
+
async def run_app_then_export_as_ipynb(
filepath: MarimoPath,
sort_mode: Literal["top-down", "topological"],
@@ -216,6 +238,7 @@ async def run_app_then_export_as_pdf(
webpdf: bool,
cli_args: SerializedCLIArgs,
argv: list[str] | None,
+ export_as: ExportPDFPreset | None,
include_inputs: bool = True,
rasterization_options: PDFRasterizationOptions | None = None,
) -> tuple[bytes | None, bool]:
@@ -256,14 +279,22 @@ async def run_app_then_export_as_pdf(
argv=argv,
options=rasterization_options,
)
-
- pdf_data = Exporter().export_as_pdf(
- app=file_manager.app,
- session_view=session_view,
- png_fallbacks=png_fallbacks,
- include_inputs=include_inputs,
- webpdf=webpdf,
- )
+ exporter = Exporter()
+ if export_as == "slides":
+ pdf_data = await exporter.export_as_slides_pdf(
+ app=file_manager.app,
+ session_view=session_view,
+ png_fallbacks=png_fallbacks,
+ include_inputs=include_inputs,
+ )
+ else:
+ pdf_data = exporter.export_as_pdf(
+ app=file_manager.app,
+ session_view=session_view,
+ png_fallbacks=png_fallbacks,
+ include_inputs=include_inputs,
+ webpdf=webpdf,
+ )
return pdf_data, did_error
diff --git a/marimo/_server/export/_pdf_raster.py b/marimo/_server/export/_pdf_raster.py
index 2c556b94df..21b9d13339 100644
--- a/marimo/_server/export/_pdf_raster.py
+++ b/marimo/_server/export/_pdf_raster.py
@@ -54,13 +54,19 @@ WAIT_FOR_PAGE_READY = r"""
const root = document.getElementById("root");
if (!root) return false;
- const cells = document.querySelectorAll('div[id^="cell-"]');
- if (cells.length === 0) return false;
-
return root.childElementCount > 0;
}
"""
+GO_TO_NEXT_SLIDE = r"""
+() => {
+ const swiper = document.querySelector('.swiper')?.swiper;
+ if (swiper) {
+ swiper.slideNext();
+ }
+}
+"""
+
WAIT_FOR_NEXT_PAINT = r"""
() => new Promise((resolve) => {
requestAnimationFrame(() => requestAnimationFrame(resolve));
@@ -84,6 +90,12 @@ class _RasterTarget:
expects: tuple[CaptureExpectation, ...]
+def _format_target_expects(expects: tuple[CaptureExpectation, ...]) -> str:
+ if not expects:
+ return "generic"
+ return ",".join(expects)
+
+
def _contains_marker(content: Any, markers: tuple[str, ...]) -> bool:
"""Return whether any string payload contains one of the markers."""
@@ -440,6 +452,12 @@ async def collect_pdf_png_fallbacks(
len(targets),
server_mode,
)
+ LOGGER.info(
+ "Rasterizing %s component(s) for PDF [mode=%s, scale=%s].",
+ len(targets),
+ server_mode,
+ options.scale,
+ )
if server_mode == "live":
LOGGER.debug("Raster capture strategy: live-only.")
@@ -583,23 +601,47 @@ async def _capture_pngs_from_page(
wait_until="domcontentloaded",
timeout=_READINESS_TIMEOUT_MS,
)
+ LOGGER.debug("Page loaded, waiting for readiness...")
+
await _wait_for_network_idle(
page,
timeout_ms=_NETWORK_IDLE_TIMEOUT_MS,
timeout_error=PlaywrightTimeoutError,
)
+ LOGGER.debug(
+ "Initial network idle achieved, waiting for page ready..."
+ )
+
await page.wait_for_function(
WAIT_FOR_PAGE_READY,
timeout=_READINESS_TIMEOUT_MS,
)
+ LOGGER.debug("Page ready, waiting for final network idle...")
+
await _wait_for_network_idle(
page,
timeout_ms=_NETWORK_IDLE_TIMEOUT_MS,
timeout_error=PlaywrightTimeoutError,
)
+ LOGGER.debug("Page network idle, starting target captures...")
+
+ for index, target in enumerate(targets, start=1):
+ LOGGER.info(
+ "Rasterizing [%s/%s] cell=%s (%s)",
+ index,
+ len(targets),
+ target.cell_id,
+ _format_target_expects(target.expects),
+ )
+ LOGGER.debug(
+ "Processing raster target: cell_id=%s expects=%s",
+ target.cell_id,
+ target.expects,
+ )
- for target in targets:
- locator = page.locator(f"#output-{target.cell_id}").first
+ # In live notebook mode, output wrappers often use `display: contents`,
+ # which cannot be directly screenshotted, so we target a concrete child node.
+ locator = page.locator(f"#output-{target.cell_id} > .output").first
if not await _wait_for_target_ready(
page=page,
target=target,
@@ -613,6 +655,7 @@ async def _capture_pngs_from_page(
continue
try:
+ await page.evaluate(GO_TO_NEXT_SLIDE)
await page.evaluate(WAIT_FOR_NEXT_PAINT)
image = await locator.screenshot(
type="png",
@@ -640,6 +683,11 @@ async def _capture_pngs_from_page(
len(captures),
len(targets),
)
+ LOGGER.info(
+ "Rasterization complete: captured %s/%s component(s).",
+ len(captures),
+ len(targets),
+ )
return captures
diff --git a/marimo/_server/export/exporter.py b/marimo/_server/export/exporter.py
index 2a56bc5690..9f51da679d 100644
--- a/marimo/_server/export/exporter.py
+++ b/marimo/_server/export/exporter.py
@@ -6,7 +6,7 @@ import base64
import mimetypes
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path
-from typing import TYPE_CHECKING, Literal, Optional, cast
+from typing import TYPE_CHECKING, Any, Literal, Optional, cast
from marimo import _loggers
from marimo._ast.app import InternalApp
@@ -398,6 +398,163 @@ class Exporter:
return None
return pdf_data
+ async def export_as_slides_pdf(
+ self,
+ *,
+ app: InternalApp,
+ session_view: SessionView | None,
+ png_fallbacks: Mapping[CellId_t, str] | None = None,
+ include_inputs: bool = True,
+ ) -> bytes | None:
+ """Export a slides notebook as PDF using reveal.js + Playwright.
+
+ Converts to iPynb with Jupyter slideshow metadata, renders to
+ reveal.js HTML via nbconvert's SlidesExporter, then uses
+ Playwright (async API) to print to PDF via ?print-pdf mode.
+
+ Must be called from an async context since Playwright's async API
+ is required when running inside an asyncio event loop.
+
+ Args:
+ app: The app to export
+ session_view: The session view to export. If None, outputs
+ are not included.
+ png_fallbacks: Optional cell-id keyed image/png fallbacks to
+ inject into notebook outputs before conversion.
+ include_inputs: Whether to include code cell inputs.
+
+ Returns:
+ PDF data
+ """
+ DependencyManager.require_many(
+ "for PDF export",
+ DependencyManager.nbformat,
+ DependencyManager.nbconvert,
+ DependencyManager.playwright,
+ )
+
+ ipynb_json_str = self.export_as_ipynb(
+ app=app, sort_mode="top-down", session_view=session_view
+ )
+
+ import nbformat
+
+ notebook = nbformat.reads(ipynb_json_str, as_version=4) # type: ignore[no-untyped-call]
+ if png_fallbacks:
+ from marimo._server.export._nbformat_png_fallbacks import (
+ inject_png_fallbacks_into_notebook,
+ )
+
+ inject_png_fallbacks_into_notebook(
+ notebook,
+ png_fallbacks=png_fallbacks,
+ )
+ return await self._export_slides_as_pdf(notebook, include_inputs)
+
+ @staticmethod
+ def _to_file_uri(path: str) -> str:
+ import os
+ from urllib.request import pathname2url
+
+ return f"file://{pathname2url(os.path.abspath(path))}"
+
+ @staticmethod
+ def _slide_type_for_cell(cell: Any, include_inputs: bool) -> str:
+ if include_inputs:
+ return "slide"
+ cell_type = str(cell.get("cell_type", ""))
+ if cell_type != "code":
+ return "slide"
+ outputs = cell.get("outputs", [])
+ if isinstance(outputs, list) and outputs:
+ return "slide"
+ return "skip"
+
+ @staticmethod
+ async def _export_slides_as_pdf(
+ notebook: Any,
+ include_inputs: bool,
+ ) -> bytes | None:
+ """Render slides notebook to PDF using Playwright async API."""
+ import os
+ import tempfile
+
+ from nbconvert import SlidesExporter # type: ignore[import-not-found]
+
+ # Add slideshow metadata so each cell becomes a slide.
+ for cell in notebook.cells:
+ if "slideshow" not in cell.metadata:
+ cell.metadata["slideshow"] = {}
+ cell.metadata["slideshow"]["slide_type"] = (
+ Exporter._slide_type_for_cell(cell, include_inputs)
+ )
+
+ # Convert to reveal.js HTML
+ slides_exporter = SlidesExporter()
+ slides_exporter.exclude_input = not include_inputs
+ html_data, _resources = slides_exporter.from_notebook_node(notebook)
+
+ # Write HTML to a temp file for Playwright to load
+ with tempfile.NamedTemporaryFile(
+ suffix=".html", delete=False, mode="w", encoding="utf-8"
+ ) as f:
+ f.write(html_data)
+ temp_path = f.name
+
+ try:
+ from playwright.async_api import ( # type: ignore[import-not-found]
+ async_playwright,
+ )
+
+ async with async_playwright() as playwright:
+ browser = await playwright.chromium.launch()
+ try:
+ page = await browser.new_page()
+ # ?print-pdf tells reveal.js to use a linear print layout
+ temp_uri = Exporter._to_file_uri(temp_path)
+ await page.goto(
+ f"{temp_uri}?print-pdf",
+ wait_until="networkidle",
+ )
+ await page.evaluate(
+ """
+ () => {
+ const reveal = window.Reveal;
+ if (
+ reveal &&
+ typeof reveal.layout === "function"
+ ) {
+ reveal.layout();
+ }
+ }
+ """
+ )
+ await page.wait_for_timeout(300)
+ await page.add_style_tag(
+ content=(
+ ".pdf-page:last-of-type {"
+ " page-break-after: auto !important;"
+ " break-after: auto !important;"
+ "}"
+ )
+ )
+ pdf_data = await page.pdf(
+ print_background=True,
+ prefer_css_page_size=True,
+ )
+ finally:
+ await browser.close()
+ finally:
+ try:
+ os.unlink(temp_path)
+ except OSError:
+ LOGGER.debug("Failed to remove temp slide HTML: %s", temp_path)
+
+ if not isinstance(pdf_data, bytes):
+ LOGGER.error("Slides PDF data is not bytes: %s", pdf_data)
+ return None
+ return pdf_data
+
def export_assets(
self, directory: Path, ignore_index_html: bool = False
) -> None:
diff --git a/marimo/_server/models/export.py b/marimo/_server/models/export.py
index 047fca6200..b534efd0b7 100644
--- a/marimo/_server/models/export.py
+++ b/marimo/_server/models/export.py
@@ -1,7 +1,7 @@
# Copyright 2026 Marimo. All rights reserved.
from __future__ import annotations
-from typing import Optional
+from typing import Literal, Optional
import msgspec
@@ -28,8 +28,16 @@ class ExportAsMarkdownRequest(msgspec.Struct, rename="camel"):
download: bool
+ExportPDFPreset = Literal["document", "slides"]
+
+
class ExportAsPDFRequest(msgspec.Struct, rename="camel"):
webpdf: bool
+ preset: ExportPDFPreset = "document"
+ include_inputs: bool = False
+ rasterize_outputs: bool = True
+ raster_scale: float = 4.0
+ raster_server: Literal["static", "live"] = "static"
class UpdateCellOutputsRequest(msgspec.Struct, rename="camel"):
diff --git a/packages/openapi/api.yaml b/packages/openapi/api.yaml
index 9ee4f31304..bf6147a5a3 100644
--- a/packages/openapi/api.yaml
+++ b/packages/openapi/api.yaml
@@ -1533,6 +1533,25 @@ components:
type: object
ExportAsPDFRequest:
properties:
+ includeInputs:
+ default: false
+ type: boolean
+ preset:
+ default: document
+ enum:
+ - document
+ - slides
+ rasterScale:
+ default: 4.0
+ type: number
+ rasterServer:
+ default: static
+ enum:
+ - live
+ - static
+ rasterizeOutputs:
+ default: true
+ type: boolean
webpdf:
type: boolean
required:
diff --git a/packages/openapi/src/api.ts b/packages/openapi/src/api.ts
index 31b7bd303c..e2bc525916 100644
--- a/packages/openapi/src/api.ts
+++ b/packages/openapi/src/api.ts
@@ -4074,6 +4074,22 @@ export interface components {
};
/** ExportAsPDFRequest */
ExportAsPDFRequest: {
+ /** @default false */
+ includeInputs?: boolean;
+ /**
+ * @default document
+ * @enum {unknown}
+ */
+ preset?: "document" | "slides";
+ /** @default 4 */
+ rasterScale?: number;
+ /**
+ * @default static
+ * @enum {unknown}
+ */
+ rasterServer?: "live" | "static";
+ /** @default true */
+ rasterizeOutputs?: boolean;
webpdf: boolean;
};
/** ExportAsScriptRequest */
diff --git a/tests/_cli/test_cli_export.py b/tests/_cli/test_cli_export.py
index eafc6dc2ed..a2dbbeecf2 100644
--- a/tests/_cli/test_cli_export.py
+++ b/tests/_cli/test_cli_export.py
@@ -14,6 +14,7 @@ from typing import TYPE_CHECKING, Any
import click
import pytest
+from click.testing import CliRunner
from marimo._cli.export.commands import pdf
from marimo._dependencies.dependencies import DependencyManager
@@ -937,6 +938,133 @@ class TestExportPDF:
stderr = p.stderr.decode()
assert "Rasterization options require --include-outputs." in stderr
+ @staticmethod
+ def test_export_pdf_passes_preset_to_export_pipeline(
+ temp_marimo_file: str,
+ tmp_path: Path,
+ ) -> None:
+ from unittest.mock import AsyncMock, patch
+
+ from marimo._cli.export.commands import pdf as pdf_command
+
+ output_file = tmp_path / "out.pdf"
+ runner = CliRunner()
+ mock_run_app = AsyncMock(return_value=(b"mock_pdf", False))
+
+ with (
+ patch(
+ "marimo._cli.export.commands.DependencyManager.require_many"
+ ),
+ patch(
+ "marimo._cli.export.commands.run_app_then_export_as_pdf",
+ mock_run_app,
+ ),
+ ):
+ result = runner.invoke(
+ pdf_command,
+ [
+ "--output",
+ str(output_file),
+ "--as",
+ "slides",
+ "--no-sandbox",
+ "--no-include-outputs",
+ temp_marimo_file,
+ ],
+ )
+
+ assert result.exit_code == 0
+ assert output_file.read_bytes() == b"mock_pdf"
+ assert mock_run_app.await_count == 1
+ call_kwargs = mock_run_app.await_args.kwargs
+ assert call_kwargs["export_as"] == "slides"
+
+ @staticmethod
+ def test_export_pdf_slides_shows_live_raster_recommendation(
+ temp_marimo_file: str,
+ tmp_path: Path,
+ ) -> None:
+ from unittest.mock import AsyncMock, patch
+
+ from marimo._cli.export.commands import pdf as pdf_command
+
+ output_file = tmp_path / "slides-tip.pdf"
+ runner = CliRunner()
+ mock_run_app = AsyncMock(return_value=(b"mock_pdf", False))
+
+ with (
+ patch(
+ "marimo._cli.export.commands.DependencyManager.require_many"
+ ),
+ patch(
+ "marimo._cli.export.commands.DependencyManager.playwright.require"
+ ),
+ patch(
+ "marimo._cli.export.commands.run_app_then_export_as_pdf",
+ mock_run_app,
+ ),
+ ):
+ result = runner.invoke(
+ pdf_command,
+ [
+ "--output",
+ str(output_file),
+ "--as",
+ "slides",
+ "--no-sandbox",
+ temp_marimo_file,
+ ],
+ )
+
+ assert result.exit_code == 0
+ assert "For --as=slides, prefer --raster-server=live" in result.output
+ assert mock_run_app.await_count == 1
+ call_kwargs = mock_run_app.await_args.kwargs
+ assert call_kwargs["rasterization_options"].server_mode == "static"
+
+ @staticmethod
+ def test_export_pdf_shows_slides_hint_when_preset_missing(
+ temp_marimo_file: str,
+ tmp_path: Path,
+ ) -> None:
+ from unittest.mock import AsyncMock, patch
+
+ from marimo._cli.export.commands import pdf as pdf_command
+
+ output_file = tmp_path / "hint.pdf"
+ runner = CliRunner()
+ mock_run_app = AsyncMock(return_value=(b"mock_pdf", False))
+
+ with (
+ patch(
+ "marimo._cli.export.commands.DependencyManager.require_many"
+ ),
+ patch(
+ "marimo._cli.export.commands.notebook_uses_slides_layout",
+ return_value=True,
+ ),
+ patch(
+ "marimo._cli.export.commands.run_app_then_export_as_pdf",
+ mock_run_app,
+ ),
+ ):
+ result = runner.invoke(
+ pdf_command,
+ [
+ "--output",
+ str(output_file),
+ "--no-sandbox",
+ "--no-include-outputs",
+ temp_marimo_file,
+ ],
+ )
+
+ assert result.exit_code == 0
+ assert "Use --as=slides for slide-style PDF export." in result.output
+ assert mock_run_app.await_count == 1
+ call_kwargs = mock_run_app.await_args.kwargs
+ assert call_kwargs["export_as"] is None
+
@pytest.mark.skipif(
not DependencyManager.playwright.has(),
diff --git a/tests/_server/api/endpoints/test_export.py b/tests/_server/api/endpoints/test_export.py
index e54fd3be47..fe92719fdf 100644
--- a/tests/_server/api/endpoints/test_export.py
+++ b/tests/_server/api/endpoints/test_export.py
@@ -702,7 +702,7 @@ def test_update_cell_outputs_empty_request(client: TestClient) -> None:
@with_session(SESSION_ID)
def test_export_pdf_endpoint(client: TestClient) -> None:
"""Test PDF export endpoint."""
- from unittest.mock import MagicMock, patch
+ from unittest.mock import AsyncMock, MagicMock, patch
session = get_session_manager(client).get_session(SESSION_ID)
assert session
@@ -712,9 +712,15 @@ def test_export_pdf_endpoint(client: TestClient) -> None:
mock_exporter = MagicMock()
mock_exporter.export_as_pdf.return_value = b"mock_pdf_content"
- with patch(
- "marimo._server.api.endpoints.export.Exporter",
- return_value=mock_exporter,
+ with (
+ patch(
+ "marimo._server.api.endpoints.export.Exporter",
+ return_value=mock_exporter,
+ ),
+ patch(
+ "marimo._server.export._pdf_raster.collect_pdf_png_fallbacks",
+ AsyncMock(return_value={}),
+ ),
):
response = client.post(
"/api/export/pdf",
@@ -725,6 +731,9 @@ 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"
+ call_kwargs = mock_exporter.export_as_pdf.call_args[1]
+ assert call_kwargs["include_inputs"] is False
+ assert call_kwargs["png_fallbacks"] == {}
@pytest.mark.skipif(
@@ -735,7 +744,7 @@ def test_export_pdf_endpoint(client: TestClient) -> None:
@with_session(SESSION_ID)
def test_export_pdf_endpoint_webpdf_mode(client: TestClient) -> None:
"""Test PDF export endpoint with webpdf mode."""
- from unittest.mock import MagicMock, patch
+ from unittest.mock import AsyncMock, MagicMock, patch
session = get_session_manager(client).get_session(SESSION_ID)
assert session
@@ -745,9 +754,15 @@ def test_export_pdf_endpoint_webpdf_mode(client: TestClient) -> None:
mock_exporter = MagicMock()
mock_exporter.export_as_pdf.return_value = b"mock_webpdf_content"
- with patch(
- "marimo._server.api.endpoints.export.Exporter",
- return_value=mock_exporter,
+ with (
+ patch(
+ "marimo._server.api.endpoints.export.Exporter",
+ return_value=mock_exporter,
+ ),
+ patch(
+ "marimo._server.export._pdf_raster.collect_pdf_png_fallbacks",
+ AsyncMock(return_value={}),
+ ),
):
response = client.post(
"/api/export/pdf",
@@ -761,6 +776,104 @@ def test_export_pdf_endpoint_webpdf_mode(client: TestClient) -> None:
mock_exporter.export_as_pdf.assert_called_once()
call_kwargs = mock_exporter.export_as_pdf.call_args[1]
assert call_kwargs["webpdf"] is True
+ assert call_kwargs["include_inputs"] is False
+ assert call_kwargs["png_fallbacks"] == {}
+
+
+ not DependencyManager.nbformat.has()
+ or not DependencyManager.nbconvert.has(),
+ reason="nbformat or nbconvert not installed",
+)
+@with_session(SESSION_ID)
+def test_export_pdf_endpoint_slides_preset(client: TestClient) -> None:
+ """Test PDF export endpoint routes slides preset to slides exporter."""
+ from unittest.mock import AsyncMock, MagicMock, patch
+
+ session = get_session_manager(client).get_session(SESSION_ID)
+ assert session
+ session.app_file_manager.filename = "test.py"
+
+ mock_exporter = MagicMock()
+ mock_exporter.export_as_slides_pdf = AsyncMock(
+ return_value=b"mock_slides_content"
+ )
+
+ with (
+ patch(
+ "marimo._server.api.endpoints.export.Exporter",
+ return_value=mock_exporter,
+ ),
+ patch(
+ "marimo._server.export._pdf_raster.collect_pdf_png_fallbacks",
+ AsyncMock(return_value={"1": "data:image/png;base64,ZmFrZQ=="}),
+ ),
+ ):
+ response = client.post(
+ "/api/export/pdf",
+ headers=HEADERS,
+ json={"webpdf": False, "preset": "slides"},
+ )
+
+ assert response.status_code == 200
+ assert response.content == b"mock_slides_content"
+ mock_exporter.export_as_slides_pdf.assert_awaited_once()
+ call_kwargs = mock_exporter.export_as_slides_pdf.await_args.kwargs
+ assert call_kwargs["include_inputs"] is False
+ assert call_kwargs["png_fallbacks"] == {
+ "1": "data:image/png;base64,ZmFrZQ=="
+ }
+ mock_exporter.export_as_pdf.assert_not_called()
+
+
+ not DependencyManager.nbformat.has()
+ or not DependencyManager.nbconvert.has(),
+ reason="nbformat or nbconvert not installed",
+)
+@with_session(SESSION_ID)
+def test_export_pdf_endpoint_live_raster_uses_live_server_mode(
+ client: TestClient,
+) -> None:
+ from unittest.mock import AsyncMock, MagicMock, patch
+ from urllib.parse import parse_qs, urlparse
+
+ session = get_session_manager(client).get_session(SESSION_ID)
+ assert session
+ session.app_file_manager.filename = "/tmp/test.py"
+
+ collect_mock = AsyncMock(return_value={})
+ mock_exporter = MagicMock()
+ mock_exporter.export_as_pdf.return_value = b"mock_pdf_content"
+
+ with (
+ patch(
+ "marimo._server.api.endpoints.export.Exporter",
+ return_value=mock_exporter,
+ ),
+ patch(
+ "marimo._server.export._pdf_raster.collect_pdf_png_fallbacks",
+ collect_mock,
+ ),
+ ):
+ response = client.post(
+ "/api/export/pdf",
+ headers=HEADERS,
+ json={"webpdf": False, "rasterServer": "live"},
+ )
+
+ assert response.status_code == 200
+ call_kwargs = collect_mock.await_args.kwargs
+ options = call_kwargs["options"]
+ assert options.server_mode == "live"
+ live_page_url = call_kwargs["live_page_url"]
+ assert isinstance(live_page_url, str)
+ parsed = urlparse(live_page_url)
+ params = parse_qs(parsed.query)
+ assert params["session_id"] == [SESSION_ID]
+ assert params["kiosk"] == ["true"]
+ assert params["file"] == ["/tmp/test.py"]
+ assert params["access_token"]
@with_session(SESSION_ID)
@@ -768,7 +881,7 @@ def test_export_pdf_endpoint_returns_error_on_failure(
client: TestClient,
) -> None:
"""Test PDF export endpoint returns error when export fails."""
- from unittest.mock import MagicMock, patch
+ from unittest.mock import AsyncMock, MagicMock, patch
session = get_session_manager(client).get_session(SESSION_ID)
assert session
@@ -778,9 +891,15 @@ def test_export_pdf_endpoint_returns_error_on_failure(
mock_exporter = MagicMock()
mock_exporter.export_as_pdf.return_value = None
- with patch(
- "marimo._server.api.endpoints.export.Exporter",
- return_value=mock_exporter,
+ with (
+ patch(
+ "marimo._server.api.endpoints.export.Exporter",
+ return_value=mock_exporter,
+ ),
+ patch(
+ "marimo._server.export._pdf_raster.collect_pdf_png_fallbacks",
+ AsyncMock(return_value={}),
+ ),
):
response = client.post(
"/api/export/pdf",
diff --git a/tests/_server/export/test_exporter.py b/tests/_server/export/test_exporter.py
index 52d34d87db..d7c9be1ef4 100644
--- a/tests/_server/export/test_exporter.py
+++ b/tests/_server/export/test_exporter.py
@@ -6,7 +6,7 @@ import json
import pathlib
import sys
from typing import TYPE_CHECKING, Any
-from unittest.mock import ANY, MagicMock, patch
+from unittest.mock import ANY, AsyncMock, MagicMock, patch
import pytest
@@ -1139,3 +1139,200 @@ class TestPDFExport:
assert (
mock_webpdf_exporter_instance.allow_chromium_download is True
)
+
+ @pytest.mark.skipif(
+ not DependencyManager.nbformat.has(),
+ reason="nbformat not installed",
+ )
+ async def test_export_as_slides_pdf(
+ self,
+ session_view: SessionView,
+ ) -> None:
+ """Test slides PDF export uses SlidesExporter + async Playwright."""
+ app = App()
+
+ @app.cell()
+ def slide_1():
+ return "slide 1"
+
+ @app.cell()
+ def slide_2():
+ return "slide 2"
+
+ file_manager = AppFileManager.from_app(InternalApp(app))
+ exporter = Exporter()
+
+ mock_slides_exporter_instance = MagicMock()
+ mock_slides_exporter_instance.from_notebook_node.return_value = (
+ "<html>mock slides html</html>",
+ {},
+ )
+ mock_slides_exporter_cls = MagicMock(
+ return_value=mock_slides_exporter_instance
+ )
+
+ mock_page = AsyncMock()
+ mock_page.pdf.return_value = b"mock_slides_pdf_data"
+ mock_browser = AsyncMock()
+ mock_browser.new_page.return_value = mock_page
+ mock_playwright_instance = AsyncMock()
+ mock_playwright_instance.chromium.launch.return_value = mock_browser
+ mock_playwright_cm = AsyncMock()
+ mock_playwright_cm.__aenter__.return_value = mock_playwright_instance
+ mock_playwright_cm.__aexit__.return_value = False
+ mock_async_playwright = MagicMock(return_value=mock_playwright_cm)
+
+ mock_nbconvert = MagicMock()
+ mock_nbconvert.SlidesExporter = mock_slides_exporter_cls
+ mock_playwright_async = MagicMock()
+ mock_playwright_async.async_playwright = mock_async_playwright
+
+ orig_nbconvert = sys.modules.get("nbconvert")
+ orig_playwright = sys.modules.get("playwright.async_api")
+
+ try:
+ sys.modules["nbconvert"] = mock_nbconvert
+ sys.modules["playwright.async_api"] = mock_playwright_async
+
+ with (
+ patch.object(
+ DependencyManager.nbconvert, "has", return_value=True
+ ),
+ patch.object(
+ DependencyManager.playwright, "has", return_value=True
+ ),
+ ):
+ result = await exporter.export_as_slides_pdf(
+ app=file_manager.app,
+ session_view=session_view,
+ )
+
+ assert result == b"mock_slides_pdf_data"
+ mock_slides_exporter_cls.assert_called_once()
+ mock_slides_exporter_instance.from_notebook_node.assert_called_once()
+ notebook = (
+ mock_slides_exporter_instance.from_notebook_node.call_args[0][
+ 0
+ ]
+ )
+ slide_types = [
+ cell.metadata.get("slideshow", {}).get("slide_type")
+ for cell in notebook.cells
+ ]
+ assert slide_types
+ assert set(slide_types) == {"slide"}
+
+ mock_page.goto.assert_called_once()
+ goto_url = mock_page.goto.call_args[0][0]
+ assert goto_url.startswith("file://")
+ assert "?print-pdf" in goto_url
+ assert mock_page.evaluate.await_count >= 1
+ mock_page.wait_for_timeout.assert_called_once_with(300)
+ mock_page.add_style_tag.assert_called_once()
+ mock_page.pdf.assert_called_once_with(
+ print_background=True,
+ prefer_css_page_size=True,
+ )
+ finally:
+ if orig_nbconvert is not None:
+ sys.modules["nbconvert"] = orig_nbconvert
+ else:
+ sys.modules.pop("nbconvert", None)
+ if orig_playwright is not None:
+ sys.modules["playwright.async_api"] = orig_playwright
+ else:
+ sys.modules.pop("playwright.async_api", None)
+
+ @pytest.mark.skipif(
+ not DependencyManager.nbformat.has(),
+ reason="nbformat not installed",
+ )
+ async def test_export_as_slides_pdf_marks_all_slides_without_inputs(
+ self,
+ session_view: SessionView,
+ ) -> None:
+ app = App()
+
+ @app.cell()
+ def slide_1():
+ value = 1
+ return value
+
+ @app.cell()
+ def slide_2():
+ value = 2
+ return value
+
+ file_manager = AppFileManager.from_app(InternalApp(app))
+ exporter = Exporter()
+
+ mock_slides_exporter_instance = MagicMock()
+ mock_slides_exporter_instance.from_notebook_node.return_value = (
+ "<html>mock slides html</html>",
+ {},
+ )
+ mock_slides_exporter_cls = MagicMock(
+ return_value=mock_slides_exporter_instance
+ )
+
+ mock_page = AsyncMock()
+ mock_page.pdf.return_value = b"mock_slides_pdf_data"
+ mock_browser = AsyncMock()
+ mock_browser.new_page.return_value = mock_page
+ mock_playwright_instance = AsyncMock()
+ mock_playwright_instance.chromium.launch.return_value = mock_browser
+ mock_playwright_cm = AsyncMock()
+ mock_playwright_cm.__aenter__.return_value = mock_playwright_instance
+ mock_playwright_cm.__aexit__.return_value = False
+ mock_async_playwright = MagicMock(return_value=mock_playwright_cm)
+
+ mock_nbconvert = MagicMock()
+ mock_nbconvert.SlidesExporter = mock_slides_exporter_cls
+ mock_playwright_async = MagicMock()
+ mock_playwright_async.async_playwright = mock_async_playwright
+
+ orig_nbconvert = sys.modules.get("nbconvert")
+ orig_playwright = sys.modules.get("playwright.async_api")
+
+ try:
+ sys.modules["nbconvert"] = mock_nbconvert
+ sys.modules["playwright.async_api"] = mock_playwright_async
+
+ with (
+ patch.object(
+ DependencyManager.nbconvert, "has", return_value=True
+ ),
+ patch.object(
+ DependencyManager.playwright, "has", return_value=True
+ ),
+ ):
+ result = await exporter.export_as_slides_pdf(
+ app=file_manager.app,
+ session_view=session_view,
+ include_inputs=False,
+ )
+
+ assert result == b"mock_slides_pdf_data"
+ notebook = (
+ mock_slides_exporter_instance.from_notebook_node.call_args[0][
+ 0
+ ]
+ )
+ slide_types = [
+ cell.metadata.get("slideshow", {}).get("slide_type")
+ for cell in notebook.cells
+ ]
+ assert set(slide_types) == {"skip"}
+ mock_page.pdf.assert_called_once_with(
+ print_background=True,
+ prefer_css_page_size=True,
+ )
+ finally:
+ if orig_nbconvert is not None:
+ sys.modules["nbconvert"] = orig_nbconvert
+ else:
+ sys.modules.pop("nbconvert", None)
+ if orig_playwright is not None:
+ sys.modules["playwright.async_api"] = orig_playwright
+ else:
+ sys.modules.pop("playwright.async_api", None)