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
impl PyArray
Sourcepub fn from_array_ref(array: ArrayRef) -> Self
pub fn from_array_ref(array: ArrayRef) -> Self
Create a new PyArray from an ArrayRef, inferring its data type automatically.
Sourcepub fn from_arrow_pycapsule(
schema_capsule: &Bound<'_, PyCapsule>,
array_capsule: &Bound<'_, PyCapsule>,
) -> PyResult<Self>
pub fn from_arrow_pycapsule( schema_capsule: &Bound<'_, PyCapsule>, array_capsule: &Bound<'_, PyCapsule>, ) -> PyResult<Self>
Import from raw Arrow capsules
Sourcepub fn into_inner(self) -> (ArrayRef, FieldRef)
pub fn into_inner(self) -> (ArrayRef, FieldRef)
Sourcepub fn to_arro3<'py>(&'py self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>>
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.
Sourcepub fn into_arro3(self, py: Python<'_>) -> PyResult<Bound<'_, PyAny>>
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.
Trait Implementations§
Source§impl From<PyArray> for Arro3Array
impl From<PyArray> for Arro3Array
Source§impl<'a> FromPyObject<'a> for PyArray
impl<'a> FromPyObject<'a> for PyArray
Source§impl<'py> IntoPyObject<'py> for PyArray
impl<'py> IntoPyObject<'py> for PyArray
Source§type Output = Bound<'py, <PyArray as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyArray as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClassBaseType for PyArray
impl PyClassBaseType for PyArray
type LayoutAsBase = PyClassObject<PyArray>
type BaseNativeType = <PyArray as PyClassImpl>::BaseNativeType
type Initializer = PyClassInitializer<PyArray>
type PyClassMutability = <PyArray as PyClassImpl>::PyClassMutability
Source§impl PyClassImpl for PyArray
impl PyClassImpl for PyArray
Source§const IS_BASETYPE: bool = true
const IS_BASETYPE: bool = true
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
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.
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
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature
if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<PyArray>
type ThreadChecker = SendablePyClass<PyArray>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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<isize>
fn weaklist_offset() -> Option<isize>
Source§impl PyClassNewTextSignature for PyArray
impl PyClassNewTextSignature for PyArray
const TEXT_SIGNATURE: &'static str = "(obj, /, type=...)"
Source§impl PyMethods<PyArray> for PyClassImplCollector<PyArray>
impl PyMethods<PyArray> for PyClassImplCollector<PyArray>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyArray
impl PyTypeInfo for PyArray
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
Source§impl TryFrom<AnyBufferProtocol> for PyArray
impl TryFrom<AnyBufferProtocol> for PyArray
Source§type Error = PyArrowError
type Error = PyArrowError
The type returned in the event of a conversion error.
impl DerefToPyAny for PyArray
Auto Trait Implementations§
impl Freeze for PyArray
impl !RefUnwindSafe for PyArray
impl Send for PyArray
impl Sync for PyArray
impl Unpin for PyArray
impl !UnwindSafe for PyArray
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self
into an owned Python object, dropping type information.