pub struct PyAssertionError(/* private fields */);Expand description
Represents Python’s AssertionError exception.
§Example: Raising AssertionError 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::PyAssertionError;
#[pyfunction]
fn always_throws() -> PyResult<()> {
let message = "I'm AssertionError, and I was raised from Rust.";
Err(PyAssertionError::new_err(message))
}Python code:
from my_module import always_throws
try:
always_throws()
except AssertionError as e:
print(f"Caught an exception: {e}")§Example: Catching AssertionError in Rust
use pyo3::prelude::*;
use pyo3::exceptions::PyAssertionError;
use pyo3::ffi::c_str;
Python::attach(|py| {
let result: PyResult<()> = py.run(c_str!("raise AssertionError"), None, None);
let error_type = match result {
Ok(_) => "Not an error",
Err(error) if error.is_instance_of::<PyAssertionError>(py) => "AssertionError",
Err(_) => "Some other error",
};
assert_eq!(error_type, "AssertionError");
});Implementations§
Trait Implementations§
Source§impl PyTypeInfo for PyAssertionError
impl PyTypeInfo for PyAssertionError
Source§const NAME: &'static str = "PyAssertionError"
const NAME: &'static str = "PyAssertionError"
👎Deprecated since 0.28.0: prefer using
::type_object(py).name() to get the correct runtime valueClass name.
Source§const MODULE: Option<&'static str>
const MODULE: Option<&'static str>
👎Deprecated since 0.28.0: prefer using
::type_object(py).module() to get the correct runtime valueModule name, if any.
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§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 PyAssertionError
impl PyLayout<PyAssertionError> for PyBaseExceptionObject
impl PySizedLayout<PyAssertionError> for PyBaseExceptionObject
impl ToPyErr for PyAssertionError
Auto Trait Implementations§
impl !Freeze for PyAssertionError
impl !RefUnwindSafe for PyAssertionError
impl !Send for PyAssertionError
impl !Sync for PyAssertionError
impl Unpin for PyAssertionError
impl UnwindSafe for PyAssertionError
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 TYPE_HINT: TypeHint = const TYPE_HINT: TypeHint = <T as PyTypeInfo>::TYPE_HINT;
const TYPE_HINT: TypeHint = const TYPE_HINT: TypeHint = <T as PyTypeInfo>::TYPE_HINT;
Provides the full python type of the allowed values as a Python type hint.