fix: report dtype/ndim error when extracting PyReadonlyArray/PyReadwriteArray

Author: flying-sheep

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 - Unreleased
+  - Fix `PyReadonlyArray`/`PyReadwriteArray` extraction to report the actual dtype/dimensionality mismatch instead of a generic “not an instance of” error. ([#561](https://github.com/PyO3/rust-numpy/issues/561))
 
 - v0.29.0
   - Fix PyArray_DTypeMeta definition when Py_LIMITED_API is disabled ([#532](https://github.com/PyO3/rust-numpy/pull/532))

src/array.rs

@@ -17,7 +17,7 @@ use num_traits::AsPrimitive;
 use pyo3::{
     ffi,
     types::{DerefToPyAny, PyModule},
-    Bound, CastError, Py, PyAny, PyErr, PyResult, PyTypeCheck, PyTypeInfo, Python,
+    Borrowed, Bound, CastError, Py, PyAny, PyErr, PyResult, PyTypeCheck, PyTypeInfo, Python,
 };
 
 use crate::borrow::{PyReadonlyArray, PyReadwriteArray};
@@ -132,27 +132,27 @@ unsafe impl<T: Element, D: Dimension> PyTypeInfo for PyArray<T, D> {
     }
 
     fn is_type_of(ob: &Bound<'_, PyAny>) -> bool {
-        Self::extract::<IgnoreError>(ob, npyffi::PyArray_Check).is_ok()
+        Self::extract::<IgnoreError>(ob.as_borrowed(), npyffi::PyArray_Check).is_ok()
     }
 
     fn is_exact_type_of(ob: &Bound<'_, PyAny>) -> bool {
-        Self::extract::<IgnoreError>(ob, npyffi::PyArray_CheckExact).is_ok()
+        Self::extract::<IgnoreError>(ob.as_borrowed(), npyffi::PyArray_CheckExact).is_ok()
     }
 }
 
 impl<T: Element, D: Dimension> PyArray<T, D> {
-    fn extract<'a, 'py, E>(
-        ob: &'a Bound<'py, PyAny>,
+    pub(crate) fn extract<'a, 'py, E>(
+        ob: Borrowed<'a, 'py, PyAny>,
         check: unsafe fn(Python<'py>, *mut ffi::PyObject) -> c_int,
-    ) -> Result<&'a Bound<'py, Self>, E>
+    ) -> Result<Borrowed<'a, 'py, Self>, E>
     where
         E: From<CastError<'a, 'py>> + From<DimensionalityError> + From<TypeError<'py>>,
     {
         // Check if the object is an array.
         let array = unsafe {
             if check(ob.py(), ob.as_ptr()) == 0 {
                 return Err(CastError::new(
-                    ob.as_borrowed(),
+                    ob,
                     <Self as PyTypeCheck>::classinfo_object(ob.py()),
                 )
                 .into());

src/borrow/mod.rs

@@ -175,12 +175,13 @@ use std::ops::Deref;
 use ndarray::{
     ArrayView, ArrayViewMut, Dimension, IntoDimension, Ix0, Ix1, Ix2, Ix3, Ix4, Ix5, Ix6, IxDyn,
 };
-use pyo3::{Borrowed, Bound, CastError, FromPyObject, PyAny, PyResult};
+use pyo3::{Borrowed, Bound, FromPyObject, PyAny, PyErr, PyResult};
 
 use crate::array::{PyArray, PyArrayMethods};
 use crate::convert::NpyIndex;
 use crate::dtype::Element;
 use crate::error::{AsSliceError, BorrowError};
+use crate::npyffi;
 use crate::npyffi::flags;
 use crate::untyped_array::PyUntypedArrayMethods;
 
@@ -240,10 +241,10 @@ where
 impl<'a, 'py, T: Element + 'a, D: Dimension + 'a> FromPyObject<'a, 'py>
     for PyReadonlyArray<'py, T, D>
 {
-    type Error = CastError<'a, 'py>;
+    type Error = PyErr;
 
     fn extract(obj: Borrowed<'a, 'py, PyAny>) -> Result<Self, Self::Error> {
-        let array = obj.cast::<PyArray<T, D>>()?;
+        let array = PyArray::<T, D>::extract::<PyErr>(obj, npyffi::PyArray_Check)?;
         Ok(array.readonly())
     }
 }
@@ -483,10 +484,10 @@ where
 impl<'a, 'py, T: Element + 'a, D: Dimension + 'a> FromPyObject<'a, 'py>
     for PyReadwriteArray<'py, T, D>
 {
-    type Error = CastError<'a, 'py>;
+    type Error = PyErr;
 
     fn extract(obj: Borrowed<'a, 'py, PyAny>) -> Result<Self, Self::Error> {
-        let array = obj.cast::<PyArray<T, D>>()?;
+        let array = PyArray::<T, D>::extract::<PyErr>(obj, npyffi::PyArray_Check)?;
         Ok(array.readwrite())
     }
 }
@@ -675,7 +676,10 @@ where
 mod tests {
     use super::*;
 
-    use pyo3::{types::IntoPyDict, Python};
+    use pyo3::{
+        types::{IntoPyDict, PyAnyMethods},
+        Python,
+    };
 
     use crate::array::PyArray1;
     use pyo3::ffi::c_str;
@@ -743,4 +747,42 @@ mod tests {
             assert!(exclusive.resize(10).is_ok());
         });
     }
+
+    #[test]
+    fn extraction_reports_dtype_mismatch() {
+        Python::attach(|py| {
+            let array = PyArray::<f64, _>::zeros(py, (2, 2), false);
+            let any = array.as_any();
+
+            let err = any.extract::<PyReadonlyArray2<'_, f32>>().unwrap_err();
+            let msg = err.to_string();
+            assert!(msg.contains("float64"), "message was: {msg}");
+            assert!(msg.contains("float32"), "message was: {msg}");
+
+            let err = any.extract::<PyReadwriteArray2<'_, f32>>().unwrap_err();
+            let msg = err.to_string();
+            assert!(msg.contains("float64"), "message was: {msg}");
+            assert!(msg.contains("float32"), "message was: {msg}");
+        });
+    }
+
+    #[test]
+    fn extraction_reports_dimensionality_mismatch() {
+        Python::attach(|py| {
+            let array = PyArray::<f64, _>::zeros(py, (2, 2), false);
+            let any = array.as_any();
+
+            let err = any.extract::<PyReadonlyArray3<'_, f64>>().unwrap_err();
+            let msg = err.to_string();
+            assert!(msg.contains("dimensionality"), "message was: {msg}");
+            assert!(msg.contains('2'), "message was: {msg}");
+            assert!(msg.contains('3'), "message was: {msg}");
+
+            let err = any.extract::<PyReadwriteArray3<'_, f64>>().unwrap_err();
+            let msg = err.to_string();
+            assert!(msg.contains("dimensionality"), "message was: {msg}");
+            assert!(msg.contains('2'), "message was: {msg}");
+            assert!(msg.contains('3'), "message was: {msg}");
+        });
+    }
 }