pyarrow.ExtensionScalar

class pyarrow.ExtensionScalar

Bases: Scalar

Concrete class for Extension scalars.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
as_py(self)	Return this scalar as a Python object.
cast(self, target_type)	Attempt a safe cast to target data type.
equals(self, Scalar other)
from_storage(BaseExtensionType typ, value)	Construct ExtensionScalar from type and storage value.
validate(self, *[, full])	Perform validation checks.

Attributes

is_valid	Holds a valid (non-null) value.
type	Data type of the Scalar object.
value	Return storage value as a scalar.

as_py(self)

Return this scalar as a Python object.

cast(self, target_type)

Attempt a safe cast to target data type.

Parameters:

target_typeDataType or str coercible to DataType

The type to cast the scalar to.

Returns:

scalarA Scalar of the given target data type.

equals(self, Scalar other)

static from_storage(BaseExtensionType typ, value)

Construct ExtensionScalar from type and storage value.

Parameters:

typDataType

The extension type for the result scalar.

valueobject

The storage value for the result scalar.

Returns:

ext_scalarExtensionScalar

is_valid

Holds a valid (non-null) value.

type

Data type of the Scalar object.

validate(self, *, full=False)

Perform validation checks. An exception is raised if validation fails.

By default only cheap validation checks are run. Pass full=True for thorough validation checks (potentially O(n)).

Parameters:

fullbool, default False

If True, run expensive checks, otherwise cheap checks only.

Raises:

ArrowInvalid

value

Return storage value as a scalar.

previous

pyarrow.UnionScalar

next

Buffers and Memory