Array

arro3.core.Array

An Arrow Array.

field property

field: Field

Access the field stored on this Array.

Note that this field usually will not have a name associated, but it may have metadata that signifies that this array is an extension (user-defined typed) array.

type property

type: DataType

The data type of this array.

__arrow_c_array__

__arrow_c_array__(
    requested_schema: object | None = None,
) -> tuple[object, object]

An implementation of the Arrow PyCapsule Interface. This dunder method should not be called directly, but enables zero-copy data transfer to other Python libraries that understand Arrow memory.

For example, you can call pyarrow.array() to convert this array into a pyarrow array, without copying memory.

cast

cast(target_type: ArrowSchemaExportable) -> Array

Cast array values to another data type

Parameters:

• target_type (ArrowSchemaExportable) –

  Type to cast array to.

from_arrow classmethod

from_arrow(input: ArrowArrayExportable | ArrowStreamExportable) -> Array

Construct this object from an existing Arrow object.

It can be called on anything that exports the Arrow data interface (__arrow_c_array__).

Parameters:

• input (ArrowArrayExportable | ArrowStreamExportable) –

  Arrow array to use for constructing this object

Returns:

• Array –

  Self

from_arrow_pycapsule classmethod

from_arrow_pycapsule(schema_capsule, array_capsule) -> Array

Construct this object from bare Arrow PyCapsules

from_numpy classmethod

from_numpy(array: ndarray) -> Array

Construct an Array from a numpy ndarray

slice

slice(offset: int = 0, length: int | None = None) -> Array

Compute zero-copy slice of this array.

Parameters:

• offset (int, default: 0 ) –

  Defaults to 0.

• length (int | None, default: None ) –

  Defaults to None.

Returns:

• Array –

  The sliced array

to_numpy

to_numpy() -> NDArray

Return a numpy copy of this array.