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.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
feat: handle ImportError and ModuleNotFoundError in output formatting (#7482)
Myles Scolnick9219b241114a
diff --git a/marimo/_runtime/runner/hooks_post_execution.py b/marimo/_runtime/runner/hooks_post_execution.pyindex 24c52139bb..9dcad99869 100644--- a/marimo/_runtime/runner/hooks_post_execution.py+++ b/marimo/_runtime/runner/hooks_post_execution.py@@ -286,7 +286,7 @@ def _issue_exception_side_effect(@kernel_tracer.start_as_current_span("broadcast_outputs")def _broadcast_outputs(cell: CellImpl,- _runner: cell_runner.Runner,+ runner: cell_runner.Runner,run_result: cell_runner.RunResult,) -> None:# TODO: clean this logic up ...@@ -311,6 +311,12 @@ def _broadcast_outputs(formatted_output = formatting.try_format(run_result.output, include_opinionated=False)+ # For ImportError and ModuleNotFoundError, store the exception in the runner+ # so it can be reported by the missing_packages_hook.+ if isinstance(+ formatted_output.exception, (ImportError, ModuleNotFoundError)+ ):+ runner.exceptions[cell.cell_id] = formatted_output.exceptionif formatted_output.traceback is not None:write_traceback(formatted_output.traceback)diff --git a/tests/_runtime/test_manage_script_metadata.py b/tests/_runtime/test_manage_script_metadata.pyindex 9404f8a5c6..e03a8846e3 100644--- a/tests/_runtime/test_manage_script_metadata.py+++ b/tests/_runtime/test_manage_script_metadata.py@@ -306,8 +306,6 @@ async def test_missing_packages_hook(broadcast_messages.append(msg)k.enqueue_control_request = mock_enqueue- InstallingPackageAlert.broadcast = mock_broadcast # type: ignore- MissingPackageAlert.broadcast = mock_broadcast # type: ignore# Create a mock runner with ModuleNotFoundErrorclass MockRunner:@@ -330,8 +328,12 @@ async def test_missing_packages_hook(),}- # Case 1: Auto-install enabled- with patch("micropip.install", new_callable=AsyncMock):+ with (+ patch.object(InstallingPackageAlert, "broadcast", mock_broadcast),+ patch.object(MissingPackageAlert, "broadcast", mock_broadcast),+ patch("micropip.install", new_callable=AsyncMock),+ ):+ # Case 1: Auto-install enabledrunner = cast(cell_runner.Runner, MockRunner())k.packages_callbacks.package_manager = create_package_manager("micropip"@@ -436,8 +438,6 @@ def test_missing_packages_hook_pip(broadcast_messages.append(msg)k.enqueue_control_request = mock_enqueue- InstallingPackageAlert.broadcast = mock_broadcast # type: ignore- MissingPackageAlert.broadcast = mock_broadcast # type: ignore# Create a mock runner with ModuleNotFoundErrorclass MockRunner:@@ -456,48 +456,52 @@ def test_missing_packages_hook_pip(),}- k.packages_callbacks.package_manager = create_package_manager("pip")- package_manager = k.packages_callbacks.package_manager- assert isinstance(package_manager, PipPackageManager)- package_manager.install = AsyncMock()- runner = cast(cell_runner.Runner, MockRunner())-- # Case 1: Missing modules with auto-install disabled- k.module_registry.missing_modules = lambda: {"numpy", "pandas"} # type: ignore- package_manager.should_auto_install = lambda: False # type: ignore- k.packages_callbacks.missing_packages_hook(runner)-- # Should broadcast alert instead of installing- assert len(control_requests) == 0- assert len(broadcast_messages) == 1- alert = broadcast_messages[0]- assert isinstance(alert, MissingPackageAlert)- assert alert.packages == ["ibis-framework[duckdb]", "numpy", "pandas"]- assert alert.isolated == is_python_isolated()-- # Case 2: Multiple missing modules with auto-install enabled- control_requests.clear()- broadcast_messages.clear()- k.module_registry.missing_modules = lambda: {- "ibis-framework[duckdb]",- "numpy",- "pandas",- "scipy",- } # type: ignore- package_manager.should_auto_install = lambda: True # type: ignore- k.packages_callbacks.missing_packages_hook(runner)-- # Should create install request with all missing packages- assert len(control_requests) == 1- request = control_requests[0]- assert isinstance(request, InstallMissingPackagesRequest)- assert request.manager == "pip"- assert request.versions == {- "ibis-framework[duckdb]": "",- "numpy": "",- "pandas": "",- "scipy": "",- }+ with (+ patch.object(InstallingPackageAlert, "broadcast", mock_broadcast),+ patch.object(MissingPackageAlert, "broadcast", mock_broadcast),+ ):+ k.packages_callbacks.package_manager = create_package_manager("pip")+ package_manager = k.packages_callbacks.package_manager+ assert isinstance(package_manager, PipPackageManager)+ package_manager.install = AsyncMock()+ runner = cast(cell_runner.Runner, MockRunner())++ # Case 1: Missing modules with auto-install disabled+ k.module_registry.missing_modules = lambda: {"numpy", "pandas"} # type: ignore+ package_manager.should_auto_install = lambda: False # type: ignore+ k.packages_callbacks.missing_packages_hook(runner)++ # Should broadcast alert instead of installing+ assert len(control_requests) == 0+ assert len(broadcast_messages) == 1+ alert = broadcast_messages[0]+ assert isinstance(alert, MissingPackageAlert)+ assert alert.packages == ["ibis-framework[duckdb]", "numpy", "pandas"]+ assert alert.isolated == is_python_isolated()++ # Case 2: Multiple missing modules with auto-install enabled+ control_requests.clear()+ broadcast_messages.clear()+ k.module_registry.missing_modules = lambda: {+ "ibis-framework[duckdb]",+ "numpy",+ "pandas",+ "scipy",+ } # type: ignore+ package_manager.should_auto_install = lambda: True # type: ignore+ k.packages_callbacks.missing_packages_hook(runner)++ # Should create install request with all missing packages+ assert len(control_requests) == 1+ request = control_requests[0]+ assert isinstance(request, InstallMissingPackagesRequest)+ assert request.manager == "pip"+ assert request.versions == {+ "ibis-framework[duckdb]": "",+ "numpy": "",+ "pandas": "",+ "scipy": "",+ }async def test_install_missing_packages_with_streaming_logs(@@ -533,11 +537,9 @@ async def test_install_missing_packages_with_streaming_logs(# Set up packages callbacksk.packages_callbacks.package_manager = mock_package_manager- # Monkey patch broadcast for testing- original_broadcast = InstallingPackageAlert.broadcast- InstallingPackageAlert.broadcast = mock_broadcast-- try:+ with (+ patch.object(InstallingPackageAlert, "broadcast", mock_broadcast),+ ):# Create install requestrequest = InstallMissingPackagesRequest(manager="pip", versions={"numpy": ""}@@ -577,10 +579,6 @@ async def test_install_missing_packages_with_streaming_logs(call_args = mock_package_manager.install.call_argsassert call_args.kwargs.get("log_callback") is not None- finally:- # Restore original broadcast method- InstallingPackageAlert.broadcast = original_broadcast-async def test_install_missing_packages_streaming_logs_failure(mocked_kernel: MockedKernel,@@ -610,11 +608,9 @@ async def test_install_missing_packages_streaming_logs_failure(mock_package_manager.install = AsyncMock(side_effect=mock_install_fail)k.packages_callbacks.package_manager = mock_package_manager- # Monkey patch broadcast- original_broadcast = InstallingPackageAlert.broadcast- InstallingPackageAlert.broadcast = mock_broadcast-- try:+ with (+ patch.object(InstallingPackageAlert, "broadcast", mock_broadcast),+ ):request = InstallMissingPackagesRequest(manager="pip", versions={"nonexistent-package": ""})@@ -637,9 +633,6 @@ async def test_install_missing_packages_streaming_logs_failure("Failed to install" in done_alerts[0].logs["nonexistent-package"])- finally:- InstallingPackageAlert.broadcast = original_broadcast-async def test_install_missing_packages_streaming_logs_multiple_packages(mocked_kernel: MockedKernel,@@ -674,11 +667,9 @@ async def test_install_missing_packages_streaming_logs_multiple_packages(mock_package_manager.install = AsyncMock(side_effect=mock_install)k.packages_callbacks.package_manager = mock_package_manager- # Monkey patch broadcast- original_broadcast = InstallingPackageAlert.broadcast- InstallingPackageAlert.broadcast = mock_broadcast-- try:+ with (+ patch.object(InstallingPackageAlert, "broadcast", mock_broadcast),+ ):request = InstallMissingPackagesRequest(manager="pip", versions={"numpy": "", "pandas": "", "scipy": ""})@@ -717,9 +708,6 @@ async def test_install_missing_packages_streaming_logs_multiple_packages(assert packages_in_start_logs == {"numpy", "pandas", "scipy"}assert packages_in_done_logs == {"numpy", "pandas", "scipy"}- finally:- InstallingPackageAlert.broadcast = original_broadcast-async def test_install_missing_packages_no_logs_backward_compatibility(mocked_kernel: MockedKernel,@@ -749,11 +737,9 @@ async def test_install_missing_packages_no_logs_backward_compatibility()k.packages_callbacks.package_manager = mock_package_manager- # Monkey patch broadcast- original_broadcast = InstallingPackageAlert.broadcast- InstallingPackageAlert.broadcast = mock_broadcast-- try:+ with (+ patch.object(InstallingPackageAlert, "broadcast", mock_broadcast),+ ):request = InstallMissingPackagesRequest(manager="pip", versions={"requests": ""})@@ -773,6 +759,3 @@ async def test_install_missing_packages_no_logs_backward_compatibility(# Should have at least installing and installed statusesassert "installed" in package_statuses# Note: The exact sequence might vary, but we should have final success-- finally:- InstallingPackageAlert.broadcast = original_broadcastdiff --git a/tests/_runtime/test_runtime.py b/tests/_runtime/test_runtime.pyindex 20180c19d4..d2d7d82b43 100644--- a/tests/_runtime/test_runtime.py+++ b/tests/_runtime/test_runtime.py@@ -1,6 +1,7 @@# Copyright 2024 Marimo. All rights reserved.from __future__ import annotations+import asyncioimport pathlibimport sysimport textwrap@@ -2425,6 +2426,90 @@ class TestStoredOutput:cell = k.graph.cells[er.cell_id]assert cell.output is None+ async def test_formatter_import_error_handled(+ self, mocked_kernel: MockedKernel, exec_req: ExecReqProvider+ ) -> None:+ """Test that ImportError in formatter is handled gracefully.++ When a formatter (like _repr_html_) raises an ImportError, the cell+ should still execute successfully, but the exception should be stored+ in runner.exceptions for the missing_packages_hook to detect.+ """+ k = mocked_kernel.k+ assert k.packages_callbacks.package_manager is not None++ await k.run(+ [+ er := exec_req.get(+ """+ class CustomObject:+ def _repr_html_(self):+ import missing_package++ obj = CustomObject()+ obj+ """+ )+ ]+ )++ # Cell should execute successfully (exception is in formatter, not execution)+ cell = k.graph.cells[er.cell_id]+ assert cell.exception is None+ assert "obj" in k.globals+ assert "CustomObject" in k.globals++ # Check that the output was still broadcast (even if formatting failed)+ stream = MockStream(mocked_kernel.stream)+ cell_ops = stream.cell_ops+ output_ops = [op for op in cell_ops if op.output is not None]+ # Should have output, even if formatter failed (falls back to plain formatter)+ assert len(output_ops) > 0+ op_names = [op.get("op") for op in stream.operations]+ assert "missing-package-alert" in op_names++ async def test_formatter_module_not_found_error_handled(+ self, mocked_kernel: MockedKernel, exec_req: ExecReqProvider+ ) -> None:+ """Test that ModuleNotFoundError in formatter is handled gracefully.++ When a formatter (like _repr_html_) raises a ModuleNotFoundError, the cell+ should still execute successfully, but the exception should be stored+ in runner.exceptions for the missing_packages_hook to detect.+ """+ k = mocked_kernel.k+ assert k.packages_callbacks.package_manager is not None++ await k.run(+ [+ er := exec_req.get(+ """+ class CustomObject:+ def _repr_html_(self):+ raise ModuleNotFoundError("another_missing_package", name="another_missing_package")++ obj = CustomObject()+ obj+ """+ )+ ]+ )++ # Cell should execute successfully (exception is in formatter, not execution)+ cell = k.graph.cells[er.cell_id]+ assert cell.exception is None+ assert "obj" in k.globals+ assert "CustomObject" in k.globals++ # Check that the output was still broadcast (even if formatting failed)+ stream = MockStream(mocked_kernel.stream)+ cell_ops = stream.cell_ops+ output_ops = [op for op in cell_ops if op.output is not None]+ # Should have output, even if formatter failed (falls back to plain formatter)+ assert len(output_ops) > 0+ op_names = [op.get("op") for op in stream.operations]+ assert "missing-package-alert" in op_names+class TestDisable:async def test_disable_and_reenable_not_stale(@@ -2793,8 +2878,6 @@ class TestAsyncIO:async def test_wait_for(any_kernel: Kernel, exec_req: ExecReqProvider) -> None:- import asyncio-k = any_kernelawait k.run(