pub struct PyWarning(/* private fields */);Expand description
Represents Python’s Warning exception.
§Example: Raising Warning from Rust
This exception can be sent to Python code by converting it into a
PyErr, where Python code can then catch it.
use pyo3::prelude::*;
use pyo3::exceptions::PyWarning;
#[pyfunction]
fn always_throws() -> PyResult<()> {
let message = "I'm Warning, and I was raised from Rust.";
Err(PyWarning::new_err(message))
}Python code:
from my_module import always_throws
try:
always_throws()
except Warning as e:
print(f"Caught an exception: {e}")§Example: Catching Warning in Rust
use pyo3::prelude::*;
use pyo3::exceptions::PyWarning;
use pyo3::ffi::c_str;
Python::attach(|py| {
let result: PyResult<()> = py.run(c_str!("raise Warning"), None, None);
let error_type = match result {
Ok(_) => "Not an error",
Err(error) if error.is_instance_of::<PyWarning>(py) => "Warning",
Err(_) => "Some other error",
};
assert_eq!(error_type, "Warning");
});Implementations§
Trait Implementations§
Source§impl PyTypeInfo for PyWarning
impl PyTypeInfo for PyWarning
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§const PYTHON_TYPE: &'static str = "typing.Any"
const PYTHON_TYPE: &'static str = "typing.Any"
Available on crate feature
experimental-inspect only.Provides the full python type paths.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for PyWarning
impl PyLayout<PyWarning> for PyBaseExceptionObject
impl PySizedLayout<PyWarning> for PyBaseExceptionObject
impl ToPyErr for PyWarning
Auto Trait Implementations§
impl !Freeze for PyWarning
impl !RefUnwindSafe for PyWarning
impl !Send for PyWarning
impl !Sync for PyWarning
impl Unpin for PyWarning
impl UnwindSafe for PyWarning
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = const NAME: &'static str = T::NAME;
const NAME: &'static str = const NAME: &'static str = T::NAME;
👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
Source§const PYTHON_TYPE: &'static str = const PYTHON_TYPE: &'static str = <T as PyTypeInfo>::PYTHON_TYPE;
const PYTHON_TYPE: &'static str = const PYTHON_TYPE: &'static str = <T as PyTypeInfo>::PYTHON_TYPE;
Available on crate feature
experimental-inspect only.Provides the full python type of the allowed values.