Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update PATH when running generate_stubs on Windows #637

Merged
merged 5 commits into from
Nov 23, 2023
Merged

Update PATH when running generate_stubs on Windows #637

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d5ced68
stubs: manage windows PATH
jorisv Nov 20, 2023
67230e8
stubs: don't call list(JOIN) that's not supported in cmake 3.10
jorisv Nov 22, 2023
ab5167b
stubs: Use PYBIND11_STUBGEN_ADD_DLL_DIRECTORY instead of PATH
jorisv Nov 23, 2023
7ef8298
stubs: use forked stubgen repo
jorisv Nov 23, 2023
fad0d2f
stubs: use jcarpent pybind11-stubgen
jorisv Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions stubs.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ endmacro(LOAD_STUBGEN)
#
# Generate the stubs associated to a given project. If optional arguments (which
# should be CMake targets) are supplied, then the stubs will only be generated
# after every specified target is built.
# after every specified target is built. On windows, the PATH will also be
# modified to find the provided targets.
#
# .rst: .. variable:: module_path
#
Expand Down Expand Up @@ -96,15 +97,38 @@ function(GENERATE_STUBS module_path module_name module_install_dir)
set(PYTHONPATH ${module_path})
endif($ENV{PYTHONPATH})

# On Windows with Python 3.8+, Python doesn't search DLL in PATH anymore.
#
# DLL are build in a different directory than the module, we must then specify
# to pybind11_stubgen where to find it with the
# PYBIND11_STUBGEN_ADD_DLL_DIRECTORY environment variable.
#
# See https://github.com/python/cpython/issues/87339#issuecomment-1093902060
set(ENV_DLL_PATH)
set(optional_args ${ARGN})
if(WIN32)
foreach(py_target IN LISTS optional_args)
if(TARGET ${py_target})
set(_is_lib
"$<STREQUAL:$<TARGET_PROPERTY:${py_target},TYPE>,SHARED_LIBRARY>")
set(_target_dir "$<TARGET_FILE_DIR:${py_target}>")
set(_target_path $<${_is_lib}:${_target_dir}> ${_target_path})
endif()
endforeach()
# Join the list with escaped semicolon to keep the environment path format
# when giving it to `add_custom_target`
string(REPLACE ";" "\\\;" _join_target_path "${_target_path}")
set(ENV_DLL_PATH PYBIND11_STUBGEN_ADD_DLL_DIRECTORY=${_join_target_path})
endif()

add_custom_target(
${target_name} ALL
COMMAND
${CMAKE_COMMAND} -E env PYTHONPATH=${PYTHONPATH} "${PYTHON_EXECUTABLE}"
"${STUBGEN_MAIN_FILE}" "-o" "${module_path}" "${module_name}"
"--boost-python" --ignore-invalid signature "--no-setup-py"
"--root-module-suffix" ""
${CMAKE_COMMAND} -E env ${ENV_DLL_PATH} ${CMAKE_COMMAND} -E env
PYTHONPATH=${PYTHONPATH} "${PYTHON_EXECUTABLE}" "${STUBGEN_MAIN_FILE}"
"-o" "${module_path}" "${module_name}" "--boost-python" --ignore-invalid
signature "--no-setup-py" "--root-module-suffix" ""
VERBATIM)
set(optional_args ${ARGN})
foreach(py_target IN LISTS optional_args)
if(TARGET ${py_target})
message(
Expand Down