Skip to content

fix(cmake): find missing Python development components #6116

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

Draft
henryiii wants to merge 1 commit into
base: master
Choose a base branch
from
+61 −8
Draft

fix(cmake): find missing Python development components #6116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions tests/test_cmake_build/subdirectory_embed/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ if(DEFINED PYTHON_EXECUTABLE AND NOT DEFINED Python_EXECUTABLE)
set(Python_EXECUTABLE "${PYTHON_EXECUTABLE}")
endif()

# pybind11 must complete a partial FindPython from a parent project
if(PYBIND11_FINDPYTHON AND NOT PYBIND11_FINDPYTHON STREQUAL "COMPAT")
find_package(
Python
COMPONENTS Interpreter
REQUIRED)
endif()

add_subdirectory("${pybind11_SOURCE_DIR}" pybind11)

# Test basic target functionality
Expand Down
61 changes: 53 additions & 8 deletions tools/pybind11NewTools.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,59 @@ else()
set(_pybind11_quiet "")
endif()

if(NOT Python_FOUND AND NOT Python3_FOUND)
if(Python_FOUND)
set(_pybind11_found_python Python)
elseif(Python3_FOUND)
set(_pybind11_found_python Python3)
else()
set(_pybind11_found_python "")
endif()

# Development.Module support (required for manylinux) started in 3.18
if(CMAKE_VERSION VERSION_LESS 3.18)
set(_pybind11_dev_component Development)
else()
set(_pybind11_dev_component Development.Module OPTIONAL_COMPONENTS Development.Embed)
endif()
Comment on lines +29 to +34

@rhaschke rhaschke Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is Development.Embed really optional? Shouldn't it be linked for pybind11::embed in any case?
If so, one can simply search for Development only as the doc states:

If component Development is specified, it implies sub-components Development.Module and Development.Embed.


# A parent project may have found Python without the development components
# pybind11 needs; ask for the missing ones, keeping the interpreter it selected.
if(_pybind11_found_python AND NOT TARGET ${_pybind11_found_python}::Module)

@rhaschke rhaschke Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't check for the Python target imported by the module Development.Embed.

if(${_pybind11_found_python}_Interpreter_FOUND)
set(_pybind11_interp_component Interpreter)
else()
set(_pybind11_interp_component "")
endif()
# Targets the parent created must not be promoted from here
set(_pybind11_new_targets "")
foreach(_pybind11_target IN ITEMS Python Module)
if(NOT TARGET ${_pybind11_found_python}::${_pybind11_target})
list(APPEND _pybind11_new_targets ${_pybind11_target})
endif()
endforeach()

set(_pybind11_global_keyword "")
if(NOT is_config AND NOT CMAKE_VERSION VERSION_LESS 3.24)
set(_pybind11_global_keyword "GLOBAL")
endif()

find_package(
${_pybind11_found_python} REQUIRED
COMPONENTS ${_pybind11_interp_component} ${_pybind11_dev_component} ${_pybind11_quiet}
${_pybind11_global_keyword})

# In submodule mode, the new targets must be visible to the parent project too
if(NOT is_config AND _pybind11_global_keyword STREQUAL "")
foreach(_pybind11_target IN LISTS _pybind11_new_targets)
if(TARGET ${_pybind11_found_python}::${_pybind11_target})
set_property(TARGET ${_pybind11_found_python}::${_pybind11_target} PROPERTY IMPORTED_GLOBAL
TRUE)
endif()
endforeach()
endif()
endif()

if(NOT _pybind11_found_python)
if(NOT DEFINED Python_FIND_IMPLEMENTATIONS)
set(Python_FIND_IMPLEMENTATIONS CPython PyPy)
endif()
Expand All @@ -35,13 +87,6 @@ if(NOT Python_FOUND AND NOT Python3_FOUND)
set(_pybind11_interp_component Interpreter)
endif()

# Development.Module support (required for manylinux) started in 3.18
if(CMAKE_VERSION VERSION_LESS 3.18)
set(_pybind11_dev_component Development)
else()
set(_pybind11_dev_component Development.Module OPTIONAL_COMPONENTS Development.Embed)
endif()

# Callers need to be able to access Python_EXECUTABLE
set(_pybind11_global_keyword "")
if(NOT is_config AND NOT DEFINED Python_ARTIFACTS_INTERACTIVE)
Expand Down
Loading