pyarrow.DenseUnionType

class pyarrow.DenseUnionType

基类： UnionType

稠密联合类型的具体类。

示例

使用 pa.union 创建一个稠密 UnionType 实例

>>> import pyarrow as pa
>>> pa.union([pa.field('a', pa.binary(10)), pa.field('b', pa.string())],
...          mode=pa.lib.UnionMode_DENSE),
(DenseUnionType(dense_union<a: fixed_size_binary[10]=0, b: string=1>),)

使用 pa.dense_union 创建一个稠密 UnionType 实例

>>> pa.dense_union([pa.field('a', pa.binary(10)), pa.field('b', pa.string())])
DenseUnionType(dense_union<a: fixed_size_binary[10]=0, b: string=1>)

__init__(*args, **kwargs)

方法

__init__(*args, **kwargs)
equals(self, other, *[, check_metadata])	如果类型与传入的值等价，则返回 True。
field(self, i)	通过数字索引返回子字段。
to_pandas_dtype(self)	返回等效的 NumPy / Pandas dtype。

属性

bit_width	固定宽度类型的位宽。
byte_width	固定宽度类型的字节宽。
has_variadic_buffers	如果为 True，则预期的缓冲区数量仅受 num_buffers 的下界限制。
id
模式	联合类型的模式（“dense” 或 “sparse”）。
num_buffers	构建数组类型（不包括子项）所需的缓冲区数量。
num_fields	子字段的数量。
type_codes	用于指示此联合中每个数据类型的类型代码。

bit_width

固定宽度类型的位宽。

示例

>>> import pyarrow as pa
>>> pa.int64()
DataType(int64)
>>> pa.int64().bit_width
64

byte_width

固定宽度类型的字节宽。

示例

>>> import pyarrow as pa
>>> pa.int64()
DataType(int64)
>>> pa.int64().byte_width
8

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

如果类型与传入的值等价，则返回 True。

参数:

otherDataType 或可转换为 DataType 的 str

check_metadatabool

是否也应检查嵌套字段元数据的相等性。

返回：

is_equalbool

示例

>>> import pyarrow as pa
>>> pa.int64().equals(pa.string())
False
>>> pa.int64().equals(pa.int64())
True

field(self, i) → Field

通过数字索引返回子字段。

参数:

iint

返回：

pyarrow.Field

示例

>>> import pyarrow as pa
>>> union = pa.sparse_union([pa.field('a', pa.binary(10)), pa.field('b', pa.string())])
>>> union[0]
pyarrow.Field<a: fixed_size_binary[10]>

has_variadic_buffers

如果为 True，则预期的缓冲区数量仅受 num_buffers 的下界限制。

示例

>>> import pyarrow as pa
>>> pa.int64().has_variadic_buffers
False
>>> pa.string_view().has_variadic_buffers
True

id

mode

联合类型的模式（“dense” 或 “sparse”）。

示例

>>> import pyarrow as pa
>>> union = pa.sparse_union([pa.field('a', pa.binary(10)), pa.field('b', pa.string())])
>>> union.mode
'sparse'

num_buffers

构建数组类型（不包括子项）所需的缓冲区数量。

示例

>>> import pyarrow as pa
>>> pa.int64().num_buffers
2
>>> pa.string().num_buffers
3

num_fields

子字段的数量。

示例

>>> import pyarrow as pa
>>> pa.int64()
DataType(int64)
>>> pa.int64().num_fields
0
>>> pa.list_(pa.string())
ListType(list<item: string>)
>>> pa.list_(pa.string()).num_fields
1
>>> struct = pa.struct({'x': pa.int32(), 'y': pa.string()})
>>> struct.num_fields
2

to_pandas_dtype(self)

返回等效的 NumPy / Pandas dtype。

示例

>>> import pyarrow as pa
>>> pa.int64().to_pandas_dtype()
<class 'numpy.int64'>

type_codes

用于指示此联合中每个数据类型的类型代码。

示例

>>> import pyarrow as pa
>>> union = pa.sparse_union([pa.field('a', pa.binary(10)), pa.field('b', pa.string())])
>>> union.type_codes
[0, 1]