Skip to content

add mime_type to download #5957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adhami3310 merged 1 commit into from
Nov 6, 2025
+13 −4
Merged

add mime_type to download #5957

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions reflex/event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
import inspect
import sys
import types
import urllib.parse
from base64 import b64encode
from collections.abc import Callable, Mapping, Sequence
from functools import lru_cache, partial
Expand Down Expand Up @@ -1230,13 +1229,15 @@ def download(
url: str | Var | None = None,
filename: str | Var | None = None,
data: str | bytes | Var | None = None,
mime_type: str | Var | None = None,
) -> EventSpec:
"""Download the file at a given path or with the specified data.

Args:
url: The URL to the file to download.
filename: The name that the file should be saved as after download.
data: The data to download.
mime_type: The mime type of the data to download.

Raises:
ValueError: If the URL provided is invalid, both URL and data are provided,
Expand Down Expand Up @@ -1265,9 +1266,15 @@ def download(
raise ValueError(msg)

if isinstance(data, str):
if mime_type is None:
mime_type = "text/plain"
# Caller provided a plain text string to download.
url = "data:text/plain," + urllib.parse.quote(data)
url = f"data:{mime_type};base64," + b64encode(data.encode("utf-8")).decode(
"utf-8"
)
elif isinstance(data, Var):
if mime_type is None:
mime_type = "text/plain"
# Need to check on the frontend if the Var already looks like a data: URI.

is_data_url = (data.js_type() == "string") & (
Expand All @@ -1278,12 +1285,14 @@ def download(
url = cond(
is_data_url,
data.to(str),
"data:text/plain," + data.to_string(),
f"data:{mime_type}," + data.to_string(),
)
elif isinstance(data, bytes):
if mime_type is None:
mime_type = "application/octet-stream"
# Caller provided bytes, so base64 encode it as a data: URI.
b64_data = b64encode(data).decode("utf-8")
url = "data:application/octet-stream;base64," + b64_data
url = f"data:{mime_type};base64," + b64_data
else:
msg = f"Invalid data type {type(data)} for download. Use `str` or `bytes`."
raise ValueError(msg)
Expand Down
Loading