Struct pyo3::exceptions::PyWarning
source · pub struct PyWarning(PyAny);
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;
Python::with_gil(|py| {
let result: PyResult<()> = py.run_bound("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");
});
Tuple Fields§
§0: PyAny
Implementations§
Methods from Deref<Target = PyAny>§
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Trait Implementations§
source§impl AsPyPointer for PyWarning
impl AsPyPointer for PyWarning
source§impl PyClassBaseType for PyWarning
impl PyClassBaseType for PyWarning
source§impl PyTypeInfo for PyWarning
impl PyTypeInfo for PyWarning
source§const NAME: &'static str = "PyWarning"
const NAME: &'static str = "PyWarning"
Available on non-crate feature
gil-refs
only.Class name.
source§const MODULE: Option<&'static str> = _
const MODULE: Option<&'static str> = _
Available on non-crate feature
gil-refs
only.Module name, if any.
source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Available on non-crate feature
gil-refs
only.Returns the PyTypeObject instance for this type.
source§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
Available on non-crate feature
gil-refs
only.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> AssertNotZeroSized for T
impl<T> AssertNotZeroSized for T
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 more