Merge pull request #1571 from kmuseth/feature/pybind11

Feature/pybind11

Author: Idclip

ci/build.sh

@@ -160,6 +160,16 @@ fi
 
 ################################################
 
+###### TEMPORARY CHANGE: Install pybind11 2.10.0 as it's not available on the linux docker images yet
+if [ $(uname) == "Linux" ]; then
+    if [ ! -f "/usr/local/include/pybind11.h" ]; then
+        $CI_DIR/install_pybind11.sh 2.10.0
+    fi
+fi
+###### TEMPORARY CHANGE: always install pybind11 2.10.0 as it's not available on the docker images yet
+
+################################################
+
 # github actions runners have 8 threads
 # https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners
 export CMAKE_BUILD_PARALLEL_LEVEL=${PARMS[-j]}

ci/install_macos.sh

@@ -6,15 +6,15 @@ brew update
 brew install bash gnu-getopt # for CI scripts
 brew install cmake
 brew install boost
-brew install boost-python3 # also installs the dependent python version
+brew install pybind11 # also installs the dependent python version
 brew install zlib
 brew install glfw
 brew install googletest
 brew install c-blosc
 brew install jq # for trivial parsing of brew json
 
-# Alias python version installed by boost-python3 to path
-py_version=$(brew info boost-python3 --json | \
+# Alias python version installed by pybind11 to path
+py_version=$(brew info pybind11 --json | \
     jq -cr '.[].dependencies[] | select(. | startswith("python"))')
 echo "Using python $py_version"
 # export for subsequent action steps (note, not exported for this env)

ci/install_macos_ax.sh

@@ -6,14 +6,14 @@ brew update
 brew install bash gnu-getopt # for CI scripts
 brew install cmake
 brew install boost
-brew install boost-python3 # also installs the dependent python version
+brew install pybind11 # also installs the dependent python version
 brew install cppunit
 brew install c-blosc
 brew install zlib
 brew install jq # for trivial parsing of brew json
 
-# Alias python version installed by boost-python3 to path
-py_version=$(brew info boost-python3 --json | \
+# Alias python version installed by pybind11 to path
+py_version=$(brew info pybind11 --json | \
     jq -cr '.[].dependencies[] | select(. | startswith("python"))')
 echo "Using python $py_version"
 # export for subsequent action steps (note, not exported for this env)

ci/install_pybind11.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+set -ex
+
+PYBIND11_VERSION="$1"
+INSTALL_ROOT="$2"
+CMAKE_EXTRA=()
+if [ ! -z "${INSTALL_ROOT}" ]; then
+    CMAKE_EXTRA+=("-DCMAKE_INSTALL_PREFIX=${INSTALL_ROOT}")
+fi
+
+git clone https://github.com/pybind/pybind11.git
+cd pybind11
+
+if [ "$PYBIND11_VERSION" != "latest" ]; then
+    git checkout tags/v${PYBIND11_VERSION} -b v${PYBIND11_VERSION}
+fi
+
+mkdir build
+cd build
+
+cmake \
+    -DPYBIND11_TEST=OFF \
+    "${CMAKE_EXTRA[@]}" \
+    ..
+
+make -j8
+make install

ci/install_windows.sh

@@ -4,5 +4,5 @@ set -ex
 
 vcpkg update
 vcpkg install zlib libpng openexr tbb gtest blosc glfw3 glew python3 \
-    boost-iostreams boost-any boost-uuid boost-interprocess boost-algorithm boost-python \
+    boost-iostreams boost-any boost-uuid boost-interprocess boost-algorithm pybind11 \
     --clean-after-build

openvdb/openvdb/python/CMakeLists.txt

@@ -95,7 +95,7 @@ set(OPENVDB_PYTHON_DEPS)
 
 # @note  explicitly only search for Development.Module from 3.18 as searching
 #   Development.Embed can cause issues on linux systems where it doesn't exist
-set(OPENVDB_PYTHON_REQUIRED_COMPONENTS Development.Module)
+set(OPENVDB_PYTHON_REQUIRED_COMPONENTS Development.Module Interpreter)
 
 if(NOT DEFINED PYOPENVDB_INSTALL_DIRECTORY)
   list(APPEND OPENVDB_PYTHON_REQUIRED_COMPONENTS Interpreter)
@@ -107,6 +107,7 @@ endif()
 
 # Make sure find_package(Python) is only ever invoked once with all required components
 find_package(Python COMPONENTS ${OPENVDB_PYTHON_REQUIRED_COMPONENTS})
+find_package(pybind11 REQUIRED)
 
 openvdb_check_python_version(Python::Module
   "${Python_VERSION}"
@@ -124,110 +125,13 @@ if(USE_NUMPY)
   list(APPEND OPENVDB_PYTHON_DEPS Python::NumPy)
 endif()
 
-if(TARGET openvdb_shared AND NOT Boost_USE_STATIC_LIBS)
-  # @note  Both of these must be set for Boost 1.70 (VFX2020) to link against
-  #        boost shared libraries (more specifically libraries built with -fPIC).
-  #        http://boost.2283326.n4.nabble.com/CMake-config-scripts-broken-in-1-70-td4708957.html
-  #        https://github.com/boostorg/boost_install/commit/160c7cb2b2c720e74463865ef0454d4c4cd9ae7c
-  set(BUILD_SHARED_LIBS ON)
-  set(Boost_USE_STATIC_LIBS OFF)
-endif()
-
-# Boost python cmake is a mess. Implementations provided by boost's config
-# cmake and kitware's module differ significantly and different cmake versions
-# also do slightly different things regarding the major/minor suffixing. We
-# previously attempted to handle all these cases by searching for boost_python
-# three times, prioritize the version suffixed library and falling back such:
-#   - boost_python{Python_VERSION_MAJOR}${Python_VERSION_MINOR}
-#   - boost_python{Python_VERSION_MAJOR}
-#   - boost_python
-# This unfortunately fails as CMake sometimes creates an empty Boost::python
-# target on failed searches which stops subsequent searches. CMake also
-# sometimes just fails to find the suffixed versions regardless.
-#
-# Newer boost versions now seems to say that the suffixing is only required if
-# you have multiple boost installations, however the CMake implementation still
-# requires it. Boost specifically reads from Boost_PYTHON_VERSION and
-# Boost_PYTHON_VERSION_MAJOR variables. If the user has set these we just
-# search for the non suffixed versions. Note that users can also provide
-# Boost_NO_BOOST_CMAKE to skip the CMake implementation of FindBoost, though
-# this will impact other boost components.
-#
-# @todo just get rid of boost python and migrate to pybind asap.
-
-set(_REQUIRED_BOOST_COMPONENTS python)
-if(USE_NUMPY)
-  list(APPEND _REQUIRED_BOOST_COMPONENTS numpy)
-endif()
-
-if(Boost_PYTHON_VERSION OR
-   Boost_PYTHON_VERSION_MAJOR)
-  # Search for non-suffixed boost libraries
-  find_package(Boost ${MINIMUM_BOOST_VERSION} COMPONENTS ${_REQUIRED_BOOST_COMPONENTS} REQUIRED)
-else()
-  # Try to find matching boost components to the version of python detected
-  list(TRANSFORM _REQUIRED_BOOST_COMPONENTS APPEND ${Python_VERSION_MAJOR}${Python_VERSION_MINOR})
-
-  # Explicitly don't pass REQUIRED so we can provide the user a message with
-  # instructions to circumvent the major/minor requirement.
-  find_package(Boost ${MINIMUM_BOOST_VERSION} COMPONENTS ${_REQUIRED_BOOST_COMPONENTS})
-
-  # See if we found the target. If we didn't and CMake/Boost created a broken
-  # aliased target, we can't try another search. Build an error message and stop.
-  set(_BOOST_ERROR "")
-  if(NOT TARGET Boost::python${Python_VERSION_MAJOR}${Python_VERSION_MINOR} AND TARGET Boost::python)
-    list(APPEND _BOOST_ERROR "boost_python${Python_VERSION_MAJOR}${Python_VERSION_MINOR}")
-  endif()
-  if(USE_NUMPY AND NOT TARGET Boost::numpy${Python_VERSION_MAJOR}${Python_VERSION_MINOR} AND TARGET Boost::numpy)
-    list(APPEND _BOOST_ERROR "boost_numpy${Python_VERSION_MAJOR}${Python_VERSION_MINOR}")
-  endif()
-
-  if(_BOOST_ERROR)
-    message(FATAL_ERROR "Unable to find versioned boost python libraries (${_BOOST_ERROR}). It's "
-      "recommended that your installation of boost_python/boost_numpy match your python version "
-      "exactly.\n"
-      "Alternatively, you can try to search for boost python versions explicitly with either:\n"
-      "  'Boost_PYTHON_VERSION=XY'\n"
-      "  'Boost_PYTHON_VERSION_MAJOR=X'")
-  endif()
-
-  # If we didn't create the target but CMake didn't create a broken alias, try another search
-  if(NOT TARGET Boost::python${Python_VERSION_MAJOR}${Python_VERSION_MINOR} AND NOT TARGET Boost::python)
-    find_package(Boost ${MINIMUM_BOOST_VERSION} COMPONENTS python REQUIRED)
-    message(STATUS "Found non-suffixed boost_python, assuming to be python version "
-        "\"${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}\" compatible")
-  endif()
-  if(USE_NUMPY AND
-     NOT TARGET Boost::numpy${Python_VERSION_MAJOR}${Python_VERSION_MINOR} AND NOT TARGET Boost::numpy)
-    find_package(Boost ${MINIMUM_BOOST_VERSION} COMPONENTS numpy REQUIRED)
-    message(STATUS "Found non-suffixed boost_numpy, assuming to be python version "
-        "\"${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}\" compatible")
-  endif()
-endif()
-
-if(TARGET Boost::python${Python_VERSION_MAJOR}${Python_VERSION_MINOR})
-  list(APPEND OPENVDB_PYTHON_DEPS Boost::python${Python_VERSION_MAJOR}${Python_VERSION_MINOR})
-elseif(TARGET Boost::python)
-  list(APPEND OPENVDB_PYTHON_DEPS Boost::python)
-  message(STATUS "Found non-suffixed boost_python, assuming to be python version "
-      "\"${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}\" compatible")
-endif()
-
-if(TARGET Boost::numpy${Python_VERSION_MAJOR}${Python_VERSION_MINOR})
-  list(APPEND OPENVDB_PYTHON_DEPS Boost::numpy${Python_VERSION_MAJOR}${Python_VERSION_MINOR})
-elseif(TARGET Boost::numpy)
-  list(APPEND OPENVDB_PYTHON_DEPS Boost::numpy)
-  message(STATUS "Found non-suffixed boost_numpy, assuming to be python version "
-      "\"${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}\" compatible")
-endif()
-
 ##########################################################################
 
 set(OPENVDB_PYTHON_MODULE_SOURCE_FILES
   pyFloatGrid.cc
+  pyGridBase.cc
   pyIntGrid.cc
   pyMetadata.cc
-  pyPointGrid.cc
   pyOpenVDBModule.cc
   pyPointGrid.cc
   pyTransform.cc
@@ -242,21 +146,7 @@ if(NOT DEFINED PYOPENVDB_INSTALL_DIRECTORY)
   )
 endif()
 
-# @todo  pyopenvdb is currently advertised as "linkable" by extension libraries
-#        so we have to mark it as SHARED. Really it should be MODULE, as the
-#        amount of manipulation required for native python support nullifies
-#        the ability for compilers to link against it (suffix/prefix renaming).
-#        A proper shared lib should be built with the functions required for
-#        extension (pyopenvdb.h) and a further module lib should be added
-#        that can be imported.
-
-add_library(pyopenvdb SHARED ${OPENVDB_PYTHON_MODULE_SOURCE_FILES})
-set_target_properties(pyopenvdb PROPERTIES PREFIX "")  # no 'lib' prefix
-if(UNIX)
-  set_target_properties(pyopenvdb PROPERTIES SUFFIX ".so") # must be .so (not .dylib)
-elseif(WIN32)
-  set_target_properties(pyopenvdb PROPERTIES SUFFIX ".pyd") # .pyd on windows
-endif()
+pybind11_add_module(pyopenvdb ${OPENVDB_PYTHON_MODULE_SOURCE_FILES})
 
 target_link_libraries(pyopenvdb PUBLIC
   ${OPENVDB_LIB}
@@ -274,44 +164,12 @@ if(USE_AX)
   target_compile_definitions(pyopenvdb PUBLIC "-DPY_OPENVDB_USE_AX")
 endif()
 
-# Configure static boost linkage
-# @note  This is usually undesirable. pyopenvdb should ideally be built
-#   against dynamic libs/runtime
-# @note  For some reason vcpkg decides to turn Boost_USE_STATIC_LIBS off
-#   when calling find_package(Boost), so we have to manually query the
-#   triplet to see if we're using boost static libs.
-set(_BUILDING_STATIC_TRIPLET OFF)
-if(VCPKG_TARGET_TRIPLET)
-  string(FIND ${VCPKG_TARGET_TRIPLET} "static" _BUILDING_STATIC_TRIPLET)
-  if(NOT (_BUILDING_STATIC_TRIPLET EQUAL -1))
-    set(_BUILDING_STATIC_TRIPLET ON)
-  else()
-    set(_BUILDING_STATIC_TRIPLET OFF)
-  endif()
-endif()
-
-if(Boost_USE_STATIC_LIBS OR _BUILDING_STATIC_TRIPLET)
-  message(WARNING "Building pyopenvdb against static variants of python/boost.python is not recommended.")
-  # Boost CMake should define these but doesn't...
-  target_compile_definitions(pyopenvdb PUBLIC "-DBOOST_PYTHON_STATIC_LIB")
-  if(USE_NUMPY)
-    target_compile_definitions(pyopenvdb PUBLIC "-DBOOST_NUMPY_STATIC_LIB")
-  endif()
-endif()
-unset(_BUILDING_STATIC_TRIPLET)
-
-set(PYTHON_PUBLIC_INCLUDE_NAMES
-  pyopenvdb.h
-)
-
 install(TARGETS
   pyopenvdb
   DESTINATION
   ${PYOPENVDB_INSTALL_DIRECTORY}
 )
 
-install(FILES ${PYTHON_PUBLIC_INCLUDE_NAMES} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/openvdb/python)
-
 # pytest
 if(OPENVDB_BUILD_PYTHON_UNITTESTS)