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: normalize datetime inputs in date widgets (#11289)

Myles Scolnick56358a9652ff
diff --git a/marimo/_plugins/ui/_impl/dates.py b/marimo/_plugins/ui/_impl/dates.py
index 95eb4c18ec..d43d0f941e 100644
--- a/marimo/_plugins/ui/_impl/dates.py
+++ b/marimo/_plugins/ui/_impl/dates.py
@@ -31,6 +31,8 @@ Numeric = int | float
class date(UIElement[str, dt.date]):
"""A date picker with an optional start and stop date.
+ Datetime inputs for `start`, `stop`, and `value` use only their date portion.
+
Examples:
```python
# initialize the date picker at a given date
@@ -90,11 +92,11 @@ class date(UIElement[str, dt.date]):
full_width: bool = False,
disabled: bool = False,
) -> None:
- if isinstance(start, str):
+ if start is not None:
start = self._convert_value(start)
- if isinstance(stop, str):
+ if stop is not None:
stop = self._convert_value(stop)
- if isinstance(value, str):
+ if value is not None:
value = self._convert_value(value)
if value is None:
@@ -152,12 +154,12 @@ class date(UIElement[str, dt.date]):
label = kwargs.pop("label", info.label)
return date(start=start, stop=stop, label=label, **kwargs)
- def _convert_value(self, value: str) -> dt.date:
+ def _convert_value(self, value: str | dt.date) -> dt.date:
# Catch different initialization formats
- if isinstance(value, dt.date):
- return value
if isinstance(value, dt.datetime):
return value.date()
+ if isinstance(value, dt.date):
+ return value
# This is date-only input; preserve `strptime`'s accepted formats.
return dt.datetime.strptime( # noqa: DTZ007
value, self.DATE_FORMAT
@@ -349,6 +351,8 @@ class datetime(UIElement[str | None, dt.datetime | None]):
class date_range(UIElement[tuple[str, str], tuple[dt.date, dt.date]]):
"""A date range picker over an interval.
+ Datetime inputs for `start`, `stop`, and `value` use only their date portion.
+
Examples:
```python
date_range = mo.ui.date_range(
@@ -395,9 +399,9 @@ class date_range(UIElement[tuple[str, str], tuple[dt.date, dt.date]]):
full_width: bool = False,
disabled: bool = False,
):
- if isinstance(start, str):
+ if start is not None:
start = self._convert_single_value(start)
- if isinstance(stop, str):
+ if stop is not None:
stop = self._convert_single_value(stop)
if value is not None:
value = self._convert_value(value)
@@ -472,10 +476,10 @@ class date_range(UIElement[tuple[str, str], tuple[dt.date, dt.date]]):
)
def _convert_single_value(self, value: str | dt.date) -> dt.date:
- if isinstance(value, dt.date):
- return value
if isinstance(value, dt.datetime):
return value.date()
+ if isinstance(value, dt.date):
+ return value
# This is date-only input; preserve `strptime`'s accepted formats.
return dt.datetime.strptime( # noqa: DTZ007
value, self.DATEFORMAT
diff --git a/tests/_plugins/ui/_impl/test_dates.py b/tests/_plugins/ui/_impl/test_dates.py
index 66967dcf14..2b17d0dd12 100644
--- a/tests/_plugins/ui/_impl/test_dates.py
+++ b/tests/_plugins/ui/_impl/test_dates.py
@@ -12,6 +12,104 @@ from marimo._plugins import ui
HAS_PANDAS = DependencyManager.pandas.has()
[email protected]("widget", [ui.date, ui.date_range])
+ ("start", "stop"),
+ [
+ (datetime.datetime(2024, 1, 1, 12), None),
+ (None, datetime.datetime(2024, 1, 31, 12)),
+ (
+ datetime.datetime(2024, 1, 1, 12),
+ datetime.datetime(2024, 1, 31, 12),
+ ),
+ (datetime.datetime(2024, 1, 1, 12), datetime.date(2024, 1, 31)),
+ ("2024-01-01", datetime.datetime(2024, 1, 31, 12)),
+ ],
+)
+def test_date_datetime_bounds(widget, start, stop) -> None:
+ picker = widget(start=start, stop=stop)
+ first = datetime.date(2024, 1, 1)
+ last = datetime.date(2024, 1, 31)
+ assert (picker.start, picker.stop) == (
+ first if start is not None else datetime.date.min,
+ last if stop is not None else datetime.date.max,
+ )
+ if widget is ui.date:
+ assert picker.value == (first if start is not None else last)
+ else:
+ assert picker.value == (
+ first if start is not None else last,
+ last if stop is not None else first,
+ )
+ assert picker._args.args == {
+ "start": first.isoformat() if start is not None else "0001-01-01",
+ "stop": last.isoformat() if stop is not None else "9999-12-31",
+ "full-width": False,
+ "disabled": False,
+ }
+
+
[email protected]("widget", [ui.date, ui.date_range])
+ "value",
+ [
+ datetime.datetime(2024, 1, 1, 12),
+ datetime.datetime(
+ 2024,
+ 1,
+ 1,
+ 23,
+ tzinfo=datetime.timezone(datetime.timedelta(hours=-8)),
+ ),
+ ],
+)
+def test_date_datetime_value(widget, value) -> None:
+ expected = datetime.date(2024, 1, 1)
+ picker = widget(value=value if widget is ui.date else (value, value))
+ assert picker.value == (
+ expected if widget is ui.date else (expected, expected)
+ )
+
+ # Bounds and values are compared by date, regardless of time of day.
+ picker = widget(
+ start=datetime.datetime(2024, 1, 1, 18),
+ stop=datetime.datetime(2024, 1, 1, 6),
+ value=value if widget is ui.date else (value, value),
+ )
+ assert picker.value == (
+ expected if widget is ui.date else (expected, expected)
+ )
+
+ with pytest.raises(ValueError, match="The default value"):
+ widget(
+ start="2024-01-02",
+ value=value if widget is ui.date else (value, value),
+ )
+
+
[email protected](not HAS_PANDAS, reason="pandas not installed")
[email protected]("widget", [ui.date, ui.date_range])
+def test_date_pandas_timestamps(widget) -> None:
+ import pandas as pd
+
+ series = pd.Series(
+ [pd.Timestamp("2024-01-01 12:00"), pd.Timestamp("2024-01-31 18:00")]
+ )
+ first, last = datetime.date(2024, 1, 1), datetime.date(2024, 1, 31)
+ picker = widget(start=series.min(), stop=series.max())
+ assert (picker.start, picker.stop, picker.value) == (
+ first,
+ last,
+ first if widget is ui.date else (first, last),
+ )
+ picker = widget(
+ value=series.max()
+ if widget is ui.date
+ else (series.min(), series.max())
+ )
+ assert picker.value == (last if widget is ui.date else (first, last))
+
+
def test_date() -> None:
date = ui.date()
today = date.value