Struct pyo3::exceptions::PyImportWarning
source · pub struct PyImportWarning(PyAny);
Expand description
Represents Python’s ImportWarning
exception.
§Example: Raising ImportWarning 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::PyImportWarning;
#[pyfunction]
fn always_throws() -> PyResult<()> {
let message = "I'm ImportWarning, and I was raised from Rust.";
Err(PyImportWarning::new_err(message))
}
Python code:
from my_module import always_throws
try:
always_throws()
except ImportWarning as e:
print(f"Caught an exception: {e}")
§Example: Catching ImportWarning in Rust
use pyo3::prelude::*;
use pyo3::exceptions::PyImportWarning;
Python::with_gil(|py| {
let result: PyResult<()> = py.run_bound("raise ImportWarning", None, None);
let error_type = match result {
Ok(_) => "Not an error",
Err(error) if error.is_instance_of::<PyImportWarning>(py) => "ImportWarning",
Err(_) => "Some other error",
};
assert_eq!(error_type, "ImportWarning");
});
Tuple Fields§
§0: PyAny
Implementations§
source§impl PyImportWarning
impl PyImportWarning
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Methods from Deref<Target = PyAny>§
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Trait Implementations§
source§impl AsPyPointer for PyImportWarning
impl AsPyPointer for PyImportWarning
source§impl AsRef<PyAny> for PyImportWarning
impl AsRef<PyAny> for PyImportWarning
source§impl Deref for PyImportWarning
impl Deref for PyImportWarning
source§impl PyClassBaseType for PyImportWarning
impl PyClassBaseType for PyImportWarning
source§impl PyTypeInfo for PyImportWarning
impl PyTypeInfo for PyImportWarning
source§const NAME: &'static str = "PyImportWarning"
const NAME: &'static str = "PyImportWarning"
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 PyImportWarning
impl PyLayout<PyImportWarning> for PyBaseExceptionObject
impl PySizedLayout<PyImportWarning> for PyBaseExceptionObject
impl ToPyErr for PyImportWarning
Auto Trait Implementations§
impl !Freeze for PyImportWarning
impl !RefUnwindSafe for PyImportWarning
impl !Send for PyImportWarning
impl !Sync for PyImportWarning
impl Unpin for PyImportWarning
impl UnwindSafe for PyImportWarning
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