pyarrow.ExtensionType

class pyarrow.ExtensionType(DataType storage_type, extension_name)

Bases: BaseExtensionType

Concrete base class for Python-defined extension types.

Parameters:

storage_typeDataType

extension_namestr

__init__()

Initialize an extension type instance.

This should be called at the end of the subclass’ __init__ method.

Methods

__init__	Initialize an extension type instance.
equals(self, other, *[, check_metadata])	Return true if type is equivalent to passed value.
field(self, i)
to_pandas_dtype(self)	Return the equivalent NumPy / Pandas dtype.
wrap_array(self, storage)	Wrap the given storage array as an extension array.

Attributes

bit_width
extension_name	The extension type name.
id
num_buffers	Number of data buffers required to construct Array type excluding children.
num_fields	The number of child fields.
storage_type	The underlying storage type.

bit_width

equals(self, other, *, check_metadata=False)

Return true if type is equivalent to passed value.

Parameters:

otherDataType or str convertible to DataType

check_metadatabool

Whether nested Field metadata equality should be checked as well.

Returns:

is_equalbool

extension_name

The extension type name.

field(self, i) → Field

id

num_buffers

Number of data buffers required to construct Array type excluding children.

num_fields

The number of child fields.

storage_type

The underlying storage type.

to_pandas_dtype(self)

Return the equivalent NumPy / Pandas dtype.

wrap_array(self, storage)

Wrap the given storage array as an extension array.

Parameters:

storageArray or ChunkedArray

Returns:

arrayArray or ChunkedArray

Extension array wrapping the storage array

previous

pyarrow.Schema

next

pyarrow.PyExtensionType