pyarrow.DictionaryType

class pyarrow.DictionaryType

Bases: pyarrow.lib.DataType

Concrete class for dictionary data types.

__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

equals(self, other) Return true if type is equivalent to passed value
to_pandas_dtype(self) Return the equivalent NumPy / Pandas dtype.

Attributes

bit_width
dictionary The dictionary array, mapping dictionary indices to values.
id
index_type The data type of dictionary indices (a signed integer type).
ordered Whether the dictionary is ordered, i.e.
bit_width
dictionary

The dictionary array, mapping dictionary indices to values.

equals(self, other)

Return true if type is equivalent to passed value

Parameters:other (DataType or string convertible to DataType) –
Returns:is_equal (boolean)
id
index_type

The data type of dictionary indices (a signed integer type).

ordered

Whether the dictionary is ordered, i.e. whether the ordering of values in the dictionary is important.

to_pandas_dtype(self)

Return the equivalent NumPy / Pandas dtype.