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