Struct PyUntypedArray

pub struct PyUntypedArray(/* private fields */);

A safe, untyped wrapper for NumPy’s ndarray class.

Unlike PyArray<T,D>, this type does not constrain either element type T nor the dimensionality D. This can be useful to inspect function arguments, but it prevents operating on the elements without further downcasts.

When both element type T and index type D are known, these values can be downcast to PyArray<T, D>. In addition, PyArray<T, D> can be dereferenced to a PyUntypedArray and can therefore automatically access its methods.

Example

Taking PyUntypedArray can be helpful to implement polymorphic entry points:

use pyo3::exceptions::PyTypeError;
use numpy::{Element, PyUntypedArray, PyArray1, dtype};
use numpy::{PyUntypedArrayMethods, PyArrayMethods, PyArrayDescrMethods};

#[pyfunction]
fn entry_point(py: Python<'_>, array: &Bound<'_, PyUntypedArray>) -> PyResult<()> {
    fn implementation<T: Element>(array: &Bound<'_, PyArray1<T>>) -> PyResult<()> {
        /* .. */

        Ok(())
    }

    let element_type = array.dtype();

    if element_type.is_equiv_to(&dtype::<f32>(py)) {
        let array = array.downcast::<PyArray1<f32>>()?;

        implementation(array)
    } else if element_type.is_equiv_to(&dtype::<f64>(py)) {
        let array = array.downcast::<PyArray1<f64>>()?;

        implementation(array)
    } else {
        Err(PyTypeError::new_err(format!("Unsupported element type: {}", element_type)))
    }
}

Trait Implementations

impl PyTypeInfo for PyUntypedArray

const NAME: &'static str = "PyUntypedArray"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw<'py>(py: Python<'py>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn is_type_of(ob: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::type_object].

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl DerefToPyAny for PyUntypedArray