Skip to content

Attempt to define Python 3.12 as baseline for pybind11 compatibility #9720

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

Closed
sonals wants to merge 2 commits into from
+99 −95
Closed

Attempt to define Python 3.12 as baseline for pybind11 compatibility #9720

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6043d0e
Attempt to define Python 3.12 as baseline for pybind11 compatibility
sonals Apr 9, 2026
14fc931
pybind11 CMake cleanup
sonals Apr 28, 2026
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
194 changes: 99 additions & 95 deletions src/python/pybind11/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,123 +2,127 @@
# Copyright (C) 2020-2021 Xilinx, Inc. All rights reserved.
#

if( NOT WIN32)
# Please note that Py_LIMITED_API is not compatible with pybind11. So
# setting the following to baseline python version 3.12 will lead to
# compilation failures
# target_compile_definitions(pyxrt PRIVATE Py_LIMITED_API=0x030C0000)

if(NOT WIN32)

# find_package(PythonLibs is depracted as of cmake 3.12.
if (CMAKE_VERSION VERSION_LESS "3.12")
find_package(PythonLibs 3.4.0 REQUIRED)
if (PythonLibs_FOUND)
message("-- Python libs version: ${PYTHONLIBS_VERSION_STRING}")
message("-- PYTHON_INCLUDE_PATH ${PYTHON_INCLUDE_PATH}")
string(REPLACE "." ";" PYTHONLIBS_VERSION_LIST ${PYTHONLIBS_VERSION_STRING})
list(GET PYTHONLIBS_VERSION_LIST 0 PYTHONLIBS_VERSION_MAJOR)
list(GET PYTHONLIBS_VERSION_LIST 1 PYTHONLIBS_VERSION_MINOR)
endif(PythonLibs_FOUND)
set(HAS_PYTHON ${PythonLibs_FOUND})
else()
if (DEFINED ENV{VIRTUAL_ENV})
# Virtual environment detected, use its Python
set(Python3_EXECUTABLE $ENV{VIRTUAL_ENV}/bin/python3)
message(STATUS "Virtual environment detected, using Python3: ${Python3_EXECUTABLE}")
if (CMAKE_VERSION VERSION_LESS "3.12")
find_package(PythonLibs 3.4.0 REQUIRED)
if (PythonLibs_FOUND)
message("-- Python libs version: ${PYTHONLIBS_VERSION_STRING}")
message("-- PYTHON_INCLUDE_PATH ${PYTHON_INCLUDE_PATH}")
string(REPLACE "." ";" PYTHONLIBS_VERSION_LIST ${PYTHONLIBS_VERSION_STRING})
list(GET PYTHONLIBS_VERSION_LIST 0 PYTHONLIBS_VERSION_MAJOR)
list(GET PYTHONLIBS_VERSION_LIST 1 PYTHONLIBS_VERSION_MINOR)
endif(PythonLibs_FOUND)
set(HAS_PYTHON ${PythonLibs_FOUND})
else()
# No virtual environment, use system Python3
# In alma 8.10 python3.11 comes as a dependency but still pybind11 is installed to default python3.
set(Python3_EXECUTABLE /usr/bin/python3)
endif()

find_package(Python3 COMPONENTS Development Interpreter)
if (Python3_FOUND)
message("-- Python libs version: ${Python3_VERSION}")
message("-- PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS}")
message("-- Python3_SITEARCH ${Python3_SITEARCH}")
set(PYTHONLIBS_VERSION_MAJOR ${Python3_VERSION_MAJOR})
set(PYTHONLIBS_VERSION_MINOR ${Python3_VERSION_MINOR})
endif(Python3_FOUND)
set(HAS_PYTHON ${Python3_FOUND})
endif(CMAKE_VERSION VERSION_LESS "3.12")

