Skip to content

P
pybind11
Commit b0f3885c by Dean Moldovan Committed by Wenzel Jakob
Options

Make sure add_subdirectory and find_package behave identically 

Add a BUILD_INTERFACE and a pybind11::pybind11 alias for the interface
library to match the installed target.

Add new cmake tests for add_subdirectory and consolidates the
.cpp and .py files needed for the cmake build tests:

Before:
tests
|-- test_installed_module
|   |-- CMakeLists.txt
|   |-- main.cpp
|   \-- test.py
\-- test_installed_target
    |-- CMakeLists.txt
    |-- main.cpp
    \-- test.py

After:
tests
\-- test_cmake_build
    |-- installed_module/CMakeLists.txt
    |-- installed_target/CMakeLists.txt
    |-- subdirectory_module/CMakeLists.txt
    |-- subdirectory_target/CMakeLists.txt
    |-- main.cpp
    \-- test.py
parent 003a9eba
Showing with 127 additions and 104 deletions
.appveyor.yml
...@@ -30,4 +30,5 @@ build_script: ...@@ -30,4 +30,5 @@ build_script:
- cmake -A "%CMAKE_ARCH%" -DPYBIND11_WERROR=ON - cmake -A "%CMAKE_ARCH%" -DPYBIND11_WERROR=ON
- set MSBuildLogger="C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" - set MSBuildLogger="C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
- cmake --build . --config Release --target pytest -- /v:m /logger:%MSBuildLogger% - cmake --build . --config Release --target pytest -- /v:m /logger:%MSBuildLogger%
- cmake --build . --config Release --target test_install -- /v:m /logger:%MSBuildLogger% - cmake --build . --config Release --target test_cmake_build -- /v:m /logger:%MSBuildLogger%
on_failure: type tests\test_cmake_build\*.log
.travis.yml
...@@ -135,6 +135,7 @@ script: ...@@ -135,6 +135,7 @@ script:
-DPYBIND11_CPP_STANDARD=$CPP -DPYBIND11_CPP_STANDARD=$CPP
-DPYBIND11_WERROR=ON -DPYBIND11_WERROR=ON
- $SCRIPT_RUN_PREFIX make pytest -j 2 - $SCRIPT_RUN_PREFIX make pytest -j 2
- $SCRIPT_RUN_PREFIX make test_install - $SCRIPT_RUN_PREFIX make test_cmake_build
after_failure: cat tests/test_cmake_build/*.log
after_script: after_script:
- if [ -n "$DOCKER" ]; then docker stop "$containerid"; docker rm "$containerid"; fi - if [ -n "$DOCKER" ]; then docker stop "$containerid"; docker rm "$containerid"; fi
CMakeLists.txt
...@@ -85,15 +85,22 @@ foreach(ver ${pybind11_version_defines}) ...@@ -85,15 +85,22 @@ foreach(ver ${pybind11_version_defines})
endif() endif()
endforeach() endforeach()
set(${PROJECT_NAME}_VERSION ${PYBIND11_VERSION_MAJOR}.${PYBIND11_VERSION_MINOR}.${PYBIND11_VERSION_PATCH}) set(${PROJECT_NAME}_VERSION ${PYBIND11_VERSION_MAJOR}.${PYBIND11_VERSION_MINOR}.${PYBIND11_VERSION_PATCH})
message(STATUS "pybind11 v${${PROJECT_NAME}_VERSION}")
if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) # CMake >= 3.0 if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) # CMake >= 3.0
# Build an interface library target: # Build an interface library target:
add_library(pybind11 INTERFACE) add_library(pybind11 INTERFACE)
target_include_directories(pybind11 INTERFACE $<BUILD_INTERFACE:${PYBIND11_INCLUDE_DIR}> target_include_directories(pybind11 INTERFACE $<BUILD_INTERFACE:${PYBIND11_INCLUDE_DIR}>
$<BUILD_INTERFACE:${PYTHON_INCLUDE_DIRS}>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>) $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
if(APPLE) if(WIN32 OR CYGWIN)
target_link_libraries(pybind11 INTERFACE "-undefined dynamic_lookup") target_link_libraries(pybind11 INTERFACE $<BUILD_INTERFACE:${PYTHON_LIBRARIES}>)
elseif(APPLE)
target_link_libraries(pybind11 INTERFACE "-undefined dynamic_lookup")
endif() endif()
target_compile_options(pybind11 INTERFACE $<BUILD_INTERFACE:${PYBIND11_CPP_STANDARD}>)
add_library(pybind11::pybind11 ALIAS pybind11) # to match exported target
endif() endif()
if (PYBIND11_INSTALL) if (PYBIND11_INSTALL)
...@@ -120,6 +127,5 @@ if (PYBIND11_INSTALL) ...@@ -120,6 +127,5 @@ if (PYBIND11_INSTALL)
install(EXPORT "${PROJECT_NAME}Targets" install(EXPORT "${PROJECT_NAME}Targets"
NAMESPACE "${PROJECT_NAME}::" NAMESPACE "${PROJECT_NAME}::"
DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR})
message(STATUS "Exporting ${PROJECT_NAME}::pybind11 interface library target version ${${PROJECT_NAME}_VERSION}")
endif() endif()
endif() endif()
tests/CMakeLists.txt
...@@ -105,55 +105,57 @@ if(PYBIND11_TEST_OVERRIDE) ...@@ -105,55 +105,57 @@ if(PYBIND11_TEST_OVERRIDE)
COMMAND ${CMAKE_COMMAND} -E echo "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect") COMMAND ${CMAKE_COMMAND} -E echo "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect")
endif() endif()
# test use of installation # And another to show the .so size and, if a previous size, compare it:
if(PYBIND11_INSTALL) add_custom_command(TARGET pybind11_tests POST_BUILD
# 2.8.12 needed for test_installed_module COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_SOURCE_DIR}/tools/libsize.py
# 3.0 needed for interface library for test_installed_target $<TARGET_FILE:pybind11_tests> ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt)
# Test CMake build using functions and targets from subdirectory or installed location
add_custom_target(test_cmake_build)
if(NOT CMAKE_VERSION VERSION_LESS 3.1)
# 3.0 needed for interface library for subdirectory_target/installed_target
# 3.1 needed for cmake -E env for testing # 3.1 needed for cmake -E env for testing
if(NOT CMAKE_VERSION VERSION_LESS 3.1)
add_custom_target(test_installed_target include(CMakeParseArguments)
COMMAND ${CMAKE_COMMAND} function(pybind11_add_build_test name)
"-DCMAKE_INSTALL_PREFIX=${PROJECT_BINARY_DIR}/test_install" cmake_parse_arguments(ARG "INSTALL" "" "" ${ARGN})
-P "${PROJECT_BINARY_DIR}/cmake_install.cmake"
COMMAND ${CMAKE_CTEST_COMMAND} set(build_options "-DCMAKE_PREFIX_PATH=${PROJECT_BINARY_DIR}/mock_install"
--build-and-test "${CMAKE_CURRENT_SOURCE_DIR}/test_installed_target" "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}"
"${CMAKE_CURRENT_BINARY_DIR}/test_installed_target" "-DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}"
--build-noclean "-DPYBIND11_CPP_STANDARD=${PYBIND11_CPP_STANDARD}")
--build-generator ${CMAKE_GENERATOR} if(NOT ARG_INSTALL)
$<$<BOOL:${CMAKE_GENERATOR_PLATFORM}>:--build-generator-platform> ${CMAKE_GENERATOR_PLATFORM} list(APPEND build_options "-DPYBIND11_PROJECT_DIR=${PROJECT_SOURCE_DIR}")
--build-makeprogram ${CMAKE_MAKE_PROGRAM} endif()
--build-target check
--build-options "-DCMAKE_PREFIX_PATH=${PROJECT_BINARY_DIR}/test_install" add_custom_target(test_${name} ${CMAKE_CTEST_COMMAND}
"-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}" --quiet --output-log test_cmake_build/${name}.log
"-DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}" --build-and-test "${CMAKE_CURRENT_SOURCE_DIR}/test_cmake_build/${name}"
"-DPYBIND11_CPP_STANDARD=${PYBIND11_CPP_STANDARD}" "${CMAKE_CURRENT_BINARY_DIR}/test_cmake_build/${name}"
--build-config Release
--build-noclean
--build-generator ${CMAKE_GENERATOR}
$<$<BOOL:${CMAKE_GENERATOR_PLATFORM}>:--build-generator-platform> ${CMAKE_GENERATOR_PLATFORM}
--build-makeprogram ${CMAKE_MAKE_PROGRAM}
--build-target check
--build-options ${build_options}
) )
add_custom_target(test_installed_module if(ARG_INSTALL)
COMMAND ${CMAKE_COMMAND} add_dependencies(test_${name} mock_install)
"-DCMAKE_INSTALL_PREFIX=${PROJECT_BINARY_DIR}/test_install" endif()
-P "${PROJECT_BINARY_DIR}/cmake_install.cmake" add_dependencies(test_cmake_build test_${name})
COMMAND ${CMAKE_CTEST_COMMAND} endfunction()
--build-and-test "${CMAKE_CURRENT_SOURCE_DIR}/test_installed_module"
"${CMAKE_CURRENT_BINARY_DIR}/test_installed_module" pybind11_add_build_test(subdirectory_function)
--build-noclean pybind11_add_build_test(subdirectory_target)
--build-generator ${CMAKE_GENERATOR}
$<$<BOOL:${CMAKE_GENERATOR_PLATFORM}>:--build-generator-platform> ${CMAKE_GENERATOR_PLATFORM} if(PYBIND11_INSTALL)
--build-makeprogram ${CMAKE_MAKE_PROGRAM} add_custom_target(mock_install ${CMAKE_COMMAND}
--build-target check "-DCMAKE_INSTALL_PREFIX=${PROJECT_BINARY_DIR}/mock_install"
--build-options "-DCMAKE_PREFIX_PATH=${PROJECT_BINARY_DIR}/test_install" -P "${PROJECT_BINARY_DIR}/cmake_install.cmake"
"-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}"
"-DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}"
"-DPYBIND11_CPP_STANDARD=${PYBIND11_CPP_STANDARD}"
) )
else()
add_custom_target(test_installed_target) pybind11_add_build_test(installed_function INSTALL)
add_custom_target(test_installed_module) pybind11_add_build_test(installed_target INSTALL)
endif() endif()
add_custom_target(test_install)
add_dependencies(test_install test_installed_target test_installed_module)
endif() endif()
# And another to show the .so size and, if a previous size, compare it:
add_custom_command(TARGET pybind11_tests POST_BUILD
COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_SOURCE_DIR}/tools/libsize.py
$<TARGET_FILE:pybind11_tests> ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt)
tests/test_cmake_build/installed_function/CMakeLists.txt 0 → 100644
cmake_minimum_required(VERSION 2.8.12)
project(test_installed_module CXX)
set(CMAKE_MODULE_PATH "")
find_package(pybind11 CONFIG REQUIRED)
message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}")
pybind11_add_module(test_cmake_build SHARED ../main.cpp)
add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build>
${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME})
tests/test_cmake_build/installed_target/CMakeLists.txt 0 → 100644
cmake_minimum_required(VERSION 3.0)
project(test_installed_target CXX)
set(CMAKE_MODULE_PATH "")
find_package(pybind11 CONFIG REQUIRED)
message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}")
add_library(test_cmake_build MODULE ../main.cpp)
target_link_libraries(test_cmake_build PRIVATE pybind11::pybind11)
# make sure result is, for example, test_installed_target.so, not libtest_installed_target.dylib
set_target_properties(test_cmake_build PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}"
SUFFIX "${PYTHON_MODULE_EXTENSION}")
add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build>
${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME})
tests/test_installed_module/main.cpp → tests/test_cmake_build/main.cpp
#include <pybind11/pybind11.h> #include <pybind11/pybind11.h>
namespace py = pybind11; namespace py = pybind11;
PYBIND11_PLUGIN(test_installed_module) { PYBIND11_PLUGIN(test_cmake_build) {
py::module m("test_installed_module"); py::module m("test_cmake_build");
m.def("add", [](int i, int j) { return i + j; }); m.def("add", [](int i, int j) { return i + j; });
......
tests/test_cmake_build/subdirectory_function/CMakeLists.txt 0 → 100644
cmake_minimum_required(VERSION 2.8.12)
project(test_subdirectory_module CXX)
add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11)
pybind11_add_module(test_cmake_build ../main.cpp)
add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build>
${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME})
tests/test_cmake_build/subdirectory_target/CMakeLists.txt 0 → 100644
cmake_minimum_required(VERSION 3.0)
project(test_subdirectory_target CXX)
add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11)
add_library(test_cmake_build MODULE ../main.cpp)
target_link_libraries(test_cmake_build PRIVATE pybind11::pybind11)
# make sure result is, for example, test_installed_target.so, not libtest_installed_target.dylib
set_target_properties(test_cmake_build PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}"
SUFFIX "${PYTHON_MODULE_EXTENSION}")
add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build>
${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME})
tests/test_cmake_build/test.py 0 → 100644
import sys
import test_cmake_build
assert test_cmake_build.add(1, 2) == 3
print("{} imports, runs, and adds: 1 + 2 = 3".format(sys.argv[1]))
tests/test_installed_module/CMakeLists.txt deleted 100644 → 0
cmake_minimum_required(VERSION 2.8.12)
project(test_installed_module CXX)
set(CMAKE_MODULE_PATH "")
find_package(pybind11 CONFIG REQUIRED)
message(STATUS "Found pybind11: ${pybind11_INCLUDE_DIRS} (found version ${pybind11_VERSION})")
message(STATUS "Found Python: ${PYTHON_INCLUDE_DIRS} (found version ${PYTHON_VERSION_STRING})")
pybind11_add_module(test_installed_module SHARED main.cpp)
add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$<TARGET_FILE_DIR:test_installed_module>
${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/test.py)
tests/test_installed_module/test.py deleted 100644 → 0
import test_installed_module
assert test_installed_module.add(11, 22) == 33
print('test_installed_module imports, runs, and adds: 11 + 22 = 33')
tests/test_installed_target/CMakeLists.txt deleted 100644 → 0
cmake_minimum_required(VERSION 3.0)
project(test_installed_target CXX)
set(CMAKE_MODULE_PATH "")
find_package(pybind11 CONFIG REQUIRED)
message(STATUS "Found pybind11: ${pybind11_INCLUDE_DIRS} (found version ${pybind11_VERSION})")
message(STATUS "Found Python: ${PYTHON_INCLUDE_DIRS} (found version ${PYTHON_VERSION_STRING})")
add_library(test_installed_target MODULE main.cpp)
target_link_libraries(test_installed_target PRIVATE pybind11::pybind11)
# make sure result is, for example, test_installed_target.so, not libtest_installed_target.dylib
set_target_properties(test_installed_target PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}"
SUFFIX "${PYTHON_MODULE_EXTENSION}")
add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$<TARGET_FILE_DIR:test_installed_target>
${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/test.py)
tests/test_installed_target/main.cpp deleted 100644 → 0
#include <pybind11/pybind11.h>
namespace py = pybind11;
PYBIND11_PLUGIN(test_installed_target) {
py::module m("test_installed_target");
m.def("add", [](int i, int j) { return i + j; });
return m.ptr();
}
tests/test_installed_target/test.py deleted 100644 → 0
import test_installed_target
assert test_installed_target.add(1, 2) == 3
print('test_installed_target imports, runs, and adds: 1 + 2 = 3')
tools/pybind11Tools.cmake
...@@ -85,6 +85,11 @@ function(pybind11_add_module target_name) ...@@ -85,6 +85,11 @@ function(pybind11_add_module target_name)
# import time. # import time.
target_link_libraries(${target_name} PRIVATE "-undefined dynamic_lookup") target_link_libraries(${target_name} PRIVATE "-undefined dynamic_lookup")
if(${lib_type} STREQUAL "SHARED")
# Suppress CMake >= 3.0 warning for shared libraries
set_target_properties(${target_name} PROPERTIES MACOSX_RPATH ON)
endif()
endif() endif()
select_cxx_standard() select_cxx_standard()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment