Skip to content
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

feat: Catch use of 'polars' in to_string for non-Duration dtypes and raise an informative error #19977

Merged
merged 1 commit into from
Nov 25, 2024
Merged

feat: Catch use of 'polars' in to_string for non-Duration dtypes and raise an informative error #19977

Show file tree
Hide file tree
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
59 changes: 32 additions & 27 deletions crates/polars-core/src/chunked_array/temporal/conversion.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,33 +52,38 @@ pub(crate) fn naive_datetime_to_date(v: NaiveDateTime) -> i32 {
(datetime_to_timestamp_ms(v) / (MILLISECONDS * SECONDS_IN_DAY)) as i32
}

pub fn get_strftime_format(fmt: &str, dtype: &DataType) -> String {
if fmt != "iso" && fmt != "iso:strict" {
fmt.to_string()
pub fn get_strftime_format(fmt: &str, dtype: &DataType) -> PolarsResult<String> {
if fmt == "polars" && !matches!(dtype, DataType::Duration(_)) {
polars_bail!(InvalidOperation: "'polars' is not a valid `to_string` format for {} dtype expressions", dtype);
} else {
let sep = if fmt == "iso" { " " } else { "T" };
#[allow(unreachable_code)]
match dtype {
#[cfg(feature = "dtype-datetime")]
DataType::Datetime(tu, tz) => match (tu, tz.is_some()) {
(TimeUnit::Milliseconds, true) => format!("%F{}%T%.3f%:z", sep),
(TimeUnit::Milliseconds, false) => format!("%F{}%T%.3f", sep),
(TimeUnit::Microseconds, true) => format!("%F{}%T%.6f%:z", sep),
(TimeUnit::Microseconds, false) => format!("%F{}%T%.6f", sep),
(TimeUnit::Nanoseconds, true) => format!("%F{}%T%.9f%:z", sep),
(TimeUnit::Nanoseconds, false) => format!("%F{}%T%.9f", sep),
},
#[cfg(feature = "dtype-date")]
DataType::Date => "%F".to_string(),
#[cfg(feature = "dtype-time")]
DataType::Time => "%T%.f".to_string(),
_ => {
let err = format!(
"invalid call to `get_strftime_format`; fmt={:?}, dtype={}",
fmt, dtype
);
unimplemented!("{}", err)
},
}
let format_string = if fmt != "iso" && fmt != "iso:strict" {
fmt.to_string()
} else {
let sep = if fmt == "iso" { " " } else { "T" };
#[allow(unreachable_code)]
match dtype {
#[cfg(feature = "dtype-datetime")]
DataType::Datetime(tu, tz) => match (tu, tz.is_some()) {
(TimeUnit::Milliseconds, true) => format!("%F{}%T%.3f%:z", sep),
(TimeUnit::Milliseconds, false) => format!("%F{}%T%.3f", sep),
(TimeUnit::Microseconds, true) => format!("%F{}%T%.6f%:z", sep),
(TimeUnit::Microseconds, false) => format!("%F{}%T%.6f", sep),
(TimeUnit::Nanoseconds, true) => format!("%F{}%T%.9f%:z", sep),
(TimeUnit::Nanoseconds, false) => format!("%F{}%T%.9f", sep),
},
#[cfg(feature = "dtype-date")]
DataType::Date => "%F".to_string(),
#[cfg(feature = "dtype-time")]
DataType::Time => "%T%.f".to_string(),
_ => {
let err = format!(
"invalid call to `get_strftime_format`; fmt={:?}, dtype={}",
fmt, dtype
);
unimplemented!("{}", err)
},
}
};
Ok(format_string)
}
}
2 changes: 1 addition & 1 deletion crates/polars-core/src/chunked_array/temporal/datetime.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ impl DatetimeChunked {
TimeUnit::Microseconds => timestamp_us_to_datetime,
TimeUnit::Milliseconds => timestamp_ms_to_datetime,
};
let format = get_strftime_format(format, self.dtype());
let format = get_strftime_format(format, self.dtype())?;
let mut ca: StringChunked = match self.time_zone() {
#[cfg(feature = "timezones")]
Some(time_zone) => {
Expand Down
6 changes: 3 additions & 3 deletions crates/polars-time/src/series/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,19 +258,19 @@ pub trait TemporalMethods: AsSeries {
match s.dtype() {
#[cfg(feature = "dtype-datetime")]
DataType::Datetime(_, _) => {
let format = get_strftime_format(format, s.dtype());
let format = get_strftime_format(format, s.dtype())?;
s.datetime()
.map(|ca| Ok(ca.to_string(format.as_str())?.into_series()))?
},
#[cfg(feature = "dtype-date")]
DataType::Date => {
let format = get_strftime_format(format, s.dtype());
let format = get_strftime_format(format, s.dtype())?;
s.date()
.map(|ca| Ok(ca.to_string(format.as_str())?.into_series()))?
},
#[cfg(feature = "dtype-time")]
DataType::Time => {
let format = get_strftime_format(format, s.dtype());
let format = get_strftime_format(format, s.dtype())?;
s.time()
.map(|ca| ca.to_string(format.as_str()).into_series())
},
Expand Down
9 changes: 9 additions & 0 deletions py-polars/tests/unit/datatypes/test_temporal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1192,6 +1192,15 @@ def test_temporal_to_string_iso_default() -> None:
}


def test_temporal_to_string_error() -> None:
df = pl.DataFrame({"td": [timedelta(days=1)], "dt": [date(2024, 11, 25)]})
with pytest.raises(
InvalidOperationError,
match="'polars' is not a valid `to_string` format for date dtype expressions",
):
df.select(cs.temporal().dt.to_string("polars"))


def test_iso_year() -> None:
assert pl.Series([datetime(2022, 1, 1, 7, 8, 40)]).dt.iso_year()[0] == 2021
assert pl.Series([date(2022, 1, 1)]).dt.iso_year()[0] == 2021
Expand Down