if (HAS_PYTHON)
if (${LINUX_FLAVOR} MATCHES "^(ubuntu|debian)")
SET(PKGDIR "dist-packages")
elseif (${LINUX_FLAVOR} MATCHES "^(rhel|centos|amzn|fedora|sles|almalinux|rocky)")
SET(PKGDIR "site-packages")
endif(${LINUX_FLAVOR} MATCHES "^(ubuntu|debian)")
find_package(pybind11 2.6.0 REQUIRED PATHS "$ENV{VIRTUAL_ENV}/lib/python${PYTHONLIBS_VERSION_MAJOR}.${PYTHONLIBS_VERSION_MINOR}/${PKGDIR}/pybind11" "/usr/local/lib/python${PYTHONLIBS_VERSION_MAJOR}.${PYTHONLIBS_VERSION_MINOR}/${PKGDIR}/pybind11" "/usr/lib/python${PYTHONLIBS_VERSION_MAJOR}.${PYTHONLIBS_VERSION_MINOR}/${PKGDIR}/pybind11")

endif(HAS_PYTHON)

if (pybind11_FOUND)
INCLUDE_DIRECTORIES(${PYTHON_INCLUDE_PATH})
pybind11_add_module(pyxrt src/pyxrt.cpp)
target_link_libraries(pyxrt PRIVATE xrt_coreutil uuid pthread)

if (CMAKE_INSTALL_PREFIX STREQUAL "/usr"
if (DEFINED ENV{VIRTUAL_ENV})
# Virtual environment detected, use its Python
set(Python3_EXECUTABLE $ENV{VIRTUAL_ENV}/bin/python3)
message(STATUS "Virtual environment detected, using Python3: ${Python3_EXECUTABLE}")
else()
# No virtual environment, use system Python3
# In alma 8.10 python3.11 comes as a dependency but still pybind11 is installed to default python3.
set(Python3_EXECUTABLE /usr/bin/python3)
endif()

find_package(Python3 COMPONENTS Development Interpreter)
if (Python3_FOUND)
message("-- Python libs version: ${Python3_VERSION}")
message("-- PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS}")
message("-- Python3_SITEARCH ${Python3_SITEARCH}")
set(PYTHONLIBS_VERSION_MAJOR ${Python3_VERSION_MAJOR})
set(PYTHONLIBS_VERSION_MINOR ${Python3_VERSION_MINOR})
endif(Python3_FOUND)
set(HAS_PYTHON ${Python3_FOUND})
endif(CMAKE_VERSION VERSION_LESS "3.12")

if (HAS_PYTHON)
if (${LINUX_FLAVOR} MATCHES "^(ubuntu|debian)")
SET(PKGDIR "dist-packages")
elseif (${LINUX_FLAVOR} MATCHES "^(rhel|centos|amzn|fedora|sles|almalinux|rocky)")
SET(PKGDIR "site-packages")
endif(${LINUX_FLAVOR} MATCHES "^(ubuntu|debian)")
find_package(pybind11 2.6.0 REQUIRED PATHS "$ENV{VIRTUAL_ENV}/lib/python${PYTHONLIBS_VERSION_MAJOR}.${PYTHONLIBS_VERSION_MINOR}/${PKGDIR}/pybind11" "/usr/local/lib/python${PYTHONLIBS_VERSION_MAJOR}.${PYTHONLIBS_VERSION_MINOR}/${PKGDIR}/pybind11" "/usr/lib/python${PYTHONLIBS_VERSION_MAJOR}.${PYTHONLIBS_VERSION_MINOR}/${PKGDIR}/pybind11")

endif(HAS_PYTHON)

if (pybind11_FOUND)
INCLUDE_DIRECTORIES(${PYTHON_INCLUDE_PATH})
pybind11_add_module(pyxrt src/pyxrt.cpp)
target_link_libraries(pyxrt PRIVATE xrt_coreutil uuid pthread)

if (CMAKE_INSTALL_PREFIX STREQUAL "/usr"
OR CMAKE_INSTALL_PREFIX STREQUAL "/usr/local")
set (XRT_INSTALL_PYTHON_DIR ${Python3_SITEARCH})
endif()
set (XRT_INSTALL_PYTHON_DIR ${Python3_SITEARCH})
endif()

install(TARGETS pyxrt
EXPORT xrt-targets
LIBRARY DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
install(TARGETS pyxrt
EXPORT xrt-targets
LIBRARY DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
)

# Install type stub file for IDE autocompletion and type checking
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/pyxrt.pyi
DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
# Install type stub file for IDE autocompletion and type checking
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/pyxrt.pyi
DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
)

else(pybind11_FOUND)
message(WARNING "-- pybind11 or python3 libs not found, pybind11 support disabled")
endif(pybind11_FOUND)
else(pybind11_FOUND)
message(WARNING "-- pybind11 or python3 libs not found, pybind11 support disabled")
endif(pybind11_FOUND)

else()
# = WINDOWS ===================================================================
else(NOT WIN32)
# = WINDOWS ===================================================================

find_package(Python3 COMPONENTS Development Interpreter)
if (Python3_FOUND)
message("-- Python libs version: ${Python3_VERSION}")
message("-- PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS}")
set(PYTHONLIBS_VERSION_MAJOR ${Python3_VERSION_MAJOR})
set(PYTHONLIBS_VERSION_MINOR ${Python3_VERSION_MINOR})
endif(Python3_FOUND)
find_package(Python3 COMPONENTS Development Interpreter)
if (Python3_FOUND)
message("-- Python libs version: ${Python3_VERSION}")
message("-- PYTHON_INCLUDE_PATH ${Python3_INCLUDE_DIRS}")
set(PYTHONLIBS_VERSION_MAJOR ${Python3_VERSION_MAJOR})
set(PYTHONLIBS_VERSION_MINOR ${Python3_VERSION_MINOR})
endif(Python3_FOUND)

set(HAS_PYTHON ${Python3_FOUND})
set(HAS_PYTHON ${Python3_FOUND})

if (HAS_PYTHON)
if (HAS_PYTHON)
execute_process(COMMAND ${Python3_EXECUTABLE} -c "import os, pathlib, pybind11; print(pathlib.Path(os.path.dirname(pybind11.__file__)).as_posix())"
RESULT_VARIABLE pybind_found
OUTPUT_VARIABLE PKGDIR
ERROR_VARIABLE pybind_error
OUTPUT_STRIP_TRAILING_WHITESPACE
)

if(pybind_found EQUAL 0)
message("-- pybind11 location: ${PKGDIR}")
find_package(pybind11 2.10.4 REQUIRED PATHS "${PKGDIR}")
else()
message(WARNING "-- Failed to import pybind11. Error: ${pybind_error}")
endif()

endif(HAS_PYTHON)

if (pybind11_FOUND)
INCLUDE_DIRECTORIES(${PYTHON_INCLUDE_PATH})
pybind11_add_module(pyxrt src/pyxrt.cpp)
target_link_libraries(pyxrt PRIVATE xrt_coreutil uuid)
set_target_properties(pyxrt PROPERTIES SUFFIX ".pyd")
)

