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
Preserve leading and trailing comments when formatting cells (#10060)
Trevor Manz79ff1d36d69c
diff --git a/marimo/_ast/parse.py b/marimo/_ast/parse.pyindex 574305349d..b7169126c2 100644--- a/marimo/_ast/parse.py+++ b/marimo/_ast/parse.py@@ -97,21 +97,16 @@ def unwrap_cell_body(formatted: str) -> str:raise ValueError(f"Expected a FunctionDef node, got {type(fn).__name__}")- if fn.end_lineno is None:- raise ValueError("FunctionDef node has no end_lineno")- first = fn.body[0]- start_lineno = first.lineno - 1- # AST statement line numbers point at `def`/`class`, not decorators.- # Start at the first decorator to preserve decorated top-level cells.- if isinstance(- first, (ast.AsyncFunctionDef, ast.FunctionDef, ast.ClassDef)- ):- if first.decorator_list:- start_lineno = first.decorator_list[0].lineno - 1+ # The `def _():` header is a single line, so everything from `fn.lineno`+ # (the first body line) through the end of the source is the cell body.+ # Extracting this whole span rather than statement offsets keeps comments+ # and decorators, which have no AST nodes of their own and would otherwise+ # fall outside the first/last statement's line and column offsets.+ start_lineno = fn.linenoextractor = Extractor(formatted)raw = extractor.extract_from_offsets(- start_lineno, 0, fn.end_lineno - 1, fn.end_col_offset+ start_lineno, 0, len(extractor.lines) - 1, None)return fixed_dedent(raw).strip()diff --git a/tests/_utils/test_formatter.py b/tests/_utils/test_formatter.pyindex b432d3c7db..1862823785 100644--- a/tests/_utils/test_formatter.py+++ b/tests/_utils/test_formatter.py@@ -5,7 +5,9 @@ import sysfrom unittest.mock import AsyncMock, MagicMock, patchimport pytest+from inline_snapshot import snapshot+from marimo._dependencies.dependencies import DependencyManagerfrom marimo._utils.formatter import (BlackFormatter,CellCodes,@@ -16,6 +18,8 @@ from marimo._utils.formatter import (ruff,)+HAS_RUFF = DependencyManager.ruff.has() or DependencyManager.which("ruff")+class TestFormatter:"""Test the base Formatter class."""@@ -237,6 +241,27 @@ class TestRuffFormatter:assert result == {"cell1": cell_code}+ @pytest.mark.skipif(not HAS_RUFF, reason="ruff not installed")+ async def test_ruff_formatter_preserves_comments(self) -> None:+ """Regression test for #10054/#10057: comments must survive the real+ wrap -> ruff -> unwrap round-trip. Comments are not AST nodes, so a+ leading comment sits before the first body statement's lineno and a+ trailing comment sits after the last statement's end_lineno; both were+ previously dropped."""+ cell_code = "# leading comment\nx=1\ny = 2 # inline comment\n# interior comment\nz = 3 # last-line comment\n# trailing comment"++ result = await RuffFormatter(line_length=88).format({"c": cell_code})++ assert result["c"] == snapshot(+ """\+# leading comment+x = 1+y = 2 # inline comment+# interior comment+z = 3 # last-line comment+# trailing comment"""+ )+@patch("marimo._utils.formatter.ruff")async def test_ruff_formatter_comment_only_cell(self, mock_ruff: MagicMock