Tidy up deprecation message on bound api (#3893)

This commit is contained in:
David Matos 2024-02-24 14:25:06 +01:00 committed by GitHub
parent e145ae851a
commit 0f29feca8f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 11 additions and 11 deletions

View File

@ -438,7 +438,7 @@ pub unsafe trait FromPyPointer<'p>: Sized {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Py::from_owned_ptr_or_opt(py, ptr)` or `Bound::from_owned_ptr_or_opt(py, ptr)` instead" note = "use `Py::from_owned_ptr_or_opt(py, ptr)` or `Bound::from_owned_ptr_or_opt(py, ptr)` instead"
) )
)] )]
unsafe fn from_owned_ptr_or_opt(py: Python<'p>, ptr: *mut ffi::PyObject) -> Option<&'p Self>; unsafe fn from_owned_ptr_or_opt(py: Python<'p>, ptr: *mut ffi::PyObject) -> Option<&'p Self>;
@ -451,7 +451,7 @@ pub unsafe trait FromPyPointer<'p>: Sized {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Py::from_owned_ptr(py, ptr)` or `Bound::from_owned_ptr(py, ptr)` instead" note = "use `Py::from_owned_ptr(py, ptr)` or `Bound::from_owned_ptr(py, ptr)` instead"
) )
)] )]
unsafe fn from_owned_ptr_or_panic(py: Python<'p>, ptr: *mut ffi::PyObject) -> &'p Self { unsafe fn from_owned_ptr_or_panic(py: Python<'p>, ptr: *mut ffi::PyObject) -> &'p Self {
@ -467,7 +467,7 @@ pub unsafe trait FromPyPointer<'p>: Sized {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Py::from_owned_ptr(py, ptr)` or `Bound::from_owned_ptr(py, ptr)` instead" note = "use `Py::from_owned_ptr(py, ptr)` or `Bound::from_owned_ptr(py, ptr)` instead"
) )
)] )]
unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut ffi::PyObject) -> &'p Self { unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut ffi::PyObject) -> &'p Self {
@ -483,7 +483,7 @@ pub unsafe trait FromPyPointer<'p>: Sized {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Py::from_owned_ptr_or_err(py, ptr)` or `Bound::from_owned_ptr_or_err(py, ptr)` instead" note = "use `Py::from_owned_ptr_or_err(py, ptr)` or `Bound::from_owned_ptr_or_err(py, ptr)` instead"
) )
)] )]
unsafe fn from_owned_ptr_or_err(py: Python<'p>, ptr: *mut ffi::PyObject) -> PyResult<&'p Self> { unsafe fn from_owned_ptr_or_err(py: Python<'p>, ptr: *mut ffi::PyObject) -> PyResult<&'p Self> {

View File

@ -985,7 +985,7 @@ where
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `obj.into_bound(py)` instead of `obj.into_ref(py)`" note = "use `obj.into_bound(py)` instead of `obj.into_ref(py)`"
) )
)] )]
pub fn into_ref(self, py: Python<'_>) -> &T::AsRefTarget { pub fn into_ref(self, py: Python<'_>) -> &T::AsRefTarget {

View File

@ -842,7 +842,7 @@ impl<'py> Python<'py> {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `obj.downcast_bound::<T>(py)` instead of `py.checked_cast_as::<T>(obj)`" note = "use `obj.downcast_bound::<T>(py)` instead of `py.checked_cast_as::<T>(obj)`"
) )
)] )]
pub fn checked_cast_as<T>(self, obj: PyObject) -> Result<&'py T, PyDowncastError<'py>> pub fn checked_cast_as<T>(self, obj: PyObject) -> Result<&'py T, PyDowncastError<'py>>
@ -863,7 +863,7 @@ impl<'py> Python<'py> {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `obj.downcast_bound_unchecked::<T>(py)` instead of `py.cast_as::<T>(obj)`" note = "use `obj.downcast_bound_unchecked::<T>(py)` instead of `py.cast_as::<T>(obj)`"
) )
)] )]
pub unsafe fn cast_as<T>(self, obj: PyObject) -> &'py T pub unsafe fn cast_as<T>(self, obj: PyObject) -> &'py T
@ -885,7 +885,7 @@ impl<'py> Python<'py> {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Py::from_owned_ptr(py, ptr)` or `Bound::from_owned_ptr(py, ptr)` instead" note = "use `Py::from_owned_ptr(py, ptr)` or `Bound::from_owned_ptr(py, ptr)` instead"
) )
)] )]
pub unsafe fn from_owned_ptr<T>(self, ptr: *mut ffi::PyObject) -> &'py T pub unsafe fn from_owned_ptr<T>(self, ptr: *mut ffi::PyObject) -> &'py T
@ -909,7 +909,7 @@ impl<'py> Python<'py> {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Py::from_owned_ptr_or_err(py, ptr)` or `Bound::from_owned_ptr_or_err(py, ptr)` instead" note = "use `Py::from_owned_ptr_or_err(py, ptr)` or `Bound::from_owned_ptr_or_err(py, ptr)` instead"
) )
)] )]
pub unsafe fn from_owned_ptr_or_err<T>(self, ptr: *mut ffi::PyObject) -> PyResult<&'py T> pub unsafe fn from_owned_ptr_or_err<T>(self, ptr: *mut ffi::PyObject) -> PyResult<&'py T>
@ -933,7 +933,7 @@ impl<'py> Python<'py> {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Py::from_owned_ptr_or_opt(py, ptr)` or `Bound::from_owned_ptr_or_opt(py, ptr)` instead" note = "use `Py::from_owned_ptr_or_opt(py, ptr)` or `Bound::from_owned_ptr_or_opt(py, ptr)` instead"
) )
)] )]
pub unsafe fn from_owned_ptr_or_opt<T>(self, ptr: *mut ffi::PyObject) -> Option<&'py T> pub unsafe fn from_owned_ptr_or_opt<T>(self, ptr: *mut ffi::PyObject) -> Option<&'py T>

View File

@ -289,7 +289,7 @@ impl<T: PyClass> PyCell<T> {
not(feature = "gil-refs"), not(feature = "gil-refs"),
deprecated( deprecated(
since = "0.21.0", since = "0.21.0",
note = "part of the deprecated GIL Ref API; to migrate use `Bound::new(py, value)` or `Py::new(py, value)` instead of `PyCell::new(py, value)`" note = "use `Bound::new(py, value)` or `Py::new(py, value)` instead of `PyCell::new(py, value)`"
) )
)] )]
pub fn new(py: Python<'_>, value: impl Into<PyClassInitializer<T>>) -> PyResult<&Self> { pub fn new(py: Python<'_>, value: impl Into<PyClassInitializer<T>>) -> PyResult<&Self> {