pyarrow.ExtensionType¶
- class pyarrow.ExtensionType(DataType storage_type, extension_name)¶
Bases:
BaseExtensionType
Concrete base class for Python-defined extension types.
- __init__()¶
Initialize an extension type instance.
This should be called at the end of the subclass’
__init__
method.
Methods
Initialize an extension type instance.
equals
(self, other)Return true if type is equivalent to passed value.
to_pandas_dtype
(self)Return the equivalent NumPy / Pandas dtype.
wrap_array
(self, storage)Wrap the given storage array as an extension array.
Attributes
The extension type name.
Number of data buffers required to construct Array type excluding children.
The number of child fields.
The number of child fields.
The underlying storage type.
- bit_width¶
- equals(self, other)¶
Return true if type is equivalent to passed value.
- extension_name¶
The extension type name.
- id¶
- num_buffers¶
Number of data buffers required to construct Array type excluding children.
- num_children¶
The number of child fields.
- 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:
- storage
Array
orChunkedArray
- storage
- Returns:
- array
Array
orChunkedArray
Extension array wrapping the storage array
- array