pyarrow.types.TypesEnum#

class pyarrow.types.TypesEnum(*values)[source]#

Bases: IntEnum

An Enum that maps constant values to data types. Exposes the underlying data types representation for type checking purposes. Note that some of the types listed here are not supported by PyArrow yet: INTERVAL_MONTHS and INTERVAL_DAY_TIME.

Examples

>>> import pyarrow as pa
>>> from pyarrow.types import TypesEnum
>>> int8_field = pa.field('int8_field', pa.int8())
>>> int8_field.type.id == TypesEnum.INT8
True

>>> fixed_size_list = pa.list_(pa.uint16(), 3)
>>> fixed_size_list.id == TypesEnum.LIST
False

>>> fixed_size_list.id == TypesEnum.FIXED_SIZE_LIST
True

__init__(*args, **kwds)#

Methods

conjugate(/)	Returns self, the complex conjugate of any int.
bit_length(/)	Number of bits necessary to represent self in binary.
bit_count(/)	Number of ones in the binary representation of the absolute value of self.
to_bytes(/[,length,byteorder,signed])	Return an array of bytes representing an integer.
from_bytes(/,bytes[,byteorder,signed])	Return the integer represented by the given array of bytes.
as_integer_ratio(/)	Return a pair of integers, whose ratio is equal to the original int.
is_integer(/)	Returns True.
__init__(*args,**kwds)

Attributes

real	the real part of a complex number
imag	the imaginary part of a complex number
numerator	the numerator of a rational number in lowest terms
denominator	the denominator of a rational number in lowest terms
NA
BOOL
INT8
INT16
INT32
INT64
UINT8
UINT16
UINT32
UINT64
HALF_FLOAT
FLOAT
DOUBLE
BINARY
BINARY_VIEW
LARGE_BINARY
STRING
STRING_VIEW
LARGE_STRING
FIXED_SIZE_BINARY
DECIMAL32
DECIMAL64
DECIMAL128
DECIMAL256
LIST
LARGE_LIST
LIST_VIEW
LARGE_LIST_VIEW
MAP
FIXED_SIZE_LIST
STRUCT
SPARSE_UNION
DENSE_UNION
RUN_END_ENCODED
DATE32
DATE64
TIME32
TIME64
TIMESTAMP
INTERVAL_MONTHS
INTERVAL_DAY_TIME
INTERVAL_MONTH_DAY_NANO
DURATION
DICTIONARY

BINARY = 14#

BINARY_VIEW = 40#

BOOL = 1#

DATE32 = 16#

DATE64 = 17#

DECIMAL128 = 23#

DECIMAL256 = 24#

DECIMAL32 = 43#

DECIMAL64 = 44#

DENSE_UNION = 28#

DICTIONARY = 29#

DOUBLE = 12#

DURATION = 33#

FIXED_SIZE_BINARY = 15#

FIXED_SIZE_LIST = 32#

FLOAT = 11#

HALF_FLOAT = 10#

INT16 = 5#

INT32 = 7#

INT64 = 9#

INT8 = 3#

INTERVAL_DAY_TIME = 22#

INTERVAL_MONTHS = 21#

INTERVAL_MONTH_DAY_NANO = 37#

LARGE_BINARY = 35#

LARGE_LIST = 36#

LARGE_LIST_VIEW = 42#

LARGE_STRING = 34#

LIST = 25#

LIST_VIEW = 41#

MAP = 30#

NA = 0#

RUN_END_ENCODED = 38#

SPARSE_UNION = 27#

STRING = 13#

STRING_VIEW = 39#

STRUCT = 26#

TIME32 = 19#

TIME64 = 20#

TIMESTAMP = 18#

UINT16 = 4#

UINT32 = 6#

UINT64 = 8#

UINT8 = 2#

as_integer_ratio(/)#

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count(/)#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length(/)#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate(/)#

Returns self, the complex conjugate of any int.

denominator#

the denominator of a rational number in lowest terms

classmethod from_bytes(/, bytes, byteorder='big', *, signed=False)#

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is big, the most significant byte is at the beginning of the byte array. If byteorder is little, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use big.

signed

Indicates whether twos complement is used to represent the integer.

imag#

the imaginary part of a complex number

is_integer(/)#

Returns True. Exists for duck type compatibility with float.is_integer.

numerator#

the numerator of a rational number in lowest terms

real#

the real part of a complex number

to_bytes(/, length=1, byteorder='big', *, signed=False)#

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.

byteorder

The byte order used to represent the integer. If byteorder is big, the most significant byte is at the beginning of the byte array. If byteorder is little, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use big.

signed

Determines whether twos complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.