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

Jump to bottom

feature gate deprecated APIs for datetime types #4111

Merged
merged 1 commit into from
Apr 24, 2024
Merged

feature gate deprecated APIs for datetime types #4111

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
145 changes: 63 additions & 82 deletions src/types/datetime.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,12 +173,10 @@ pub trait PyTimeAccess {
/// Trait for accessing the components of a struct containing a tzinfo.
pub trait PyTzInfoAccess<'py> {
/// Deprecated form of `get_tzinfo_bound`.
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`get_tzinfo` will be replaced by `get_tzinfo_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`get_tzinfo` will be replaced by `get_tzinfo_bound` in a future PyO3 version"
)]
fn get_tzinfo(&self) -> Option<&'py PyTzInfo> {
self.get_tzinfo_bound().map(Bound::into_gil_ref)
Expand All @@ -205,12 +203,10 @@ pyobject_native_type!(

impl PyDate {
/// Deprecated form of [`PyDate::new_bound`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyDate::new` will be replaced by `PyDate::new_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyDate::new` will be replaced by `PyDate::new_bound` in a future PyO3 version"
)]
pub fn new(py: Python<'_>, year: i32, month: u8, day: u8) -> PyResult<&PyDate> {
Self::new_bound(py, year, month, day).map(Bound::into_gil_ref)
Expand All @@ -227,12 +223,10 @@ impl PyDate {
}

/// Deprecated form of [`PyDate::from_timestamp_bound`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyDate::from_timestamp` will be replaced by `PyDate::from_timestamp_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyDate::from_timestamp` will be replaced by `PyDate::from_timestamp_bound` in a future PyO3 version"
)]
pub fn from_timestamp(py: Python<'_>, timestamp: i64) -> PyResult<&PyDate> {
Self::from_timestamp_bound(py, timestamp).map(Bound::into_gil_ref)
Expand Down Expand Up @@ -296,12 +290,10 @@ pyobject_native_type!(

impl PyDateTime {
/// Deprecated form of [`PyDateTime::new_bound`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyDateTime::new` will be replaced by `PyDateTime::new_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyDateTime::new` will be replaced by `PyDateTime::new_bound` in a future PyO3 version"
)]
#[allow(clippy::too_many_arguments)]
pub fn new<'py>(
Expand Down Expand Up @@ -361,12 +353,10 @@ impl PyDateTime {
}

/// Deprecated form of [`PyDateTime::new_bound_with_fold`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyDateTime::new_with_fold` will be replaced by `PyDateTime::new_bound_with_fold` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyDateTime::new_with_fold` will be replaced by `PyDateTime::new_bound_with_fold` in a future PyO3 version"
)]
#[allow(clippy::too_many_arguments)]
pub fn new_with_fold<'py>(
Expand Down Expand Up @@ -436,12 +426,10 @@ impl PyDateTime {
}

/// Deprecated form of [`PyDateTime::from_timestamp_bound`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyDateTime::from_timestamp` will be replaced by `PyDateTime::from_timestamp_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyDateTime::from_timestamp` will be replaced by `PyDateTime::from_timestamp_bound` in a future PyO3 version"
)]
pub fn from_timestamp<'py>(
py: Python<'py>,
Expand Down Expand Up @@ -598,12 +586,10 @@ pyobject_native_type!(

impl PyTime {
/// Deprecated form of [`PyTime::new_bound`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyTime::new` will be replaced by `PyTime::new_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyTime::new` will be replaced by `PyTime::new_bound` in a future PyO3 version"
)]
pub fn new<'py>(
py: Python<'py>,
Expand Down Expand Up @@ -649,12 +635,10 @@ impl PyTime {
}

/// Deprecated form of [`PyTime::new_bound_with_fold`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyTime::new_with_fold` will be replaced by `PyTime::new_bound_with_fold` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyTime::new_with_fold` will be replaced by `PyTime::new_bound_with_fold` in a future PyO3 version"
)]
pub fn new_with_fold<'py>(
py: Python<'py>,
Expand All @@ -677,7 +661,7 @@ impl PyTime {
.map(Bound::into_gil_ref)
}

/// Alternate constructor that takes a `fold` argument. See [`PyDateTime::new_with_fold`].
/// Alternate constructor that takes a `fold` argument. See [`PyDateTime::new_bound_with_fold`].
pub fn new_bound_with_fold<'py>(
py: Python<'py>,
hour: u8,
Expand Down Expand Up @@ -791,7 +775,7 @@ impl<'py> PyTzInfoAccess<'py> for Bound<'py, PyTime> {
/// Bindings for `datetime.tzinfo`.
///
/// This is an abstract base class and cannot be constructed directly.
/// For concrete time zone implementations, see [`timezone_utc`] and
/// For concrete time zone implementations, see [`timezone_utc_bound`] and
/// the [`zoneinfo` module](https://docs.python.org/3/library/zoneinfo.html).
#[repr(transparent)]
pub struct PyTzInfo(PyAny);
Expand All @@ -804,12 +788,10 @@ pyobject_native_type!(
);

