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.

improve: when formatting structures, don't flatten formattable structures (#7492)

Akshay Agrawal256a52e9dcd1
diff --git a/frontend/src/components/editor/Output.tsx b/frontend/src/components/editor/Output.tsx
index 64bf1d7c2b..7c4ad4e74c 100644
--- a/frontend/src/components/editor/Output.tsx
+++ b/frontend/src/components/editor/Output.tsx
@@ -70,8 +70,16 @@ export const OutputRenderer: React.FC<{
onRefactorWithAI?: OnRefactorWithAI;
wrapText?: boolean;
metadata?: { width?: number; height?: number };
+ renderFallback?: (mimetype: OutputMessage["mimetype"]) => React.ReactNode;
}> = memo((props) => {
- const { message, onRefactorWithAI, cellId, wrapText, metadata } = props;
+ const {
+ message,
+ onRefactorWithAI,
+ cellId,
+ wrapText,
+ metadata,
+ renderFallback,
+ } = props;
const { theme } = useTheme();
// Memoize parsing the json data
@@ -231,6 +239,9 @@ export const OutputRenderer: React.FC<{
);
default:
logNever(mimetype);
+ if (renderFallback) {
+ return renderFallback(mimetype);
+ }
return (
<div className="text-destructive">Unsupported mimetype: {mimetype}</div>
);
diff --git a/frontend/src/components/editor/__tests__/Output.test.tsx b/frontend/src/components/editor/__tests__/Output.test.tsx
new file mode 100644
index 0000000000..da9341ca7b
--- /dev/null
+++ b/frontend/src/components/editor/__tests__/Output.test.tsx
@@ -0,0 +1,66 @@
+/* Copyright 2024 Marimo. All rights reserved. */
+import { render, screen } from "@testing-library/react";
+import { describe, expect, it } from "vitest";
+import { OutputRenderer } from "../Output";
+
+describe("OutputRenderer renderFallback prop", () => {
+ it("should use renderFallback for unsupported mimetypes", () => {
+ const renderFallback = (mimetype: string) => (
+ <div data-testid="custom-fallback">Custom fallback for {mimetype}</div>
+ );
+
+ render(
+ <OutputRenderer
+ message={{
+ channel: "output",
+ data: "some data",
+ // @ts-expect-error - Testing fallback behavior with unsupported mimetype
+ mimetype: "application/unsupported",
+ }}
+ renderFallback={renderFallback}
+ />,
+ );
+
+ expect(screen.getByTestId("custom-fallback")).toBeInTheDocument();
+ expect(screen.getByText(/Custom fallback for/)).toHaveTextContent(
+ "Custom fallback for application/unsupported",
+ );
+ });
+
+ it("should not use renderFallback for supported mimetypes", () => {
+ const renderFallback = () => (
+ <div data-testid="custom-fallback">Should not appear</div>
+ );
+
+ render(
+ <OutputRenderer
+ message={{
+ channel: "output",
+ data: "Hello World",
+ mimetype: "text/plain",
+ }}
+ renderFallback={renderFallback}
+ />,
+ );
+
+ expect(screen.queryByTestId("custom-fallback")).not.toBeInTheDocument();
+ expect(screen.getByText("Hello World")).toBeInTheDocument();
+ });
+
+ it("should show default error when renderFallback is not provided", () => {
+ render(
+ <OutputRenderer
+ message={{
+ channel: "output",
+ data: "some data",
+ // @ts-expect-error - Testing default error message with unsupported mimetype
+ mimetype: "application/unknown",
+ }}
+ />,
+ );
+
+ expect(
+ screen.getByText(/Unsupported mimetype: application\/unknown/),
+ ).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/components/editor/output/JsonOutput.tsx b/frontend/src/components/editor/output/JsonOutput.tsx
index 35a440a03c..0d90dc06ae 100644
--- a/frontend/src/components/editor/output/JsonOutput.tsx
+++ b/frontend/src/components/editor/output/JsonOutput.tsx
@@ -14,11 +14,13 @@ import {
} from "@textea/json-viewer";
import { CheckIcon, CopyIcon } from "lucide-react";
import { memo, useState } from "react";
+import type { OutputMessage } from "@/core/kernel/messages";
import { cn } from "@/utils/cn";
import { copyToClipboard } from "@/utils/copy";
import { isUrl } from "@/utils/urls";
import { useTheme } from "../../../theme/useTheme";
import { logNever } from "../../../utils/assertNever";
+import { OutputRenderer } from "../Output";
import { HtmlOutput } from "./HtmlOutput";
import { ImageOutput } from "./ImageOutput";
import { VideoOutput } from "./VideoOutput";
@@ -184,25 +186,51 @@ const CollapsibleTextOutput = (props: { text: string }) => {
);
};
+type LeafRenderer = (
+ data: string,
+ mimeType: OutputMessage["mimetype"],
+) => React.ReactNode;
+
/**
* Map from mimetype-prefix to render function.
*
* Render function takes leaf data as input.
*/
-const LEAF_RENDERERS = {
- "image/": (value: string) => <ImageOutput src={value} />,
- "video/": (value: string) => <VideoOutput src={value} />,
- "text/html:": (value: string) => (
+const LEAF_RENDERERS: Record<string, LeafRenderer> = {
+ "image/": (value) => <ImageOutput src={value} />,
+ "video/": (value) => <VideoOutput src={value} />,
+ "text/html:": (value) => (
<HtmlOutput html={value} inline={true} alwaysSanitizeHtml={false} />
),
- "text/markdown:": (value: string) => (
+ "text/markdown:": (value) => (
<HtmlOutput html={value} inline={true} alwaysSanitizeHtml={true} />
),
- "text/plain+float:": (value: string) => <span>{value}</span>,
- "text/plain+bigint:": (value: string) => <span>{value}</span>,
- "text/plain+set:": (value: string) => <span>set{value}</span>,
- "text/plain+tuple:": (value: string) => <span>{value}</span>,
- "text/plain:": (value: string) => <CollapsibleTextOutput text={value} />,
+ "text/plain+float:": (value) => <span>{value}</span>,
+ "text/plain+bigint:": (value) => <span>{value}</span>,
+ "text/plain+set:": (value) => <span>set{value}</span>,
+ "text/plain+tuple:": (value) => <span>{value}</span>,
+ "text/plain:": (value) => <CollapsibleTextOutput text={value} />,
+ "application/json:": (value) => (
+ <JsonOutput data={JSON.parse(value)} format="auto" />
+ ),
+ "application/": (value, mimeType) => {
+ return (
+ <OutputRenderer
+ message={{
+ channel: "output",
+ data: value,
+ mimetype: mimeType,
+ }}
+ // The fallback is just re-constructing the leaf and rendering it as a span
+ // This could be the case where mime-type parsing is a false positive
+ renderFallback={() => (
+ <span>
+ {mimeType}:{value}
+ </span>
+ )}
+ />
+ );
+ },
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -314,11 +342,20 @@ const JSON_VALUE_TYPES = [
].reverse();
function leafData(leaf: string): string {
+ return leafDataAndMimeType(leaf)[0];
+}
+
+function leafDataAndMimeType(
+ leaf: string,
+): [string, OutputMessage["mimetype"] | undefined] {
const delimIndex = leaf.indexOf(":");
if (delimIndex === -1) {
- return leaf;
+ return [leaf, undefined];
}
- return leaf.slice(delimIndex + 1);
+ return [
+ leaf.slice(delimIndex + 1),
+ leaf.slice(0, delimIndex) as OutputMessage["mimetype"],
+ ];
}
/**
@@ -330,12 +367,10 @@ function leafData(leaf: string): string {
*
* where mimetype cannot contain ":".
*/
-function renderLeaf(
- leaf: string,
- render: (data: string) => React.ReactNode,
-): React.ReactNode {
- if (leaf.includes(":")) {
- return render(leafData(leaf));
+function renderLeaf(leaf: string, render: LeafRenderer): React.ReactNode {
+ const [data, mimeType] = leafDataAndMimeType(leaf);
+ if (mimeType) {
+ return render(data, mimeType);
}
return <span>{leaf}</span>;
}
diff --git a/frontend/src/components/editor/output/__tests__/JsonOutput-mimetype.test.tsx b/frontend/src/components/editor/output/__tests__/JsonOutput-mimetype.test.tsx
new file mode 100644
index 0000000000..8250db6de6
--- /dev/null
+++ b/frontend/src/components/editor/output/__tests__/JsonOutput-mimetype.test.tsx
@@ -0,0 +1,42 @@
+/* Copyright 2024 Marimo. All rights reserved. */
+import { render } from "@testing-library/react";
+import { beforeAll, describe, expect, it, vi } from "vitest";
+import { JsonOutput } from "../JsonOutput";
+
+// Mock window.matchMedia for JsonViewer
+beforeAll(() => {
+ Object.defineProperty(window, "matchMedia", {
+ writable: true,
+ value: vi.fn().mockImplementation((query) => ({
+ matches: false,
+ media: query,
+ onchange: null,
+ addListener: vi.fn(),
+ removeListener: vi.fn(),
+ addEventListener: vi.fn(),
+ removeEventListener: vi.fn(),
+ dispatchEvent: vi.fn(),
+ })),
+ });
+});
+
+describe("JsonOutput with enhanced mimetype handling", () => {
+ it("should render data with various mimetypes without crashing", () => {
+ const data = {
+ text: "text/plain:Hello",
+ html: "text/html:<strong>Bold</strong>",
+ img: "image/png:data:image/png;base64,xyz...",
+ set: "text/plain+set:[1,2,3]",
+ tuple: "text/plain+tuple:[10,20]",
+ custom: "application/custom:data",
+ number: 42,
+ boolean: true,
+ };
+
+ const { container } = render(<JsonOutput data={data} format="auto" />);
+
+ // Verify component renders without crashing
+ expect(container).toBeInTheDocument();
+ expect(container.querySelector(".marimo-json-output")).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/components/editor/output/__tests__/json-output.test.ts b/frontend/src/components/editor/output/__tests__/json-output.test.ts
index d76a6e2afd..093ddf4263 100644
--- a/frontend/src/components/editor/output/__tests__/json-output.test.ts
+++ b/frontend/src/components/editor/output/__tests__/json-output.test.ts
@@ -310,3 +310,23 @@ describe("determineMaxDisplayLength", () => {
expect(result).toBe(5);
});
});
+
+describe("getCopyValue with application/ mimetypes", () => {
+ it("should strip application/ mimetype prefix from leaf data", () => {
+ expect(getCopyValue("application/json:{data}")).toBe('"{data}"');
+ expect(getCopyValue("application/custom:some-data")).toBe('"some-data"');
+ expect(getCopyValue("application/vnd.marimo+error:error")).toBe('"error"');
+ });
+
+ it("should handle application/ mimetypes in mixed objects", () => {
+ const value = {
+ appMime: "application/custom:data",
+ plainText: "text/plain:hello",
+ number: 42,
+ };
+ const result = getCopyValue(value);
+ expect(result).toContain('"appMime": "data"');
+ expect(result).toContain('"plainText": "hello"');
+ expect(result).toContain('"number": 42');
+ });
+});
diff --git a/marimo/_output/formatters/structures.py b/marimo/_output/formatters/structures.py
index c1b3f79aca..434af2a31e 100644
--- a/marimo/_output/formatters/structures.py
+++ b/marimo/_output/formatters/structures.py
@@ -16,12 +16,22 @@ from marimo._plugins.stateless.plain_text import plain_text
from marimo._utils.flatten import CyclicStructureError, flatten
+def is_structures_formatter(
+ formatter: formatting.Formatter[object] | None,
+) -> bool:
+ return formatter is formatting.get_formatter(tuple())
+
+
def _leaf_formatter(
value: object,
) -> bool | None | str | int:
formatter = formatting.get_formatter(value)
- if formatter is not None:
+
+ # Because we don't flatten subclasses of structures, we need to avoid
+ # recursing on structures in order to prevent infinite recursion.
+ if formatter is not None and not is_structures_formatter(formatter):
return ":".join(formatter(value))
+
if isinstance(value, bool):
return value
if isinstance(value, str):
@@ -55,7 +65,9 @@ def format_structure(
Returns a structure of the same shape as `t` with formatted
leaves.
"""
- flattened, repacker = flatten(t, json_compat_keys=True)
+ flattened, repacker = flatten(
+ t, json_compat_keys=True, flatten_formattable_subclasses=False
+ )
return repacker([_leaf_formatter(v) for v in flattened])
diff --git a/marimo/_smoke_tests/issues/2628_bar_container.py b/marimo/_smoke_tests/issues/2628_bar_container.py
new file mode 100644
index 0000000000..42fd6a3ee7
--- /dev/null
+++ b/marimo/_smoke_tests/issues/2628_bar_container.py
@@ -0,0 +1,43 @@
+import marimo
+
+__generated_with = "0.18.4"
+app = marimo.App(width="medium")
+
+
+def _():
+ import matplotlib.pyplot as plt
+ return (plt,)
+
+
+def _(plt):
+ import numpy as np
+
+ plt.hist(np.random.rand(1000), bins=10)
+ return
+
+
+def _():
+ import altair as alt
+
+ chart = (
+ alt.Chart(
+ alt.Data(
+ values=[
+ {"x": 1, "y": 5, "category": "A"},
+ {"x": 2, "y": 8, "category": "B"},
+ ]
+ )
+ )
+ .mark_circle(size=100)
+ .encode(x="x:Q", y="y:Q")
+ )
+
+ [chart, "application/foo:bar"]
+ return
+
+
+if __name__ == "__main__":
+ app.run()
diff --git a/marimo/_utils/flatten.py b/marimo/_utils/flatten.py
index f900fb90ae..1637ac8c68 100644
--- a/marimo/_utils/flatten.py
+++ b/marimo/_utils/flatten.py
@@ -28,7 +28,10 @@ def _is_leaf(obj: Any) -> bool:
def _flatten_sequence(
- value: list[Any] | tuple[Any, ...], json_compat_keys: bool, seen: set[int]
+ value: list[Any] | tuple[Any, ...],
+ json_compat_keys: bool,
+ seen: set[int],
+ flatten_formattable_subclasses: bool,
) -> FLATTEN_RET_TYPE:
"""Flatten a sequence of values"""
base_type: type[list[Any]] | type[tuple[Any, ...]]
@@ -75,7 +78,12 @@ def _flatten_sequence(
# is not a leaf
if i < len(value):
assert not _is_leaf(value[i])
- flattened, u = _flatten(value[i], json_compat_keys, seen)
+ flattened, u = _flatten(
+ value[i],
+ json_compat_keys,
+ seen,
+ flatten_formattable_subclasses=flatten_formattable_subclasses,
+ )
lengths.append(len(flattened))
flattened_pieces.append(flattened)
@@ -121,7 +129,10 @@ def _flatten_sequence(
def _flatten(
- value: Any, json_compat_keys: bool, seen: set[int]
+ value: Any,
+ json_compat_keys: bool,
+ seen: set[int],
+ flatten_formattable_subclasses: bool,
) -> FLATTEN_RET_TYPE:
# Track ids of structures to make sure that the tree has a finite height,
# ie, to make sure that no structure contains itself.
@@ -130,9 +141,25 @@ def _flatten(
if value_id in seen:
raise CyclicStructureError("already seen ", value)
+ from marimo._output.formatters.structures import is_structures_formatter
+ from marimo._output.formatting import get_formatter
+
+ if (
+ not flatten_formattable_subclasses
+ and isinstance(value, (tuple, list, dict))
+ and type(value) not in (tuple, list, dict)
+ and not is_structures_formatter(get_formatter(value))
+ ):
+ return [value], lambda x: x[0]
+
if isinstance(value, (tuple, list)):
seen.add(value_id)
- ret = _flatten_sequence(value, json_compat_keys, seen)
+ ret = _flatten_sequence(
+ value,
+ json_compat_keys,
+ seen,
+ flatten_formattable_subclasses=flatten_formattable_subclasses,
+ )
seen.remove(value_id)
return ret
elif isinstance(value, dict):
@@ -146,7 +173,7 @@ def _flatten(
keys = []
for k, v in value.items():
curr_flattened, curr_unflatten = _flatten(
- v, json_compat_keys, seen
+ v, json_compat_keys, seen, flatten_formattable_subclasses
)
flattened.append(curr_flattened)
unflatteners.append(curr_unflatten)
@@ -173,7 +200,11 @@ def _flatten(
return [value], lambda x: x[0]
-def flatten(value: Any, json_compat_keys: bool = False) -> FLATTEN_RET_TYPE:
+def flatten(
+ value: Any,
+ json_compat_keys: bool = False,
+ flatten_formattable_subclasses: bool = True,
+) -> FLATTEN_RET_TYPE:
"""Flatten a nested structure.
Returns the structure flattened and a repacking function.
@@ -197,6 +228,9 @@ def flatten(value: Any, json_compat_keys: bool = False) -> FLATTEN_RET_TYPE:
value: nested structure of lists, tuples, and dicts
json_compat_keys: if True, unflattener will stringify dict keys when
keys are not JSON compatible
+ flatten_formattable_subclasses: whether to flatten formattable values whose types are subclasses
+ of structure types and have a custom formatter (i.e., not using the default structures formatter),
+ or to leave them as is
Returns:
-------
@@ -207,7 +241,12 @@ def flatten(value: Any, json_compat_keys: bool = False) -> FLATTEN_RET_TYPE:
CyclicStructureError: If the structure has a cyclic nesting pattern,
such as a list that contains itself
"""
- flattened, u = _flatten(value, json_compat_keys, seen=set())
+ flattened, u = _flatten(
+ value,
+ json_compat_keys,
+ seen=set(),
+ flatten_formattable_subclasses=flatten_formattable_subclasses,
+ )
def unflatten_with_validation(vector: list[Any]) -> STRUCT_TYPE:
if type(vector) != list: # noqa: E721
diff --git a/tests/_output/formatters/test_structures.py b/tests/_output/formatters/test_structures.py
index ba5b1a9402..b75b328620 100644
--- a/tests/_output/formatters/test_structures.py
+++ b/tests/_output/formatters/test_structures.py
@@ -8,6 +8,7 @@ from marimo._dependencies.dependencies import DependencyManager
from marimo._output.formatters.structures import (
StructuresFormatter,
format_structure,
+ is_structures_formatter,
)
from marimo._output.formatting import get_formatter
from marimo._output.md import md
@@ -355,3 +356,12 @@ def test_function_like_objects_fallback_on_exception() -> None:
# which ultimately produces HTML; accept either to be robust.
assert isinstance(data, str)
assert len(data) > 0
+
+
+def test_is_structures_formatter() -> None:
+ assert is_structures_formatter(get_formatter(tuple()))
+ assert is_structures_formatter(get_formatter([]))
+ assert is_structures_formatter(get_formatter({1: 2}))
+
+ assert not is_structures_formatter(None)
+ assert not is_structures_formatter(get_formatter(set()))
diff --git a/tests/_server/templates/snapshots/export1.txt b/tests/_server/templates/snapshots/export1.txt
index bb5c5cc6be..723bb4b375 100644
--- a/tests/_server/templates/snapshots/export1.txt
+++ b/tests/_server/templates/snapshots/export1.txt
@@ -59,7 +59,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": false, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"view": {"showAppCode": true},
diff --git a/tests/_server/templates/snapshots/export2.txt b/tests/_server/templates/snapshots/export2.txt
index c7856051a4..7c986904a8 100644
--- a/tests/_server/templates/snapshots/export2.txt
+++ b/tests/_server/templates/snapshots/export2.txt
@@ -59,7 +59,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": false, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"view": {"showAppCode": true},
diff --git a/tests/_server/templates/snapshots/export3.txt b/tests/_server/templates/snapshots/export3.txt
index 46888e7f97..ca2f6bcb74 100644
--- a/tests/_server/templates/snapshots/export3.txt
+++ b/tests/_server/templates/snapshots/export3.txt
@@ -59,7 +59,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": false, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"view": {"showAppCode": true},
diff --git a/tests/_server/templates/snapshots/export4.txt b/tests/_server/templates/snapshots/export4.txt
index f47124c5ae..be3b6b8bdf 100644
--- a/tests/_server/templates/snapshots/export4.txt
+++ b/tests/_server/templates/snapshots/export4.txt
@@ -59,7 +59,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": false, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"css_file": "custom.css", "sql_output": "auto", "width": "compact"},
"view": {"showAppCode": true},
diff --git a/tests/_server/templates/snapshots/export5.txt b/tests/_server/templates/snapshots/export5.txt
index 2ce953b5d5..60b18e75ce 100644
--- a/tests/_server/templates/snapshots/export5.txt
+++ b/tests/_server/templates/snapshots/export5.txt
@@ -59,7 +59,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": false, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"app_title": "My App", "html_head_file": "head.html", "sql_output": "auto", "width": "compact"},
"view": {"showAppCode": true},
diff --git a/tests/_server/templates/snapshots/export6.txt b/tests/_server/templates/snapshots/export6.txt
index 640c7fc850..aaead29f54 100644
--- a/tests/_server/templates/snapshots/export6.txt
+++ b/tests/_server/templates/snapshots/export6.txt
@@ -59,7 +59,7 @@
"mode": "read",
"version": "0.0.0",
"serverToken": "token",
- "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "custom_css": ["custom1.css", "custom2.css"], "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": false, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
+ "config": {"ai": {"models": {"custom_models": [], "displayed_models": []}}, "completion": {"activate_on_typing": true, "copilot": false}, "diagnostics": {"sql_linter": true}, "display": {"cell_output": "below", "code_editor_font_size": 14, "custom_css": ["custom1.css", "custom2.css"], "dataframes": "rich", "default_table_max_columns": 50, "default_table_page_size": 10, "default_width": "medium", "reference_highlighting": true, "theme": "light"}, "formatting": {"line_length": 79}, "keymap": {"overrides": {}, "preset": "default"}, "language_servers": {"pylsp": {"enable_flake8": false, "enable_mypy": true, "enable_pydocstyle": false, "enable_pyflakes": false, "enable_pylint": false, "enable_ruff": true, "enabled": false}}, "mcp": {"mcpServers": {}, "presets": []}, "package_management": {"manager": "pixi"}, "runtime": {"auto_instantiate": false, "auto_reload": "off", "default_sql_output": "auto", "on_cell_change": "autorun", "output_max_bytes": 8000000, "reactive_tests": true, "std_stream_max_bytes": 1000000, "watcher_on_save": "lazy"}, "save": {"autosave": "after_delay", "autosave_delay": 1000, "format_on_save": false}, "server": {"browser": "default", "follow_symlink": false}, "snippets": {"custom_paths": [], "include_default_snippets": true}},
"configOverrides": {"formatting": {"line_length": 100}},
"appConfig": {"sql_output": "auto", "width": "compact"},
"view": {"showAppCode": true},
diff --git a/tests/_utils/test_flatten.py b/tests/_utils/test_flatten.py
index af71491533..b85798b4ce 100644
--- a/tests/_utils/test_flatten.py
+++ b/tests/_utils/test_flatten.py
@@ -6,6 +6,7 @@ from typing import Any
import pytest
+from marimo._output import formatting
from marimo._utils.flatten import (
CyclicStructureError,
contains_instance,
@@ -223,6 +224,74 @@ def test_flatten_custom_list() -> None:
assert u(v) == []
+def test_dont_flatten_subclass_list() -> None:
+ class CustomList(list): ...
+
+ @formatting.formatter(CustomList)
+ def format_custom_list(obj: Any) -> tuple[str, str]:
+ return ("text/plain", f"CustomList{list(obj)}")
+
+ mylist = CustomList()
+ mylist.extend([1, 2, 3])
+ v, u = flatten(mylist, flatten_formattable_subclasses=False)
+ assert v == [mylist]
+ assert u(v) == mylist
+
+
+def test_dont_flatten_subclass_tuple() -> None:
+ class CustomTuple(tuple): ...
+
+ @formatting.formatter(CustomTuple)
+ def format_custom_tuple(obj: Any) -> tuple[str, str]:
+ return ("text/plain", f"CustomList{list(obj)}")
+
+ mytuple = CustomTuple([1, 2, 3])
+ v, u = flatten(mytuple, flatten_formattable_subclasses=False)
+ assert v == [mytuple]
+ assert u(v) == mytuple
+
+
+def test_dont_flatten_subclass_dict() -> None:
+ class CustomDict(dict): ...
+
+ @formatting.formatter(CustomDict)
+ def format_custom_dict(obj: Any) -> tuple[str, str]:
+ return ("text/plain", f"CustomList{list(obj)}")
+
+ mydict = CustomDict({1: 2})
+ v, u = flatten(mydict, flatten_formattable_subclasses=False)
+ assert v == [mydict]
+ assert u(v) == mydict
+
+
+def test_flatten_subclass_list() -> None:
+ class CustomList(list): ...
+
+ mylist = CustomList()
+ mylist.extend([1, 2, 3])
+ v, u = flatten(mylist, flatten_formattable_subclasses=True)
+ assert v == [1, 2, 3]
+ assert u(v) == [1, 2, 3]
+
+
+def test_flatten_subclass_tuple() -> None:
+ class CustomTuple(tuple): ...
+
+ mytuple = CustomTuple([1, 2, 3])
+ v, u = flatten(mytuple, flatten_formattable_subclasses=True)
+ assert v == [1, 2, 3]
+ assert u(v) == (1, 2, 3)
+
+
+def test_flatten_subclass_dict() -> None:
+ class CustomDict(dict): ...
+
+ mydict = CustomDict({1: 2})
+ v, u = flatten(mydict, flatten_formattable_subclasses=True)
+ assert v == [2]
+ assert u(v) == {1: 2}
+
+
def test_contains_instance() -> None:
class A:
pass