Field

arro3.core.Field

metadata

metadata: dict[bytes, bytes] = <attribute 'metadata' of 'arro3.core._core.Field' objects>

metadata_str

metadata_str: dict[str, str] = <attribute 'metadata_str' of 'arro3.core._core.Field' objects>

name

name: str = <attribute 'name' of 'arro3.core._core.Field' objects>

nullable

nullable: bool = <attribute 'nullable' of 'arro3.core._core.Field' objects>

type

type: DataType = <attribute 'type' of 'arro3.core._core.Field' objects>

__arrow_c_schema__ method descriptor

__arrow_c_schema__() -> 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.field() to convert this array into a pyarrow field, without copying memory.

equals method descriptor

equals(other: ArrowSchemaExportable) -> bool

Test if this field is equal to the other.

from_arrow builtin

from_arrow(input: ArrowSchemaExportable) -> Field

Construct this from an existing Arrow object.

It can be called on anything that exports the Arrow schema interface (has an __arrow_c_schema__ method).

from_arrow_pycapsule builtin

from_arrow_pycapsule(capsule) -> Field

Construct this object from a bare Arrow PyCapsule

remove_metadata method descriptor

remove_metadata() -> Field

Create new field without metadata, if any.

with_metadata method descriptor

with_metadata(metadata: dict[str, str] | dict[bytes, bytes]) -> Field

Add metadata as dict of string keys and values to Field.

with_name method descriptor

with_name(name: str) -> Field

A copy of this field with the replaced name.

with_nullable method descriptor

with_nullable(nullable: bool) -> Field

A copy of this field with the replaced nullability.

with_type method descriptor

with_type(new_type: ArrowSchemaExportable) -> Field

A copy of this field with the replaced type