/// Deprecated form of [`timezone_utc_bound`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`timezone_utc` will be replaced by `timezone_utc_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`timezone_utc` will be replaced by `timezone_utc_bound` in a future PyO3 version"
)]
pub fn timezone_utc(py: Python<'_>) -> &PyTzInfo {
timezone_utc_bound(py).into_gil_ref()
Expand Down Expand Up @@ -858,12 +840,10 @@ pyobject_native_type!(

impl PyDelta {
/// Deprecated form of [`PyDelta::new_bound`].
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyDelta::new` will be replaced by `PyDelta::new_bound` in a future PyO3 version"
)
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyDelta::new` will be replaced by `PyDelta::new_bound` in a future PyO3 version"
)]
pub fn new(
py: Python<'_>,
Expand Down Expand Up @@ -936,7 +916,6 @@ fn opt_to_pyobj(opt: Option<&Bound<'_, PyTzInfo>>) -> *mut ffi::PyObject {
}

#[cfg(test)]
#[cfg_attr(not(feature = "gil-refs"), allow(deprecated))]
mod tests {
use super::*;
#[cfg(feature = "macros")]
Expand All @@ -947,14 +926,15 @@ mod tests {
#[cfg_attr(target_arch = "wasm32", ignore)] // DateTime import fails on wasm for mysterious reasons
fn test_datetime_fromtimestamp() {
Python::with_gil(|py| {
let dt = PyDateTime::from_timestamp(py, 100.0, None).unwrap();
let dt = PyDateTime::from_timestamp_bound(py, 100.0, None).unwrap();
py_run!(
py,
dt,
"import datetime; assert dt == datetime.datetime.fromtimestamp(100)"
);

let dt = PyDateTime::from_timestamp(py, 100.0, Some(timezone_utc(py))).unwrap();
let dt =
PyDateTime::from_timestamp_bound(py, 100.0, Some(&timezone_utc_bound(py))).unwrap();
py_run!(
py,
dt,
Expand All @@ -968,7 +948,7 @@ mod tests {
#[cfg_attr(target_arch = "wasm32", ignore)] // DateTime import fails on wasm for mysterious reasons
fn test_date_fromtimestamp() {
Python::with_gil(|py| {
let dt = PyDate::from_timestamp(py, 100).unwrap();
let dt = PyDate::from_timestamp_bound(py, 100).unwrap();
py_run!(
py,
dt,
Expand All @@ -981,8 +961,10 @@ mod tests {
#[cfg_attr(target_arch = "wasm32", ignore)] // DateTime import fails on wasm for mysterious reasons
fn test_new_with_fold() {
Python::with_gil(|py| {
let a = PyDateTime::new_with_fold(py, 2021, 1, 23, 20, 32, 40, 341516, None, false);
let b = PyDateTime::new_with_fold(py, 2021, 1, 23, 20, 32, 40, 341516, None, true);
let a =
PyDateTime::new_bound_with_fold(py, 2021, 1, 23, 20, 32, 40, 341516, None, false);
let b =
PyDateTime::new_bound_with_fold(py, 2021, 1, 23, 20, 32, 40, 341516, None, true);

assert!(!a.unwrap().get_fold());
assert!(b.unwrap().get_fold());
Expand All @@ -991,26 +973,25 @@ mod tests {

#[test]
#[cfg_attr(target_arch = "wasm32", ignore)] // DateTime import fails on wasm for mysterious reasons
#[cfg_attr(not(feature = "gil-refs"), allow(deprecated))]
fn test_get_tzinfo() {
crate::Python::with_gil(|py| {
let utc = timezone_utc(py);
let utc = timezone_utc_bound(py);

let dt = PyDateTime::new(py, 2018, 1, 1, 0, 0, 0, 0, Some(utc)).unwrap();
let dt = PyDateTime::new_bound(py, 2018, 1, 1, 0, 0, 0, 0, Some(&utc)).unwrap();

assert!(dt.get_tzinfo().unwrap().eq(utc).unwrap());
assert!(dt.get_tzinfo_bound().unwrap().eq(&utc).unwrap());

let dt = PyDateTime::new(py, 2018, 1, 1, 0, 0, 0, 0, None).unwrap();
let dt = PyDateTime::new_bound(py, 2018, 1, 1, 0, 0, 0, 0, None).unwrap();

assert!(dt.get_tzinfo().is_none());
assert!(dt.get_tzinfo_bound().is_none());

let t = PyTime::new(py, 0, 0, 0, 0, Some(utc)).unwrap();
let t = PyTime::new_bound(py, 0, 0, 0, 0, Some(&utc)).unwrap();

assert!(t.get_tzinfo().unwrap().eq(utc).unwrap());
assert!(t.get_tzinfo_bound().unwrap().eq(utc).unwrap());

let t = PyTime::new(py, 0, 0, 0, 0, None).unwrap();
let t = PyTime::new_bound(py, 0, 0, 0, 0, None).unwrap();

assert!(t.get_tzinfo().is_none());
assert!(t.get_tzinfo_bound().is_none());
});
}

Expand All @@ -1024,9 +1005,9 @@ mod tests {
.unwrap()
.call_method1("utcoffset", ((),))
.unwrap()
.extract::<&PyDelta>()
.downcast_into::<PyDelta>()
.unwrap()
.eq(PyDelta::new(py, 0, -3600, 0, true).unwrap())
.eq(PyDelta::new_bound(py, 0, -3600, 0, true).unwrap())
.unwrap()
);

Expand All @@ -1035,9 +1016,9 @@ mod tests {
.unwrap()
.call_method1("utcoffset", ((),))
.unwrap()
.extract::<&PyDelta>()
.downcast_into::<PyDelta>()
.unwrap()
.eq(PyDelta::new(py, 0, 3600, 0, true).unwrap())
.eq(PyDelta::new_bound(py, 0, 3600, 0, true).unwrap())
.unwrap()
);

Expand Down
2 changes: 1 addition & 1 deletion src/types/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pub use self::capsule::{PyCapsule, PyCapsuleMethods};
pub use self::code::PyCode;
pub use self::complex::{PyComplex, PyComplexMethods};
#[allow(deprecated)]
#[cfg(not(Py_LIMITED_API))]
#[cfg(all(not(Py_LIMITED_API), feature = "gil-refs"))]
pub use self::datetime::timezone_utc;
#[cfg(not(Py_LIMITED_API))]
pub use self::datetime::{
Expand Down