PyArray

Struct PyArray 

Source
pub struct PyArray { /* private fields */ }
Expand description

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§

Source§

impl PyArray

Source

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.

Source

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

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

Source

pub fn from_array_ref(array: ArrayRef) -> Self

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

Source

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

Import from raw Arrow capsules

Source

pub fn array(&self) -> &ArrayRef

Access the underlying ArrayRef.

Source

pub fn field(&self) -> &FieldRef

Access the underlying FieldRef.

Source

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

Consume self to access the underlying ArrayRef and FieldRef.

Source

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.

Source

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.

Source

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

Export this to a Python nanoarrow.Array.

Source

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

Export to a pyarrow.Array

Requires pyarrow >=14

Trait Implementations§

Source§

impl AsRef<Arc<dyn Array>> for PyArray

Source§

fn as_ref(&self) -> &ArrayRef

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

impl Datum for PyArray

Source§

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

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

impl Debug for PyArray

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for PyArray

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Arc<dyn Array>> for PyArray

Source§

fn from(value: ArrayRef) -> Self

Converts to this type from the input type.
Source§

impl From<PyArray> for Arro3Array

Source§

fn from(value: PyArray) -> Self

Converts to this type from the input type.
Source§

impl<'a> FromPyObject<'a> for PyArray

Source§

fn extract_bound(ob: &Bound<'a, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj. Read more
Source§

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

Source§

type Target = PyArray

The Python output type
Source§

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

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl PyClass for PyArray

Source§

type Frozen = True

Whether the pyclass is frozen. Read more
Source§

impl PyClassBaseType for PyArray

Source§

type LayoutAsBase = PyClassObject<PyArray>

Source§

type BaseNativeType = <PyArray as PyClassImpl>::BaseNativeType

Source§

type Initializer = PyClassInitializer<PyArray>

Source§

type PyClassMutability = <PyArray as PyClassImpl>::PyClassMutability

Source§

impl PyClassImpl for PyArray

Source§

const IS_BASETYPE: bool = true

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

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. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<PyArray>

This handles following two situations: Read more
Source§

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

Immutable or mutable
Source§

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

Source§

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

Source§

fn dict_offset() -> Option<isize>

Source§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for PyArray

Source§

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

Source§

impl PyClass__eq__SlotFragment<PyArray> for PyClassImplCollector<PyArray>

Source§

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

Safety: _slf and _other must be valid non-null Python objects Read more
Source§

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyArray

Source§

type Holder = Option<PyClassGuard<'a, PyArray>>

Source§

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

Source§

impl PyMethods<PyArray> for PyClassImplCollector<PyArray>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for PyArray

Source§

const NAME: &'static str = "Array"

Class name.
Source§

const MODULE: Option<&'static str>

Module name, if any.
Source§

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

Returns the PyTypeObject instance for this type.
Source§

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

Returns the safe abstraction over the type object.
Source§

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

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

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

Checks if object is an instance of this type.
Source§

impl TryFrom<AnyBufferProtocol> for PyArray

Source§

type Error = PyArrowError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl DerefToPyAny for PyArray

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'py, T> FromPyObjectBound<'_, 'py> for T
where T: FromPyObject<'py>,

Source§

fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

Source§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
Source§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
Source§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

Source§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

const NAME: &'static str = <T as PyTypeInfo>::NAME

Name of self. This is used in error messages, for example.
Source§

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

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Ungil for T
where T: Send,