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.

fix(media): support pathlib.Path in mo.video and mo.audio (#11262)

Rajveer Singhbc0e3567671d
diff --git a/marimo/_plugins/stateless/audio.py b/marimo/_plugins/stateless/audio.py
index 3932dcbd0f..d0f32c51fd 100644
--- a/marimo/_plugins/stateless/audio.py
+++ b/marimo/_plugins/stateless/audio.py
@@ -4,6 +4,7 @@ from __future__ import annotations
import io
import os
import wave
+from pathlib import Path
from typing import TYPE_CHECKING, Any
import marimo._output.data.data as mo_data
@@ -57,7 +58,7 @@ def convert_numpy_to_wav(
def get_resolved_src(
- src: str | io.BytesIO | NDArray[Any],
+ src: str | bytes | io.BytesIO | io.BufferedReader | Path | NDArray[Any],
rate: int | None,
normalize: bool,
) -> str | None:
@@ -73,6 +74,13 @@ def get_resolved_src(
if isinstance(src, bytes):
return mo_data.audio(src).url
+ if isinstance(src, Path):
+ expanded = src.expanduser()
+ if expanded.is_file():
+ ext = expanded.suffix or ".wav"
+ return mo_data.audio(expanded.read_bytes(), ext=ext).url
+ return src.as_posix()
+
if isinstance(src, str) and os.path.isfile(os.path.expanduser(src)):
src = os.path.expanduser(src)
with open(src, "rb") as f:
@@ -94,7 +102,7 @@ def get_resolved_src(
@mddoc
def audio(
- src: str | io.BytesIO | NDArray[Any],
+ src: str | bytes | io.BytesIO | io.BufferedReader | Path | NDArray[Any],
rate: int | None = None,
normalize: bool = True,
) -> Html:
diff --git a/marimo/_plugins/stateless/video.py b/marimo/_plugins/stateless/video.py
index f04ae04bdd..960c48dd2f 100644
--- a/marimo/_plugins/stateless/video.py
+++ b/marimo/_plugins/stateless/video.py
@@ -3,6 +3,7 @@ from __future__ import annotations
import io
import os
+from pathlib import Path
import marimo._output.data.data as mo_data
from marimo._output.builder import h
@@ -13,7 +14,7 @@ from marimo._plugins.core.media import io_to_data_url
def _get_resolved_src(
- src: str | bytes | io.BytesIO | io.BufferedReader,
+ src: str | bytes | io.BytesIO | io.BufferedReader | Path,
) -> str | None:
"""Determine the correct URL for the given video source.
@@ -32,11 +33,18 @@ def _get_resolved_src(
if isinstance(src, bytes):
return mo_data.video(src).url
+ if isinstance(src, Path):
+ expanded = src.expanduser()
+ if expanded.is_file():
+ ext = expanded.suffix or ".mp4"
+ return mo_data.video(expanded.read_bytes(), ext=ext).url
+ return src.as_posix()
+
if isinstance(src, str):
- expanded = os.path.expanduser(src)
- if os.path.isfile(expanded):
- with open(expanded, "rb") as f:
- ext = os.path.splitext(expanded)[1] or ".mp4"
+ expanded_str = os.path.expanduser(src)
+ if os.path.isfile(expanded_str):
+ with open(expanded_str, "rb") as f:
+ ext = os.path.splitext(expanded_str)[1] or ".mp4"
return mo_data.video(f.read(), ext=ext).url
return io_to_data_url(src, fallback_mime_type="video/mp4")
@@ -44,7 +52,7 @@ def _get_resolved_src(
@mddoc
def video(
- src: str | bytes | io.BytesIO | io.BufferedReader,
+ src: str | bytes | io.BytesIO | io.BufferedReader | Path,
controls: bool = True,
muted: bool = False,
autoplay: bool = False,
diff --git a/tests/_plugins/stateless/test_audio.py b/tests/_plugins/stateless/test_audio.py
index ed3dc73650..7ef2d493a7 100644
--- a/tests/_plugins/stateless/test_audio.py
+++ b/tests/_plugins/stateless/test_audio.py
@@ -6,6 +6,7 @@ import io
import sys
import wave
from html.parser import HTMLParser
+from pathlib import Path
import pytest
@@ -26,6 +27,13 @@ async def test_audio_url() -> None:
)
+async def test_audio_pathlib_nonexistent_passthrough() -> None:
+ src = Path("public/__marimo_test_does_not_exist__.wav")
+ result = audio(src)
+ assert f"src='{src.as_posix()}'" in result.text
+ assert "data:" not in result.text
+
+
async def test_audio_filename(k: Kernel, exec_req: ExecReqProvider) -> None:
await k.run(
[
@@ -47,6 +55,119 @@ async def test_audio_filename(k: Kernel, exec_req: ExecReqProvider) -> None:
assert fname.endswith(".wav")
+async def test_audio_pathlib_path(
+ k: Kernel, exec_req: ExecReqProvider
+) -> None:
+ await k.run(
+ [
+ exec_req.get(
+ """
+ from pathlib import Path
+ import marimo as mo
+ import os
+ with open("test_audio.wav", "wb") as f:
+ f.write(b"hello")
+ audio = mo.audio(Path("test_audio.wav"))
+ os.remove("test_audio.wav")
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(".wav")
+
+
+ ("filename", "expected_ext"),
+ [
+ ("test_audio.mp3", ".mp3"),
+ ("test_audio_no_ext", ".wav"),
+ ],
+)
+async def test_audio_pathlib_variations(
+ k: Kernel,
+ exec_req: ExecReqProvider,
+ filename: str,
+ expected_ext: str,
+) -> None:
+ await k.run(
+ [
+ exec_req.get(
+ f"""
+ from pathlib import Path
+ import marimo as mo
+ import os
+ with open("{filename}", "wb") as f:
+ f.write(b"hello")
+ audio = mo.audio(Path("{filename}"))
+ os.remove("{filename}")
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(expected_ext)
+
+
+async def test_audio_pathlib_home_expansion(
+ k: Kernel,
+ exec_req: ExecReqProvider,
+ monkeypatch: pytest.MonkeyPatch,
+ tmp_path: Path,
+) -> None:
+ fake_home = tmp_path / "fake_home"
+ fake_home.mkdir()
+ sample = fake_home / "sample.wav"
+ sample.write_bytes(b"hello")
+ monkeypatch.setenv("HOME", str(fake_home))
+ monkeypatch.setenv("USERPROFILE", str(fake_home))
+ await k.run(
+ [
+ exec_req.get(
+ """
+ from pathlib import Path
+ import marimo as mo
+ audio = mo.audio(Path("~/sample.wav"))
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(".wav")
+
+
+async def test_audio_pathlib_real_media(
+ k: Kernel, exec_req: ExecReqProvider, tmp_path: Path
+) -> None:
+ real_wav = tmp_path / "real_audio.wav"
+ with wave.open(str(real_wav), "wb") as w:
+ w.setnchannels(1)
+ w.setsampwidth(2)
+ w.setframerate(44100)
+ w.writeframes(b"\x00\x00" * 100)
+
+ await k.run(
+ [
+ exec_req.get(
+ f"""
+ from pathlib import Path
+ import marimo as mo
+ audio = mo.audio(Path(r"{real_wav.as_posix()}"))
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(".wav")
+ audio_html = k.globals["audio"]
+ assert "data:" not in audio_html.text
+ assert "@file/" in audio_html.text
+
+
async def test_audio_bytes_io(k: Kernel, exec_req: ExecReqProvider) -> None:
await k.run(
[
diff --git a/tests/_plugins/stateless/test_video.py b/tests/_plugins/stateless/test_video.py
index 4aa2d92514..c9647ba333 100644
--- a/tests/_plugins/stateless/test_video.py
+++ b/tests/_plugins/stateless/test_video.py
@@ -1,6 +1,10 @@
# Copyright 2026 Marimo. All rights reserved.
from __future__ import annotations
+from pathlib import Path
+
+import pytest
+
from marimo._plugins.stateless.video import video
from marimo._runtime.context import get_context
from marimo._runtime.runtime import Kernel
@@ -23,6 +27,13 @@ async def test_video_nonexistent_path_passthrough() -> None:
assert "data:" not in result.text
+async def test_video_pathlib_nonexistent_passthrough() -> None:
+ src = Path("public/__marimo_test_does_not_exist__.mp4")
+ result = video(src)
+ assert f"src='{src.as_posix()}'" in result.text
+ assert "data:" not in result.text
+
+
async def test_video_bytes(k: Kernel, exec_req: ExecReqProvider) -> None:
await k.run(
[
@@ -82,3 +93,122 @@ async def test_video_local_file(k: Kernel, exec_req: ExecReqProvider) -> None:
video_html = k.globals["video"]
assert "data:" not in video_html.text
assert "@file/" in video_html.text
+
+
+async def test_video_pathlib_path(
+ k: Kernel, exec_req: ExecReqProvider
+) -> None:
+ await k.run(
+ [
+ exec_req.get(
+ """
+ import os
+ from pathlib import Path
+ import marimo as mo
+ with open("test_video.mp4", "wb") as f:
+ f.write(b"fake video bytes")
+ video = mo.video(Path("test_video.mp4"))
+ os.remove("test_video.mp4")
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(".mp4")
+ video_html = k.globals["video"]
+ assert "data:" not in video_html.text
+ assert "@file/" in video_html.text
+
+
+ ("filename", "expected_ext"),
+ [
+ ("test_video.webm", ".webm"),
+ ("test_video_no_ext", ".mp4"),
+ ],
+)
+async def test_video_pathlib_variations(
+ k: Kernel,
+ exec_req: ExecReqProvider,
+ filename: str,
+ expected_ext: str,
+) -> None:
+ await k.run(
+ [
+ exec_req.get(
+ f"""
+ import os
+ from pathlib import Path
+ import marimo as mo
+ with open("{filename}", "wb") as f:
+ f.write(b"fake video bytes")
+ video = mo.video(Path("{filename}"))
+ os.remove("{filename}")
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(expected_ext)
+ video_html = k.globals["video"]
+ assert "data:" not in video_html.text
+ assert "@file/" in video_html.text
+
+
+async def test_video_pathlib_home_expansion(
+ k: Kernel,
+ exec_req: ExecReqProvider,
+ monkeypatch: pytest.MonkeyPatch,
+ tmp_path: Path,
+) -> None:
+ fake_home = tmp_path / "fake_home"
+ fake_home.mkdir()
+ sample = fake_home / "sample.mp4"
+ sample.write_bytes(b"fake video bytes")
+ monkeypatch.setenv("HOME", str(fake_home))
+ monkeypatch.setenv("USERPROFILE", str(fake_home))
+ await k.run(
+ [
+ exec_req.get(
+ """
+ from pathlib import Path
+ import marimo as mo
+ video = mo.video(Path("~/sample.mp4"))
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(".mp4")
+ video_html = k.globals["video"]
+ assert "data:" not in video_html.text
+ assert "@file/" in video_html.text
+
+
+async def test_video_pathlib_real_media(
+ k: Kernel, exec_req: ExecReqProvider, tmp_path: Path
+) -> None:
+ real_video = tmp_path / "real_video.mp4"
+ real_video.write_bytes(
+ b"\x00\x00\x00\x1cftypisom\x00\x00\x02\x00isomiso2mp41\x00\x00\x00\x08free"
+ )
+ await k.run(
+ [
+ exec_req.get(
+ f"""
+ from pathlib import Path
+ import marimo as mo
+ video = mo.video(Path(r"{real_video.as_posix()}"))
+ """
+ ),
+ ]
+ )
+ assert len(get_context().virtual_file_registry.registry) == 1
+ for fname in get_context().virtual_file_registry.registry:
+ assert fname.endswith(".mp4")
+ video_html = k.globals["video"]
+ assert "data:" not in video_html.text
+ assert "@file/" in video_html.text