Skip to content

feat: dataframe download separator#8318

Open
vavavavavavavavava wants to merge 3 commits intomarimo-team:mainfrom
vavavavavavavavava:feat/dataframe-download-separator
Open

feat: dataframe download separator#8318
vavavavavavavavava wants to merge 3 commits intomarimo-team:mainfrom
vavavavavavavavava:feat/dataframe-download-separator

Conversation

@vavavavavavavavava
Copy link
Contributor

📝 Summary

Add configurable CSV separator support to dataframe downloads, with consistent behavior across table backends.
Closes #7353

🔍 Description of Changes

This PR adds download_csv_separator to mo.ui.dataframe(...) and threads it through the full CSV download path so user-provided separators are respected end-to-end.

What changed

  • Added new dataframe option:
    • download_csv_separator: str | None = None
  • Propagated separator through:
    • dataframe download handler
    • download_as(...)
    • TableManager.to_csv(...) / to_csv_str(...)
    • backend table managers (default / narwhals / pandas / polars)

Backend behavior

  • pandas: passes separator to DataFrame.to_csv(sep=...)
  • polars: passes separator to write_csv(separator=...) (including fallback conversion path)
  • narwhals utility:
    • keeps native write_csv() for default comma
    • uses Python csv.writer for non-comma separators to avoid backend-specific inconsistency
  • default table manager: forwards separator to delegated manager

Why

write_csv(separator=...) is not consistently reliable across all narwhals-backed dataframe combinations.
This change makes non-comma CSV output predictable while preserving existing default behavior.

Backward compatibility

  • Default behavior is unchanged (comma-separated CSV).
  • Existing callers continue to work without modification.
  • New behavior is opt-in via download_csv_separator.

Example

import marimo as mo
import pandas as pd

df = pd.DataFrame({"name": ["Alice", "Bob"], "value": [1, 2]})

# Before: default download behavior
mo.ui.dataframe(df, show_download=True)

# After: configurable CSV encoding / separator and JSON escaping
mo.ui.dataframe(
    df,
    show_download=True,
    download_csv_separator=";",
)

Tests

Added/updated tests for:

  • dataframe CSV download with custom separator
  • dataframe_to_csv(..., separator=";") behavior across dataframe backends

📋 Checklist

@vercel
Copy link

vercel bot commented Feb 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
marimo-docs Ready Ready Preview, Comment Feb 14, 2026 2:47pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature request: Allow configuring encoding for mo.ui.dataframe() download button

1 participant