luxolus
/
pyo3
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

port `PyErr::from_type` to `Bound` API (#3885)

This commit is contained in:
Icxolu 2024-02-23 07:31:51 +01:00 committed by GitHub
parent 5ca810236d
commit 6a815875a0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/err/mod.rs
View File

@ -182,6 +182,21 @@ impl PyErr {
}))) })))
} }
/// Deprecated form of [`PyErr::from_type_bound`]
#[cfg_attr(
not(feature = "gil-refs"),
deprecated(
since = "0.21.0",
note = "`PyErr::from_type` will be replaced by `PyErr::from_type_bound` in a future PyO3 version"
)
)]
pub fn from_type<A>(ty: &PyType, args: A) -> PyErr
where
A: PyErrArguments + Send + Sync + 'static,
{
PyErr::from_state(PyErrState::lazy(ty.into(), args))
}
/// Constructs a new PyErr from the given Python type and arguments. /// Constructs a new PyErr from the given Python type and arguments.
/// ///
/// `ty` is the exception type; usually one of the standard exceptions /// `ty` is the exception type; usually one of the standard exceptions
@ -192,11 +207,11 @@ impl PyErr {
/// If `ty` does not inherit from `BaseException`, then a `TypeError` will be returned. /// If `ty` does not inherit from `BaseException`, then a `TypeError` will be returned.
/// ///
/// If calling `ty` with `args` raises an exception, that exception will be returned. /// If calling `ty` with `args` raises an exception, that exception will be returned.
pub fn from_type<A>(ty: &PyType, args: A) -> PyErr pub fn from_type_bound<A>(ty: Bound<'_, PyType>, args: A) -> PyErr
where where
A: PyErrArguments + Send + Sync + 'static, A: PyErrArguments + Send + Sync + 'static,
{ {
PyErr::from_state(PyErrState::lazy(ty.into(), args)) PyErr::from_state(PyErrState::lazy(ty.unbind().into_any(), args))
} }
/// Deprecated form of [`PyErr::from_value_bound`]. /// Deprecated form of [`PyErr::from_value_bound`].
@ -1231,10 +1246,8 @@ mod tests {
assert!(!err.matches(py, PyTypeError::type_object_bound(py))); assert!(!err.matches(py, PyTypeError::type_object_bound(py)));
// String is not a valid exception class, so we should get a TypeError // String is not a valid exception class, so we should get a TypeError
let err: PyErr = PyErr::from_type( let err: PyErr =
crate::types::PyString::type_object_bound(py).as_gil_ref(), PyErr::from_type_bound(crate::types::PyString::type_object_bound(py), "foo");
"foo",
);
assert!(err.matches(py, PyTypeError::type_object_bound(py))); assert!(err.matches(py, PyTypeError::type_object_bound(py)));
}) })
} }