install(TARGETS pyxrt
EXPORT xrt-targets
LIBRARY DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
if(pybind_found EQUAL 0)
message("-- pybind11 location: ${PKGDIR}")
find_package(pybind11 2.10.4 REQUIRED PATHS "${PKGDIR}")
else()
message(WARNING "-- Failed to import pybind11. Error: ${pybind_error}")
endif()

endif(HAS_PYTHON)

if (pybind11_FOUND)
INCLUDE_DIRECTORIES(${PYTHON_INCLUDE_PATH})
pybind11_add_module(pyxrt src/pyxrt.cpp)
target_link_libraries(pyxrt PRIVATE xrt_coreutil uuid)
set_target_properties(pyxrt PROPERTIES SUFFIX ".pyd")
install(TARGETS pyxrt
EXPORT xrt-targets
LIBRARY DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
)

# Install type stub file for IDE autocompletion and type checking
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/pyxrt.pyi
DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
# Install type stub file for IDE autocompletion and type checking
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/pyxrt.pyi
DESTINATION ${XRT_INSTALL_PYTHON_DIR} COMPONENT ${XRT_BASE_COMPONENT}
)

else(pybind11_FOUND)
message(WARNING "-- pybind11 or python3 libs not found, pybind11 support disabled")
endif(pybind11_FOUND)
else(pybind11_FOUND)
message(WARNING "-- pybind11 or python3 libs not found, pybind11 support disabled")
endif(pybind11_FOUND)

endif()
Loading