Types
types ¶
UNDEFINED = undefined() module-attribute ¶
MonthDayNano ¶
Undefined ¶
undefined() -> Undefined ¶
is_undefined(obj: pa.DataType) -> bool ¶
from_dataclass(cls: type) -> pa.DataType ¶
Return the PyArrow data type of a dataclass.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cls | type | The dataclass. | required |
Returns:
| Type | Description |
|---|---|
DataType | The PyArrow data type. |
from_typed_dict(cls: _TypedDictMeta) -> pa.DataType ¶
Return the PyArrow data type of a TypedDict.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cls | _TypedDictMeta | The TypedDict. | required |
Returns:
| Type | Description |
|---|---|
DataType | The PyArrow data type. |
from_union(args: tuple[type, ...]) -> pa.DataType ¶
from_dtype(dtype: Union[type, np.dtype, None]) -> pa.DataType ¶
Return the PyArrow data type of a provided native/NumPy data type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dtype | type | dtype | None | The native or NumPy data type. | required |
Returns:
| Type | Description |
|---|---|
DataType | The PyArrow data type. |
unify_types(left: pa.DataType, right: pa.DataType) -> pa.DataType ¶
Return the PyArrow data type that can represent both left and right.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
left | DataType | The left PyArrow data type. | required |
right | DataType | The right PyArrow data type. | required |
Returns:
| Type | Description |
|---|---|
DataType | The PyArrow data type. |
infer_type(obj: Any) -> pa.DataType ¶
Return the PyArrow data type of an object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obj | Any | The object. | required |
Returns:
| Type | Description |
|---|---|
DataType | The PyArrow data type. |