Source code for pyarrow.types

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

# Tools for dealing with Arrow type metadata in Python

from pyarrow.lib import (is_boolean_value,  # noqa

import pyarrow.lib as lib
from pyarrow.util import doc

_SIGNED_INTEGER_TYPES = {lib.Type_INT8, lib.Type_INT16, lib.Type_INT32,
_UNSIGNED_INTEGER_TYPES = {lib.Type_UINT8, lib.Type_UINT16, lib.Type_UINT32,
_FLOATING_TYPES = {lib.Type_HALF_FLOAT, lib.Type_FLOAT, lib.Type_DOUBLE}
_DECIMAL_TYPES = {lib.Type_DECIMAL128, lib.Type_DECIMAL256}
_DATE_TYPES = {lib.Type_DATE32, lib.Type_DATE64}
_TIME_TYPES = {lib.Type_TIME32, lib.Type_TIME64}
                    lib.Type_DURATION} | _TIME_TYPES | _DATE_TYPES |
                 lib.Type_LIST_VIEW, lib.Type_LARGE_LIST_VIEW,
                 lib.Type_STRUCT, lib.Type_MAP} | _UNION_TYPES

[docs]@doc(datatype="null") def is_null(t): """ Return True if value is an instance of type: {datatype}. Parameters ---------- t : DataType """ return == lib.Type_NA
[docs]@doc(is_null, datatype="boolean") def is_boolean(t): return == lib.Type_BOOL
[docs]@doc(is_null, datatype="any integer") def is_integer(t): return in _INTEGER_TYPES
[docs]@doc(is_null, datatype="signed integer") def is_signed_integer(t): return in _SIGNED_INTEGER_TYPES
[docs]@doc(is_null, datatype="unsigned integer") def is_unsigned_integer(t): return in _UNSIGNED_INTEGER_TYPES
[docs]@doc(is_null, datatype="int8") def is_int8(t): return == lib.Type_INT8
[docs]@doc(is_null, datatype="int16") def is_int16(t): return == lib.Type_INT16
[docs]@doc(is_null, datatype="int32") def is_int32(t): return == lib.Type_INT32
[docs]@doc(is_null, datatype="int64") def is_int64(t): return == lib.Type_INT64
[docs]@doc(is_null, datatype="uint8") def is_uint8(t): return == lib.Type_UINT8
[docs]@doc(is_null, datatype="uint16") def is_uint16(t): return == lib.Type_UINT16
[docs]@doc(is_null, datatype="uint32") def is_uint32(t): return == lib.Type_UINT32
[docs]@doc(is_null, datatype="uint64") def is_uint64(t): return == lib.Type_UINT64
[docs]@doc(is_null, datatype="floating point numeric") def is_floating(t): return in _FLOATING_TYPES
[docs]@doc(is_null, datatype="float16 (half-precision)") def is_float16(t): return == lib.Type_HALF_FLOAT
[docs]@doc(is_null, datatype="float32 (single precision)") def is_float32(t): return == lib.Type_FLOAT
[docs]@doc(is_null, datatype="float64 (double precision)") def is_float64(t): return == lib.Type_DOUBLE
[docs]@doc(is_null, datatype="list") def is_list(t): return == lib.Type_LIST
[docs]@doc(is_null, datatype="large list") def is_large_list(t): return == lib.Type_LARGE_LIST
[docs]@doc(is_null, datatype="fixed size list") def is_fixed_size_list(t): return == lib.Type_FIXED_SIZE_LIST
[docs]@doc(is_null, datatype="list view") def is_list_view(t): return == lib.Type_LIST_VIEW
[docs]@doc(is_null, datatype="large list view") def is_large_list_view(t): return == lib.Type_LARGE_LIST_VIEW
[docs]@doc(is_null, datatype="struct") def is_struct(t): return == lib.Type_STRUCT
[docs]@doc(is_null, datatype="union") def is_union(t): return in _UNION_TYPES
[docs]@doc(is_null, datatype="nested type") def is_nested(t): return in _NESTED_TYPES
[docs]@doc(is_null, datatype="run-end encoded") def is_run_end_encoded(t): return == lib.Type_RUN_END_ENCODED
[docs]@doc(is_null, datatype="date, time, timestamp or duration") def is_temporal(t): return in _TEMPORAL_TYPES
[docs]@doc(is_null, datatype="timestamp") def is_timestamp(t): return == lib.Type_TIMESTAMP
[docs]@doc(is_null, datatype="duration") def is_duration(t): return == lib.Type_DURATION
[docs]@doc(is_null, datatype="time") def is_time(t): return in _TIME_TYPES
[docs]@doc(is_null, datatype="time32") def is_time32(t): return == lib.Type_TIME32
[docs]@doc(is_null, datatype="time64") def is_time64(t): return == lib.Type_TIME64
[docs]@doc(is_null, datatype="variable-length binary") def is_binary(t): return == lib.Type_BINARY
[docs]@doc(is_null, datatype="large variable-length binary") def is_large_binary(t): return == lib.Type_LARGE_BINARY
[docs]@doc(method="is_string") def is_unicode(t): """ Alias for {method}. Parameters ---------- t : DataType """ return is_string(t)
[docs]@doc(is_null, datatype="string (utf8 unicode)") def is_string(t): return == lib.Type_STRING
[docs]@doc(is_unicode, method="is_large_string") def is_large_unicode(t): return is_large_string(t)
[docs]@doc(is_null, datatype="large string (utf8 unicode)") def is_large_string(t): return == lib.Type_LARGE_STRING
[docs]@doc(is_null, datatype="fixed size binary") def is_fixed_size_binary(t): return == lib.Type_FIXED_SIZE_BINARY
[docs]@doc(is_null, datatype="variable-length binary view") def is_binary_view(t): return == lib.Type_BINARY_VIEW
[docs]@doc(is_null, datatype="variable-length string (utf-8) view") def is_string_view(t): return == lib.Type_STRING_VIEW
[docs]@doc(is_null, datatype="date") def is_date(t): return in _DATE_TYPES
[docs]@doc(is_null, datatype="date32 (days)") def is_date32(t): return == lib.Type_DATE32
[docs]@doc(is_null, datatype="date64 (milliseconds)") def is_date64(t): return == lib.Type_DATE64
[docs]@doc(is_null, datatype="map") def is_map(t): return == lib.Type_MAP
[docs]@doc(is_null, datatype="decimal") def is_decimal(t): return in _DECIMAL_TYPES
[docs]@doc(is_null, datatype="decimal128") def is_decimal128(t): return == lib.Type_DECIMAL128
[docs]@doc(is_null, datatype="decimal256") def is_decimal256(t): return == lib.Type_DECIMAL256
[docs]@doc(is_null, datatype="dictionary-encoded") def is_dictionary(t): return == lib.Type_DICTIONARY
[docs]@doc(is_null, datatype="interval") def is_interval(t): return == lib.Type_INTERVAL_MONTH_DAY_NANO
[docs]@doc(is_null, datatype="primitive type") def is_primitive(t): return lib._is_primitive(