pyarrow.Buffer

class pyarrow.Buffer

Bases: pyarrow.lib._Weakrefable

The base class for all Arrow buffers.

A buffer represents a contiguous memory area. Many buffers will own their memory, though not all of them do.

__init__(*args, **kwargs)

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

Methods

__init__(*args, **kwargs)	Initialize self.
equals(self, Buffer other)	Determine if two buffers contain exactly the same data.
hex(self)	Compute hexadecimal representation of the buffer.
slice(self[, offset, length])	Slice this buffer.
to_pybytes(self)	Return this buffer as a Python bytes object.

Attributes

address	The buffer’s address, as an integer.
is_cpu	Whether the buffer is CPU-accessible.
is_mutable	Whether the buffer is mutable.
parent
size	The buffer size in bytes.

address

The buffer’s address, as an integer.

The returned address may point to CPU or device memory. Use is_cpu() to disambiguate.

equals(self, Buffer other)

Determine if two buffers contain exactly the same data.

Parameters

other (Buffer) –

Returns

are_equal (True if buffer contents and size are equal)

hex(self)

Compute hexadecimal representation of the buffer.

Returns

bytes

is_cpu

Whether the buffer is CPU-accessible.

is_mutable

Whether the buffer is mutable.

parent

size

The buffer size in bytes.

slice(self, offset=0, length=None)

Slice this buffer. Memory is not copied.

You can also use the Python slice notation buffer[start:stop].

Parameters

• offset (int, default 0) – Offset from start of buffer to slice.

• length (int, default None) – Length of slice (default is until end of Buffer starting from offset).

Returns

sliced (Buffer) – A logical view over this buffer.

to_pybytes(self)

Return this buffer as a Python bytes object. Memory is copied.

previous

pyarrow.foreign_buffer

next

pyarrow.ResizableBuffer