Struct PyArray 

pub struct PyArray { /* private fields */ }

A Python-facing Arrow array.

This is a wrapper around an ArrayRef and a FieldRef.

It’s important for this to wrap both an array and a field so that it can faithfully store all data transmitted via the __arrow_c_array__ Python method, which exports both an Array and a Field. In particular, storing a FieldRef is required to persist Arrow extension metadata through the C Data Interface.

Implementations

impl PyArray

pub fn new(array: ArrayRef, field: FieldRef) -> Self

Create a new Python Array from an ArrayRef and a FieldRef.

This will panic if the array’s data type does not match the field’s data type.

pub fn try_new(array: ArrayRef, field: FieldRef) -> Result<Self, ArrowError>

Create a new Python Array from an ArrayRef and a FieldRef.

pub fn from_array_ref(array: ArrayRef) -> Self

Create a new PyArray from an ArrayRef, inferring its data type automatically.

pub fn from_arrow_pycapsule( schema_capsule: &Bound<'_, PyCapsule>, array_capsule: &Bound<'_, PyCapsule>, ) -> PyResult<Self>

Import from raw Arrow capsules

pub fn array(&self) -> &ArrayRef

Access the underlying ArrayRef.

pub fn field(&self) -> &FieldRef

Access the underlying FieldRef.

pub fn into_inner(self) -> (ArrayRef, FieldRef)

Consume self to access the underlying ArrayRef and FieldRef.

pub fn to_arro3<'py>(&'py self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>>

Export to an arro3.core.Array.

This requires that you depend on arro3-core from your Python package.

pub fn into_arro3(self, py: Python<'_>) -> PyResult<Bound<'_, PyAny>>

Export to an arro3.core.Array.

This requires that you depend on arro3-core from your Python package.

pub fn to_nanoarrow<'py>( &'py self, py: Python<'py>, ) -> PyResult<Bound<'py, PyAny>>

Export this to a Python nanoarrow.Array.

pub fn to_pyarrow<'py>( &'py self, py: Python<'py>, ) -> PyResult<Bound<'py, PyAny>>

Export to a pyarrow.Array

Requires pyarrow >=14

Trait Implementations

impl AsRef<Arc<dyn Array>> for PyArray

fn as_ref(&self) -> &ArrayRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Datum for PyArray

fn get(&self) -> (&dyn Array, bool)

Returns the value for this Datum and a boolean indicating if the value is scalar

impl Debug for PyArray

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

Formats the value using the given formatter.

impl DerefToPyAny for PyArray

impl Display for PyArray

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

Formats the value using the given formatter.

impl ExtractPyClassWithClone for PyArray

impl From<Arc<dyn Array>> for PyArray

fn from(value: ArrayRef) -> Self

Converts to this type from the input type.

impl From<PyArray> for Arro3Array

fn from(value: PyArray) -> Self

Converts to this type from the input type.

impl<'py> FromPyObject<'_, 'py> for PyArray

type Error = PyErr

The type returned in the event of a conversion error.

fn extract(obj: Borrowed<'_, 'py, PyAny>) -> Result<Self, Self::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyArray

type Target = PyArray

The Python output type

type Output = Bound<'py, <PyArray as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyArray

const NAME: &str = "Array"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyArray

type LayoutAsBase = <PyArray as PyClassImpl>::Layout

type BaseNativeType = <PyArray as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyArray>

type PyClassMutability = <PyArray as PyClassImpl>::PyClassMutability

type Layout<T: PyClassImpl> = <<PyArray as PyClassBaseType>::BaseNativeType as PyClassBaseType>::Layout<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyClassImpl for PyArray

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A Python-facing Arrow array. /// /// This is a wrapper around an [ArrayRef] and a [FieldRef]. /// /// It's important for this to wrap both an array _and_ a field so that it can faithfully store all /// data transmitted via the `__arrow_c_array__` Python method, which [exports both an Array and a /// Field](https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html#arrow_c_array__). /// In particular, storing a [FieldRef] is required to persist Arrow extension metadata through the /// C Data Interface.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<PyArray as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyArray>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyArray

const TEXT_SIGNATURE: &'static str = "(obj, /, type=None)"

impl PyClass__eq__SlotFragment<PyArray> for PyClassImplCollector<PyArray>

unsafe fn __eq__( self, py: Python<'_>, _slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyMethods<PyArray> for PyClassImplCollector<PyArray>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyArray

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl TryFrom<AnyBufferProtocol> for PyArray

type Error = PyArrowError

The type returned in the event of a conversion error.

fn try_from(value: AnyBufferProtocol) -> Result<Self, Self::Error>

Performs the conversion.