mirror of https://github.com/pybind/pybind11
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
310 lines
12 KiB
310 lines
12 KiB
# - Find python libraries |
|
# This module finds the libraries corresponding to the Python interpreter |
|
# FindPythonInterp provides. |
|
# This code sets the following variables: |
|
# |
|
# PYTHONLIBS_FOUND - have the Python libs been found |
|
# PYTHON_PREFIX - path to the Python installation |
|
# PYTHON_LIBRARIES - path to the python library |
|
# PYTHON_INCLUDE_DIRS - path to where Python.h is found |
|
# PYTHON_MODULE_EXTENSION - lib extension, e.g. '.so' or '.pyd' |
|
# PYTHON_MODULE_PREFIX - lib name prefix: usually an empty string |
|
# PYTHON_SITE_PACKAGES - path to installation site-packages |
|
# PYTHON_IS_DEBUG - whether the Python interpreter is a debug build |
|
# |
|
# Thanks to talljimbo for the patch adding the 'LDVERSION' config |
|
# variable usage. |
|
|
|
#============================================================================= |
|
# Copyright 2001-2009 Kitware, Inc. |
|
# Copyright 2012 Continuum Analytics, Inc. |
|
# |
|
# All rights reserved. |
|
# |
|
# Redistribution and use in source and binary forms, with or without |
|
# modification, are permitted provided that the following conditions |
|
# are met: |
|
# |
|
# * Redistributions of source code must retain the above copyright |
|
# notice, this list of conditions and the following disclaimer. |
|
# |
|
# * Redistributions in binary form must reproduce the above copyright |
|
# notice, this list of conditions and the following disclaimer in the |
|
# documentation and/or other materials provided with the distribution. |
|
# |
|
# * Neither the names of Kitware, Inc., the Insight Software Consortium, |
|
# nor the names of their contributors may be used to endorse or promote |
|
# products derived from this software without specific prior written |
|
# permission. |
|
# |
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
# # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
|
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
#============================================================================= |
|
|
|
# Checking for the extension makes sure that `LibsNew` was found and not just `Libs`. |
|
if(PYTHONLIBS_FOUND AND PYTHON_MODULE_EXTENSION) |
|
return() |
|
endif() |
|
|
|
if(PythonLibsNew_FIND_QUIETLY) |
|
set(_pythonlibs_quiet QUIET) |
|
else() |
|
set(_pythonlibs_quiet "") |
|
endif() |
|
|
|
if(PythonLibsNew_FIND_REQUIRED) |
|
set(_pythonlibs_required REQUIRED) |
|
endif() |
|
|
|
# Check to see if the `python` command is present and from a virtual |
|
# environment, conda, or GHA activation - if it is, try to use that. |
|
|
|
if(NOT DEFINED PYTHON_EXECUTABLE) |
|
if(DEFINED ENV{VIRTUAL_ENV}) |
|
find_program( |
|
PYTHON_EXECUTABLE python |
|
PATHS "$ENV{VIRTUAL_ENV}" "$ENV{VIRTUAL_ENV}/bin" |
|
NO_DEFAULT_PATH) |
|
elseif(DEFINED ENV{CONDA_PREFIX}) |
|
find_program( |
|
PYTHON_EXECUTABLE python |
|
PATHS "$ENV{CONDA_PREFIX}" "$ENV{CONDA_PREFIX}/bin" |
|
NO_DEFAULT_PATH) |
|
elseif(DEFINED ENV{pythonLocation}) |
|
find_program( |
|
PYTHON_EXECUTABLE python |
|
PATHS "$ENV{pythonLocation}" "$ENV{pythonLocation}/bin" |
|
NO_DEFAULT_PATH) |
|
endif() |
|
if(NOT PYTHON_EXECUTABLE) |
|
unset(PYTHON_EXECUTABLE) |
|
endif() |
|
endif() |
|
|
|
# Use the Python interpreter to find the libs. |
|
if(NOT PythonLibsNew_FIND_VERSION) |
|
set(PythonLibsNew_FIND_VERSION "3.7") |
|
endif() |
|
|
|
if(NOT CMAKE_VERSION VERSION_LESS "3.27") |
|
cmake_policy(GET CMP0148 _pybind11_cmp0148) |
|
if(NOT _pybind11_cmp0148) |
|
message( |
|
AUTHOR_WARNING |
|
"Policy CMP0148 is not set: The FindPythonInterp and FindPythonLibs " |
|
"modules are removed. Run \"cmake --help-policy CMP0148\" for policy " |
|
"details. Use the cmake_policy command to set the policy and suppress " |
|
"this warning, or preferably upgrade to using FindPython, either by " |
|
"calling it explicitly before pybind11, or by setting " |
|
"PYBIND11_FINDPYTHON ON before pybind11.") |
|
endif() |
|
cmake_policy(SET CMP0148 OLD) |
|
unset(_pybind11_cmp0148) |
|
endif() |
|
|
|
find_package(PythonInterp ${PythonLibsNew_FIND_VERSION} ${_pythonlibs_required} |
|
${_pythonlibs_quiet}) |
|
|
|
if(NOT PYTHONINTERP_FOUND) |
|
set(PYTHONLIBS_FOUND FALSE) |
|
set(PythonLibsNew_FOUND FALSE) |
|
return() |
|
endif() |
|
|
|
# According to https://stackoverflow.com/questions/646518/python-how-to-detect-debug-interpreter |
|
# testing whether sys has the gettotalrefcount function is a reliable, cross-platform |
|
# way to detect a CPython debug interpreter. |
|
# |
|
# The library suffix is from the config var LDVERSION sometimes, otherwise |
|
# VERSION. VERSION will typically be like "2.7" on unix, and "27" on windows. |
|
execute_process( |
|
COMMAND |
|
"${PYTHON_EXECUTABLE}" "-c" " |
|
import sys;import struct; |
|
import sysconfig as s |
|
USE_SYSCONFIG = sys.version_info >= (3, 10) |
|
if not USE_SYSCONFIG: |
|
from distutils import sysconfig as ds |
|
print('.'.join(str(v) for v in sys.version_info)); |
|
print(sys.prefix); |
|
if USE_SYSCONFIG: |
|
scheme = s.get_default_scheme() |
|
if scheme == 'posix_local': |
|
# Debian's default scheme installs to /usr/local/ but we want to find headers in /usr/ |
|
scheme = 'posix_prefix' |
|
print(s.get_path('platinclude', scheme)) |
|
print(s.get_path('platlib')) |
|
print(s.get_config_var('EXT_SUFFIX') or s.get_config_var('SO')) |
|
else: |
|
print(ds.get_python_inc(plat_specific=True)); |
|
print(ds.get_python_lib(plat_specific=True)); |
|
print(ds.get_config_var('EXT_SUFFIX') or ds.get_config_var('SO')); |
|
print(hasattr(sys, 'gettotalrefcount')+0); |
|
print(struct.calcsize('@P')); |
|
print(s.get_config_var('LDVERSION') or s.get_config_var('VERSION')); |
|
print(s.get_config_var('LIBDIR') or ''); |
|
print(s.get_config_var('MULTIARCH') or ''); |
|
" |
|
RESULT_VARIABLE _PYTHON_SUCCESS |
|
OUTPUT_VARIABLE _PYTHON_VALUES |
|
ERROR_VARIABLE _PYTHON_ERROR_VALUE) |
|
|
|
if(NOT _PYTHON_SUCCESS MATCHES 0) |
|
if(PythonLibsNew_FIND_REQUIRED) |
|
message(FATAL_ERROR "Python config failure:\n${_PYTHON_ERROR_VALUE}") |
|
endif() |
|
set(PYTHONLIBS_FOUND FALSE) |
|
set(PythonLibsNew_FOUND FALSE) |
|
return() |
|
endif() |
|
|
|
option( |
|
PYBIND11_PYTHONLIBS_OVERWRITE |
|
"Overwrite cached values read from Python library (classic search). Turn off if cross-compiling and manually setting these values." |
|
ON) |
|
# Can manually set values when cross-compiling |
|
macro(_PYBIND11_GET_IF_UNDEF lst index name) |
|
if(PYBIND11_PYTHONLIBS_OVERWRITE OR NOT DEFINED "${name}") |
|
list(GET "${lst}" "${index}" "${name}") |
|
endif() |
|
endmacro() |
|
|
|
# Convert the process output into a list |
|
if(WIN32) |
|
string(REGEX REPLACE "\\\\" "/" _PYTHON_VALUES ${_PYTHON_VALUES}) |
|
endif() |
|
string(REGEX REPLACE ";" "\\\\;" _PYTHON_VALUES ${_PYTHON_VALUES}) |
|
string(REGEX REPLACE "\n" ";" _PYTHON_VALUES ${_PYTHON_VALUES}) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 0 _PYTHON_VERSION_LIST) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 1 PYTHON_PREFIX) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 2 PYTHON_INCLUDE_DIR) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 3 PYTHON_SITE_PACKAGES) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 5 PYTHON_IS_DEBUG) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 6 PYTHON_SIZEOF_VOID_P) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 7 PYTHON_LIBRARY_SUFFIX) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 8 PYTHON_LIBDIR) |
|
_pybind11_get_if_undef(_PYTHON_VALUES 9 PYTHON_MULTIARCH) |
|
|
|
list(GET _PYTHON_VALUES 4 _PYTHON_MODULE_EXT_SUFFIX) |
|
if(PYBIND11_PYTHONLIBS_OVERWRITE OR NOT DEFINED PYTHON_MODULE_DEBUG_POSTFIX) |
|
get_filename_component(PYTHON_MODULE_DEBUG_POSTFIX "${_PYTHON_MODULE_EXT_SUFFIX}" NAME_WE) |
|
endif() |
|
if(PYBIND11_PYTHONLIBS_OVERWRITE OR NOT DEFINED PYTHON_MODULE_EXTENSION) |
|
get_filename_component(PYTHON_MODULE_EXTENSION "${_PYTHON_MODULE_EXT_SUFFIX}" EXT) |
|
endif() |
|
|
|
# Make sure the Python has the same pointer-size as the chosen compiler |
|
# Skip if CMAKE_SIZEOF_VOID_P is not defined |
|
# This should be skipped for (non-Apple) cross-compiles (like EMSCRIPTEN) |
|
if(NOT _PYBIND11_CROSSCOMPILING |
|
AND CMAKE_SIZEOF_VOID_P |
|
AND (NOT "${PYTHON_SIZEOF_VOID_P}" STREQUAL "${CMAKE_SIZEOF_VOID_P}")) |
|
if(PythonLibsNew_FIND_REQUIRED) |
|
math(EXPR _PYTHON_BITS "${PYTHON_SIZEOF_VOID_P} * 8") |
|
math(EXPR _CMAKE_BITS "${CMAKE_SIZEOF_VOID_P} * 8") |
|
message(FATAL_ERROR "Python config failure: Python is ${_PYTHON_BITS}-bit, " |
|
"chosen compiler is ${_CMAKE_BITS}-bit") |
|
endif() |
|
set(PYTHONLIBS_FOUND FALSE) |
|
set(PythonLibsNew_FOUND FALSE) |
|
return() |
|
endif() |
|
|
|
# The built-in FindPython didn't always give the version numbers |
|
string(REGEX REPLACE "\\." ";" _PYTHON_VERSION_LIST ${_PYTHON_VERSION_LIST}) |
|
list(GET _PYTHON_VERSION_LIST 0 PYTHON_VERSION_MAJOR) |
|
list(GET _PYTHON_VERSION_LIST 1 PYTHON_VERSION_MINOR) |
|
list(GET _PYTHON_VERSION_LIST 2 PYTHON_VERSION_PATCH) |
|
set(PYTHON_VERSION "${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}.${PYTHON_VERSION_PATCH}") |
|
|
|
# Make sure all directory separators are '/' |
|
string(REGEX REPLACE "\\\\" "/" PYTHON_PREFIX "${PYTHON_PREFIX}") |
|
string(REGEX REPLACE "\\\\" "/" PYTHON_INCLUDE_DIR "${PYTHON_INCLUDE_DIR}") |
|
string(REGEX REPLACE "\\\\" "/" PYTHON_SITE_PACKAGES "${PYTHON_SITE_PACKAGES}") |
|
|
|
if(DEFINED PYTHON_LIBRARY) |
|
# Don't write to PYTHON_LIBRARY if it's already set |
|
elseif(CMAKE_HOST_WIN32) |
|
set(PYTHON_LIBRARY "${PYTHON_PREFIX}/libs/python${PYTHON_LIBRARY_SUFFIX}.lib") |
|
|
|
# when run in a venv, PYTHON_PREFIX points to it. But the libraries remain in the |
|
# original python installation. They may be found relative to PYTHON_INCLUDE_DIR. |
|
if(NOT EXISTS "${PYTHON_LIBRARY}") |
|
get_filename_component(_PYTHON_ROOT ${PYTHON_INCLUDE_DIR} DIRECTORY) |
|
set(PYTHON_LIBRARY "${_PYTHON_ROOT}/libs/python${PYTHON_LIBRARY_SUFFIX}.lib") |
|
endif() |
|
|
|
# if we are in MSYS & MINGW, and we didn't find windows python lib, look for system python lib |
|
if(DEFINED ENV{MSYSTEM} |
|
AND MINGW |
|
AND NOT EXISTS "${PYTHON_LIBRARY}") |
|
if(PYTHON_MULTIARCH) |
|
set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}/${PYTHON_MULTIARCH}" "${PYTHON_LIBDIR}") |
|
else() |
|
set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}") |
|
endif() |
|
unset(PYTHON_LIBRARY) |
|
find_library( |
|
PYTHON_LIBRARY |
|
NAMES "python${PYTHON_LIBRARY_SUFFIX}" |
|
PATHS ${_PYTHON_LIBS_SEARCH} |
|
NO_DEFAULT_PATH) |
|
endif() |
|
|
|
# raise an error if the python libs are still not found. |
|
if(NOT EXISTS "${PYTHON_LIBRARY}") |
|
message(FATAL_ERROR "Python libraries not found") |
|
endif() |
|
|
|
else() |
|
if(PYTHON_MULTIARCH) |
|
set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}/${PYTHON_MULTIARCH}" "${PYTHON_LIBDIR}") |
|
else() |
|
set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}") |
|
endif() |
|
#message(STATUS "Searching for Python libs in ${_PYTHON_LIBS_SEARCH}") |
|
# Probably this needs to be more involved. It would be nice if the config |
|
# information the python interpreter itself gave us were more complete. |
|
find_library( |
|
PYTHON_LIBRARY |
|
NAMES "python${PYTHON_LIBRARY_SUFFIX}" |
|
PATHS ${_PYTHON_LIBS_SEARCH} |
|
NO_DEFAULT_PATH) |
|
|
|
# If all else fails, just set the name/version and let the linker figure out the path. |
|
if(NOT PYTHON_LIBRARY) |
|
set(PYTHON_LIBRARY python${PYTHON_LIBRARY_SUFFIX}) |
|
endif() |
|
endif() |
|
|
|
mark_as_advanced(PYTHON_LIBRARY PYTHON_INCLUDE_DIR) |
|
|
|
# We use PYTHON_INCLUDE_DIR, PYTHON_LIBRARY and PYTHON_DEBUG_LIBRARY for the |
|
# cache entries because they are meant to specify the location of a single |
|
# library. We now set the variables listed by the documentation for this |
|
# module. |
|
set(PYTHON_INCLUDE_DIRS "${PYTHON_INCLUDE_DIR}") |
|
set(PYTHON_LIBRARIES "${PYTHON_LIBRARY}") |
|
if(NOT PYTHON_DEBUG_LIBRARY) |
|
set(PYTHON_DEBUG_LIBRARY "") |
|
endif() |
|
set(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}") |
|
|
|
find_package_message(PYTHON "Found PythonLibs: ${PYTHON_LIBRARIES}" |
|
"${PYTHON_EXECUTABLE}${PYTHON_VERSION_STRING}") |
|
|
|
set(PYTHONLIBS_FOUND TRUE) |
|
set(PythonLibsNew_FOUND TRUE) |
|
|
|
if(NOT PYTHON_MODULE_PREFIX) |
|
set(PYTHON_MODULE_PREFIX "") |
|
endif()
|
|
|