Struct numpy::PyArrayDescr

pub struct PyArrayDescr(_);

Binding of numpy.dtype.

Example

use pyo3::types::IntoPyDict;
pyo3::Python::with_gil(|py| {
    let locals = [("np", numpy::get_array_module(py).unwrap())].into_py_dict(py);
    let dtype: &numpy::PyArrayDescr = py
        .eval("np.array([1, 2, 3.0]).dtype", Some(locals), None)
        .unwrap()
        .downcast()
        .unwrap();
    assert_eq!(dtype.get_datatype().unwrap(), numpy::DataType::Float64);
});

Implementations

impl PyArrayDescr

pub fn as_dtype_ptr(&self) -> *mut PyArray_Descr

Returns self as *mut PyArray_Descr.

pub fn get_type(&self) -> &PyType

Returns the internal PyType that this dtype holds.

Example

pyo3::Python::with_gil(|py| {
   let array = numpy::PyArray::from_vec(py, vec![0.0, 1.0, 2.0f64]);
   let dtype = array.dtype();
   assert_eq!(dtype.get_type().name().unwrap().to_string(), "float64");
});

pub fn get_datatype(&self) -> Option<DataType>

Returns the data type as DataType enum.

Trait Implementations

impl AsPyPointer for PyArrayDescr

pub fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyArrayDescr

pub fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyArrayDescr

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for PyArrayDescr

type Target = PyAny

The resulting type after dereferencing.

pub fn deref(&self) -> &PyAny

Dereferences the value.

impl Display for PyArrayDescr

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'_> From<&'_ PyArrayDescr> for Py<PyArrayDescr>

pub fn from(other: &PyArrayDescr) -> Self

Performs the conversion.

impl<'a> From<&'a PyArrayDescr> for &'a PyAny

pub fn from(ob: &'a PyArrayDescr) -> Self

Performs the conversion.

impl<'py> FromPyObject<'py> for &'py PyArrayDescr

pub fn extract(obj: &'py PyAny) -> PyResult<Self>

Extracts Self from the source PyObject.

impl<'_> IntoPy<Py<PyArrayDescr>> for &'_ PyArrayDescr

pub fn into_py(self, py: Python<'_>) -> Py<PyArrayDescr>

Performs the conversion.

impl PartialEq<PyArrayDescr> for PyArrayDescr

pub fn eq(&self, o: &PyArrayDescr) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PyLayout<PyArrayDescr> for PyArray_Descr

pub const IS_NATIVE_TYPE: bool

pub fn get_super(&mut self) -> Option<&mut <T as PyTypeInfo>::BaseLayout>

pub unsafe fn py_init(&mut self, _value: T)

pub unsafe fn py_drop(&mut self, _py: Python<'_>)

impl PyNativeType for PyArrayDescr

pub fn py(&self) -> Python<'_>

pub unsafe fn unchecked_downcast(obj: &PyAny) -> &Self

Cast &PyAny to &Self without no type checking.

impl PyTypeInfo for PyArrayDescr

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyArray_Descr

Layout

type BaseLayout = PyObject

Layout of Basetype.

type Initializer = PyNativeTypeInitializer<Self>

Initializer for layout

type AsRefTarget = Self

Utility type to make Py::as_ref work

pub const NAME: &'static str

Class name

pub const MODULE: Option<&'static str>

Module name, if any

pub fn type_object_raw(_py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

pub fn is_type_of(ptr: &PyAny) -> bool

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

pub const DESCRIPTION: &'static str

Class doc string

pub const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

pub fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl ToPyObject for PyArrayDescr

pub fn to_object(&self, py: Python<'_>) -> PyObject

Converts self into a Python object.