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.

fix(export): allow WebPDF export on Windows (#10131)

Péter Gyarmati0af89eeb4c5c
diff --git a/marimo/_server/export/exporter.py b/marimo/_server/export/exporter.py
index 8395ebec50..bd37dce652 100644
--- a/marimo/_server/export/exporter.py
+++ b/marimo/_server/export/exporter.py
@@ -4,6 +4,7 @@ from __future__ import annotations
import asyncio
import base64
import mimetypes
+import sys
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path
from typing import TYPE_CHECKING, Any, Literal, cast
@@ -90,6 +91,41 @@ def _nbconvert_tag_remove_config() -> Config:
return config
+def _render_webpdf_with_nbconvert(notebook: Any, include_inputs: bool) -> Any:
+ if sys.platform == "win32":
+ # marimo installs the Selector policy during import. The spawned render
+ # process restores Proactor before Playwright creates its subprocess loop.
+ asyncio.set_event_loop_policy(None)
+
+ from nbconvert import WebPDFExporter # type: ignore[import-not-found]
+
+ web_exporter = WebPDFExporter( # type: ignore[no-untyped-call]
+ config=_nbconvert_tag_remove_config(),
+ )
+ web_exporter.exclude_input = not include_inputs
+ web_exporter.allow_chromium_download = True
+ pdf_data, _resources = web_exporter.from_notebook_node(notebook) # type: ignore[no-untyped-call]
+ return pdf_data
+
+
+def _render_webpdf(notebook: Any, include_inputs: bool) -> Any:
+ if sys.platform != "win32":
+ return _render_webpdf_with_nbconvert(notebook, include_inputs)
+
+ from concurrent.futures import ProcessPoolExecutor
+ from multiprocessing import get_context
+
+ with ProcessPoolExecutor(
+ max_workers=1,
+ mp_context=get_context("spawn"),
+ ) as pool:
+ return pool.submit(
+ _render_webpdf_with_nbconvert,
+ notebook,
+ include_inputs,
+ ).result()
+
+
class Exporter:
# Virtual file URL format constants
_VIRTUAL_FILE_PATTERN = "./@file/"
@@ -541,19 +577,12 @@ class Exporter:
exc_info=e,
)
- from nbconvert import WebPDFExporter
-
emit_pdf_export_status(
status_callback,
phase="render",
message="rendering PDF via WebPDF...",
)
- web_exporter = WebPDFExporter( # type: ignore[no-untyped-call]
- config=_nbconvert_tag_remove_config(),
- )
- web_exporter.exclude_input = not include_inputs
- web_exporter.allow_chromium_download = True
- pdf_data, _resources = web_exporter.from_notebook_node(notebook) # type: ignore[no-untyped-call]
+ pdf_data = _render_webpdf(notebook, include_inputs)
if not isinstance(pdf_data, bytes):
LOGGER.error("PDF data is not bytes: %s", pdf_data)
diff --git a/tests/_server/export/test_exporter.py b/tests/_server/export/test_exporter.py
index d31e5e6e6f..ebacfc8543 100644
--- a/tests/_server/export/test_exporter.py
+++ b/tests/_server/export/test_exporter.py
@@ -6,6 +6,7 @@ import json
import pathlib
import sys
import textwrap
+from concurrent.futures import ThreadPoolExecutor
from typing import TYPE_CHECKING, Any
from unittest.mock import ANY, AsyncMock, MagicMock, patch
@@ -1709,6 +1710,7 @@ class TestPDFExport:
with (
patch.object(DependencyManager, "require_many"),
+ patch.object(sys, "platform", "linux"),
patch("nbconvert.WebPDFExporter") as mock_webpdf_exporter,
):
mock_webpdf_exporter.return_value = mock_exporter_instance
@@ -1724,6 +1726,86 @@ class TestPDFExport:
assert mock_exporter_instance.exclude_input is False
assert mock_exporter_instance.allow_chromium_download is True
+ @pytest.mark.skipif(
+ sys.platform != "win32" or not DependencyManager.nbformat.has(),
+ reason="requires Windows and nbformat",
+ )
+ def test_webpdf_render_preserves_parent_event_loop_policy(
+ self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
+ ) -> None:
+ import nbformat
+
+ from marimo._server.export.exporter import _render_webpdf
+
+ (tmp_path / "nbconvert.py").write_text(
+ textwrap.dedent(
+ """
+ class WebPDFExporter:
+ def __init__(self, config):
+ self.config = config
+
+ def from_notebook_node(self, notebook):
+ return b"mock_webpdf_data", {}
+ """
+ ),
+ encoding="utf-8",
+ )
+ monkeypatch.syspath_prepend(str(tmp_path))
+ with (
+ patch.object(
+ asyncio, "set_event_loop_policy"
+ ) as set_event_loop_policy,
+ ):
+ result = _render_webpdf(
+ nbformat.v4.new_notebook(), # type: ignore[no-untyped-call]
+ include_inputs=True,
+ )
+
+ assert result == b"mock_webpdf_data"
+ set_event_loop_policy.assert_not_called()
+
+ @pytest.mark.skipif(
+ sys.platform != "win32" or not DependencyManager.nbconvert.has(),
+ reason="requires Windows and nbconvert",
+ )
+ def test_webpdf_worker_can_spawn_subprocess_on_windows(self) -> None:
+ from marimo._server.export.exporter import (
+ _render_webpdf_with_nbconvert,
+ )
+
+ async def spawn_process() -> None:
+ process = await asyncio.create_subprocess_exec(
+ sys.executable, "-c", "pass"
+ )
+ assert await process.wait() == 0
+
+ mock_exporter_instance = MagicMock()
+
+ def render(
+ *_args: Any, **_kwargs: Any
+ ) -> tuple[bytes, dict[Any, Any]]:
+ with ThreadPoolExecutor(max_workers=1) as pool:
+ pool.submit(asyncio.run, spawn_process()).result()
+ return b"mock_webpdf_data", {}
+
+ mock_exporter_instance.from_notebook_node.side_effect = render
+ original_policy = asyncio.get_event_loop_policy()
+ selector_policy = asyncio.WindowsSelectorEventLoopPolicy()
+ asyncio.set_event_loop_policy(selector_policy)
+
+ try:
+ with patch(
+ "nbconvert.WebPDFExporter", create=True
+ ) as mock_webpdf_exporter:
+ mock_webpdf_exporter.return_value = mock_exporter_instance
+ result = _render_webpdf_with_nbconvert(
+ MagicMock(), include_inputs=True
+ )
+
+ assert result == b"mock_webpdf_data"
+ finally:
+ asyncio.set_event_loop_policy(original_policy)
+
@pytest.mark.skipif(
not DependencyManager.nbformat.has()
or not DependencyManager.nbconvert.has(),
@@ -1752,6 +1834,7 @@ class TestPDFExport:
with (
patch.object(DependencyManager, "require_many"),
+ patch.object(sys, "platform", "linux"),
patch("nbconvert.WebPDFExporter") as mock_webpdf_exporter,
):
mock_webpdf_exporter.return_value = mock_exporter_instance
@@ -1842,6 +1925,7 @@ class TestPDFExport:
with (
patch.object(DependencyManager, "require_many"),
+ patch.object(sys, "platform", "linux"),
patch("nbconvert.PDFExporter") as mock_pdf_exporter,
patch("nbconvert.WebPDFExporter") as mock_webpdf_exporter,
):
@@ -1906,6 +1990,7 @@ class TestPDFExport:
with (
patch.object(DependencyManager, "require_many"),
+ patch.object(sys, "platform", "linux"),
patch("nbconvert.PDFExporter") as mock_pdf_exporter,
patch("nbconvert.WebPDFExporter") as mock_webpdf_exporter,
):
@@ -1957,6 +2042,7 @@ class TestPDFExport:
with (
patch.object(DependencyManager, "require_many"),
+ patch.object(sys, "platform", "linux"),
patch("nbconvert.PDFExporter") as mock_pdf_exporter,
patch("nbconvert.WebPDFExporter") as mock_webpdf_exporter,
):
@@ -2005,6 +2091,7 @@ class TestPDFExport:
with (
patch.object(DependencyManager, "require_many"),
+ patch.object(sys, "platform", "linux"),
patch("nbconvert.PDFExporter") as mock_pdf_exporter,
patch("nbconvert.WebPDFExporter") as mock_webpdf_exporter,
):