1 # - Find python libraries
2 # This module finds the libraries corresponding to the Python interpreter
3 # FindPythonInterp provides.
4 # This code sets the following variables:
6 # PYTHONLIBS_FOUND - have the Python libs been found
7 # PYTHON_PREFIX - path to the Python installation
8 # PYTHON_LIBRARIES - path to the python library
9 # PYTHON_INCLUDE_DIRS - path to where Python.h is found
10 # PYTHON_MODULE_EXTENSION - lib extension, e.g. '.so' or '.pyd'
11 # PYTHON_MODULE_PREFIX - lib name prefix: usually an empty string
12 # PYTHON_SITE_PACKAGES - path to installation site-packages
13 # PYTHON_IS_DEBUG - whether the Python interpreter is a debug build
15 # Thanks to talljimbo for the patch adding the 'LDVERSION' config
18 #=============================================================================
19 # Copyright 2001-2009 Kitware, Inc.
20 # Copyright 2012 Continuum Analytics, Inc.
22 # All rights reserved.
24 # Redistribution and use in source and binary forms, with or without
25 # modification, are permitted provided that the following conditions
28 # * Redistributions of source code must retain the above copyright
29 # notice, this list of conditions and the following disclaimer.
31 # * Redistributions in binary form must reproduce the above copyright
32 # notice, this list of conditions and the following disclaimer in the
33 # documentation and/or other materials provided with the distribution.
35 # * Neither the names of Kitware, Inc., the Insight Software Consortium,
36 # nor the names of their contributors may be used to endorse or promote
37 # products derived from this software without specific prior written
40 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 # # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 # HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 #=============================================================================
53 # Checking for the extension makes sure that `LibsNew` was found and not just `Libs`.
54 if(PYTHONLIBS_FOUND AND PYTHON_MODULE_EXTENSION)
58 # Use the Python interpreter to find the libs.
59 if(PythonLibsNew_FIND_REQUIRED)
60 find_package(PythonInterp ${PythonLibsNew_FIND_VERSION} REQUIRED)
62 find_package(PythonInterp ${PythonLibsNew_FIND_VERSION})
65 if(NOT PYTHONINTERP_FOUND)
66 set(PYTHONLIBS_FOUND FALSE)
67 set(PythonLibsNew_FOUND FALSE)
71 # According to http://stackoverflow.com/questions/646518/python-how-to-detect-debug-interpreter
72 # testing whether sys has the gettotalrefcount function is a reliable, cross-platform
73 # way to detect a CPython debug interpreter.
75 # The library suffix is from the config var LDVERSION sometimes, otherwise
76 # VERSION. VERSION will typically be like "2.7" on unix, and "27" on windows.
77 execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c"
78 "from distutils import sysconfig as s;import sys;import struct;
79 print('.'.join(str(v) for v in sys.version_info));
81 print(s.get_python_inc(plat_specific=True));
82 print(s.get_python_lib(plat_specific=True));
83 print(s.get_config_var('SO'));
84 print(hasattr(sys, 'gettotalrefcount')+0);
85 print(struct.calcsize('@P'));
86 print(s.get_config_var('LDVERSION') or s.get_config_var('VERSION'));
87 print(s.get_config_var('LIBDIR') or '');
88 print(s.get_config_var('MULTIARCH') or '');
90 RESULT_VARIABLE _PYTHON_SUCCESS
91 OUTPUT_VARIABLE _PYTHON_VALUES
92 ERROR_VARIABLE _PYTHON_ERROR_VALUE)
94 if(NOT _PYTHON_SUCCESS MATCHES 0)
95 if(PythonLibsNew_FIND_REQUIRED)
97 "Python config failure:\n${_PYTHON_ERROR_VALUE}")
99 set(PYTHONLIBS_FOUND FALSE)
100 set(PythonLibsNew_FOUND FALSE)
104 # Convert the process output into a list
106 string(REGEX REPLACE "\\\\" "/" _PYTHON_VALUES ${_PYTHON_VALUES})
108 string(REGEX REPLACE ";" "\\\\;" _PYTHON_VALUES ${_PYTHON_VALUES})
109 string(REGEX REPLACE "\n" ";" _PYTHON_VALUES ${_PYTHON_VALUES})
110 list(GET _PYTHON_VALUES 0 _PYTHON_VERSION_LIST)
111 list(GET _PYTHON_VALUES 1 PYTHON_PREFIX)
112 list(GET _PYTHON_VALUES 2 PYTHON_INCLUDE_DIR)
113 list(GET _PYTHON_VALUES 3 PYTHON_SITE_PACKAGES)
114 list(GET _PYTHON_VALUES 4 PYTHON_MODULE_EXTENSION)
115 list(GET _PYTHON_VALUES 5 PYTHON_IS_DEBUG)
116 list(GET _PYTHON_VALUES 6 PYTHON_SIZEOF_VOID_P)
117 list(GET _PYTHON_VALUES 7 PYTHON_LIBRARY_SUFFIX)
118 list(GET _PYTHON_VALUES 8 PYTHON_LIBDIR)
119 list(GET _PYTHON_VALUES 9 PYTHON_MULTIARCH)
121 # Make sure the Python has the same pointer-size as the chosen compiler
122 # Skip if CMAKE_SIZEOF_VOID_P is not defined
123 if(CMAKE_SIZEOF_VOID_P AND (NOT "${PYTHON_SIZEOF_VOID_P}" STREQUAL "${CMAKE_SIZEOF_VOID_P}"))
124 if(PythonLibsNew_FIND_REQUIRED)
125 math(EXPR _PYTHON_BITS "${PYTHON_SIZEOF_VOID_P} * 8")
126 math(EXPR _CMAKE_BITS "${CMAKE_SIZEOF_VOID_P} * 8")
128 "Python config failure: Python is ${_PYTHON_BITS}-bit, "
129 "chosen compiler is ${_CMAKE_BITS}-bit")
131 set(PYTHONLIBS_FOUND FALSE)
132 set(PythonLibsNew_FOUND FALSE)
136 # The built-in FindPython didn't always give the version numbers
137 string(REGEX REPLACE "\\." ";" _PYTHON_VERSION_LIST ${_PYTHON_VERSION_LIST})
138 list(GET _PYTHON_VERSION_LIST 0 PYTHON_VERSION_MAJOR)
139 list(GET _PYTHON_VERSION_LIST 1 PYTHON_VERSION_MINOR)
140 list(GET _PYTHON_VERSION_LIST 2 PYTHON_VERSION_PATCH)
142 # Make sure all directory separators are '/'
143 string(REGEX REPLACE "\\\\" "/" PYTHON_PREFIX "${PYTHON_PREFIX}")
144 string(REGEX REPLACE "\\\\" "/" PYTHON_INCLUDE_DIR "${PYTHON_INCLUDE_DIR}")
145 string(REGEX REPLACE "\\\\" "/" PYTHON_SITE_PACKAGES "${PYTHON_SITE_PACKAGES}")
147 if(CMAKE_HOST_WIN32 AND NOT (MINGW AND DEFINED ENV{MSYSTEM}))
149 "${PYTHON_PREFIX}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib")
151 # when run in a venv, PYTHON_PREFIX points to it. But the libraries remain in the
152 # original python installation. They may be found relative to PYTHON_INCLUDE_DIR.
153 if(NOT EXISTS "${PYTHON_LIBRARY}")
154 get_filename_component(_PYTHON_ROOT ${PYTHON_INCLUDE_DIR} DIRECTORY)
156 "${_PYTHON_ROOT}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib")
159 # raise an error if the python libs are still not found.
160 if(NOT EXISTS "${PYTHON_LIBRARY}")
161 message(FATAL_ERROR "Python libraries not found")
166 set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}/${PYTHON_MULTIARCH}" "${PYTHON_LIBDIR}")
168 set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}")
170 #message(STATUS "Searching for Python libs in ${_PYTHON_LIBS_SEARCH}")
171 # Probably this needs to be more involved. It would be nice if the config
172 # information the python interpreter itself gave us were more complete.
173 find_library(PYTHON_LIBRARY
174 NAMES "python${PYTHON_LIBRARY_SUFFIX}"
175 PATHS ${_PYTHON_LIBS_SEARCH}
178 # If all else fails, just set the name/version and let the linker figure out the path.
179 if(NOT PYTHON_LIBRARY)
180 set(PYTHON_LIBRARY python${PYTHON_LIBRARY_SUFFIX})
189 # We use PYTHON_INCLUDE_DIR, PYTHON_LIBRARY and PYTHON_DEBUG_LIBRARY for the
190 # cache entries because they are meant to specify the location of a single
191 # library. We now set the variables listed by the documentation for this
193 SET(PYTHON_INCLUDE_DIRS "${PYTHON_INCLUDE_DIR}")
194 SET(PYTHON_LIBRARIES "${PYTHON_LIBRARY}")
195 SET(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}")
197 find_package_message(PYTHON
198 "Found PythonLibs: ${PYTHON_LIBRARY}"
199 "${PYTHON_EXECUTABLE}${PYTHON_VERSION}")
201 set(PYTHONLIBS_FOUND TRUE)
202 set(PythonLibsNew_FOUND TRUE)