Skip to content

Latest commit

 

History

History
126 lines (101 loc) · 4.77 KB

README.md

File metadata and controls

126 lines (101 loc) · 4.77 KB
Raw

nanobind_pyarrow

PyArrow bindings for nanobind.

This is an extension library to nanobind to support exchange of pyarrow objects via a std::shared_ptr<..>. To get started you have to

   #include <nanobind_pyarrow/pyarrow_import.h>

and make sure to call the following pyarrow initialization on top of your module definition

    NB_MODULE(test_pyarrow_ext, m) {
        static nanobind::detail::pyarrow::ImportPyarrow module;
        // ...
    }

The type caster headers are structured in a similar form than the headers in pyarrow (array_primitive.h, array_binary.h, etc) itself:

Types Type caster header
Array, DoubleArray, Int64Array, ... #include <nanobind_pyarrow/array_primitive.h>
BinaryArray, LargeBinaryArray, StringArray, LargeStringArray, FixedSizeBinaryArray #include <nanobind_pyarrow/array_binary.h>
ListArray, LargeListArray, MapArray, FixedSizeListArray, StructArray, UnionArray, SparseUnionArray, DenseUnionArray #include <nanobind_pyarrow/array_nested.h>
ChunkedArray #include <nanobind_pyarrow/chunked_array.h>
Table #include <nanobind_pyarrow/table.h>
RecordBatch #include <nanobind_pyarrow/record_batch.h>
Field, Schema #include <nanobind_pyarrow/type.h>
Scalars #include <nanobind_pyarrow/scalar.h>
DataTypes #include <nanobind_pyarrow/datatype.h>
Buffer, ResizableBuffer, MutableBuffer #include <nanobind_pyarrow/buffer.h>
Tensor, NumericTensor<..> #include <nanobind_pyarrow/tensor.h>
SparseCOOTensor, SparseCSCMatrix, SparseCSFTensor, SparseCSRMatrix #include <nanobind_pyarrow/sparse_tensor.h>

Example: The following code snippet shows how to create bindings for a pyarrow.DoubleArray:

    #include <memory>
    #include <nanobind/nanobind.h>

    #include <nanobind_pyarrow/pyarrow_import.h>
    #include <nanobind_pyarrow/array_primitive.h>

    namespace nb = nanobind;

    NB_MODULE(test_pyarrow_ext, m) {
        static nb::detail::pyarrow::ImportPyarrow module;
        m.def("my_pyarrow_function", [](std::shared_ptr<arrow::DoubleArray> arr) {
                auto data = arr->data()->Copy();
                return std::make_shared<arrow::DoubleArray>(std::move(data));
            }
        );
    }

If you want to consume the C++ artifacts as distributed by the PyPi pyarrow package in your own CMake project, please have a look at FindPyArrow.cmake. It requires Python, nanobind and pyarrow as dependencies.

Usage via FetchContent

The recommended way to use it is via FetchContent. Here is an example

include(FetchContent)
FetchContent_Declare(
  nanobind_pyarrow
  GIT_REPOSITORY https://github.com/maximiliank/nanobind_pyarrow.git
  GIT_TAG origin/main
  UPDATE_DISCONNECTED ON)

FetchContent_MakeAvailable(nanobind_pyarrow)

if(NOT TARGET Python::Module OR NOT TARGET Python::Interpreter)
  find_package(Python 3.8 REQUIRED COMPONENTS Interpreter Development.Module)
endif()

if(NOT TARGET nanobind::nanobind)
  # Import nanobind through CMake's find_package mechanism
  set(nanobind_ROOT "${Python_SITELIB}/nanobind/cmake")
  find_package(nanobind CONFIG REQUIRED)
endif()

if(NOT TARGET nanobind_pyarrow::pyarrow)
  set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${nanobind_pyarrow_SOURCE_DIR}/cmake")
  find_package(PyArrow REQUIRED)
endif()

nanobind_add_module(pyarrow_extension bindings.cpp)
target_link_libraries(pyarrow_extension PRIVATE nanobind_pyarrow::nanobind_pyarrow nanobind_pyarrow::pyarrow)

In case you want to create wheel files via auditwheel it is important that the dependent pyarrow libraries are installed with the libraries, e.g. by adding the following to your CMakeLists.txt:

set_property(
  TARGET pyarrow_extension
  APPEND
  PROPERTY INSTALL_RPATH "$ORIGIN/lib")
  
install(CODE [[
  file(GET_RUNTIME_DEPENDENCIES
    LIBRARIES $<TARGET_FILE:pyarrow_extension>
    RESOLVED_DEPENDENCIES_VAR _r_deps
    UNRESOLVED_DEPENDENCIES_VAR _u_deps
  )
  foreach(_file ${_r_deps})
    if(_file MATCHES ".*lib(arrow|parquet).*\\.so")
      file(INSTALL
        DESTINATION "${CMAKE_INSTALL_PREFIX}/lib"
        TYPE SHARED_LIBRARY
        FOLLOW_SYMLINK_CHAIN
        FILES "${_file}"
      )
    endif()
  endforeach()
  list(LENGTH _u_deps _u_length)
  if("${_u_length}" GREATER 0)
    message(WARNING "Unresolved dependencies detected!")
  endif()
]])

install(TARGETS pyarrow_extension LIBRARY DESTINATION .)