2016-09-27 19:01:08 +00:00
|
|
|
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
|
|
# file Copyright.txt or https://cmake.org/licensing for details.
|
|
|
|
|
2018-10-22 14:31:08 +00:00
|
|
|
#[=======================================================================[.rst:
|
|
|
|
FindPythonInterp
|
|
|
|
----------------
|
|
|
|
|
|
|
|
.. deprecated:: 3.12
|
|
|
|
|
|
|
|
Use :module:`FindPython3`, :module:`FindPython2` or :module:`FindPython` instead.
|
|
|
|
|
2018-10-25 10:23:33 +00:00
|
|
|
Find python interpreter
|
|
|
|
|
2018-10-22 14:31:08 +00:00
|
|
|
This module finds if Python interpreter is installed and determines
|
|
|
|
where the executables are. This code sets the following variables:
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
PYTHONINTERP_FOUND - Was the Python executable found
|
|
|
|
PYTHON_EXECUTABLE - path to the Python interpreter
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
PYTHON_VERSION_STRING - Python version found e.g. 2.5.2
|
|
|
|
PYTHON_VERSION_MAJOR - Python major version found e.g. 2
|
|
|
|
PYTHON_VERSION_MINOR - Python minor version found e.g. 5
|
|
|
|
PYTHON_VERSION_PATCH - Python patch version found e.g. 2
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Python_ADDITIONAL_VERSIONS variable can be used to specify a list
|
|
|
|
of version numbers that should be taken into account when searching
|
|
|
|
for Python. You need to set this variable before calling
|
|
|
|
find_package(PythonInterp).
|
|
|
|
|
|
|
|
If calling both ``find_package(PythonInterp)`` and
|
|
|
|
``find_package(PythonLibs)``, call ``find_package(PythonInterp)`` first to
|
|
|
|
get the currently active Python version by default with a consistent version
|
|
|
|
of PYTHON_LIBRARIES.
|
2019-07-30 16:07:37 +00:00
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
A call to ``find_package(PythonInterp ${V})`` for python version ``V``
|
|
|
|
may find a ``python`` executable with no version suffix. In this case
|
|
|
|
no attempt is made to avoid python executables from other versions.
|
|
|
|
Use :module:`FindPython3`, :module:`FindPython2` or :module:`FindPython`
|
|
|
|
instead.
|
|
|
|
|
2018-10-22 14:31:08 +00:00
|
|
|
#]=======================================================================]
|
2005-07-15 12:36:33 +00:00
|
|
|
|
2012-01-17 17:25:10 +00:00
|
|
|
unset(_Python_NAMES)
|
|
|
|
|
|
|
|
set(_PYTHON1_VERSIONS 1.6 1.5)
|
|
|
|
set(_PYTHON2_VERSIONS 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0)
|
2020-01-14 18:41:29 +00:00
|
|
|
set(_PYTHON3_VERSIONS 3.9 3.8 3.7 3.6 3.5 3.4 3.3 3.2 3.1 3.0)
|
2012-01-17 17:25:10 +00:00
|
|
|
|
|
|
|
if(PythonInterp_FIND_VERSION)
|
2013-08-31 15:46:44 +00:00
|
|
|
if(PythonInterp_FIND_VERSION_COUNT GREATER 1)
|
|
|
|
set(_PYTHON_FIND_MAJ_MIN "${PythonInterp_FIND_VERSION_MAJOR}.${PythonInterp_FIND_VERSION_MINOR}")
|
|
|
|
list(APPEND _Python_NAMES
|
|
|
|
python${_PYTHON_FIND_MAJ_MIN}
|
|
|
|
python${PythonInterp_FIND_VERSION_MAJOR})
|
2012-01-17 17:25:10 +00:00
|
|
|
unset(_PYTHON_FIND_OTHER_VERSIONS)
|
|
|
|
if(NOT PythonInterp_FIND_VERSION_EXACT)
|
2013-08-31 15:46:44 +00:00
|
|
|
foreach(_PYTHON_V ${_PYTHON${PythonInterp_FIND_VERSION_MAJOR}_VERSIONS})
|
2012-01-17 17:25:10 +00:00
|
|
|
if(NOT _PYTHON_V VERSION_LESS _PYTHON_FIND_MAJ_MIN)
|
|
|
|
list(APPEND _PYTHON_FIND_OTHER_VERSIONS ${_PYTHON_V})
|
|
|
|
endif()
|
|
|
|
endforeach()
|
2012-08-13 17:50:14 +00:00
|
|
|
endif()
|
2012-01-17 17:25:10 +00:00
|
|
|
unset(_PYTHON_FIND_MAJ_MIN)
|
2012-08-13 17:50:14 +00:00
|
|
|
else()
|
2013-08-31 15:46:44 +00:00
|
|
|
list(APPEND _Python_NAMES python${PythonInterp_FIND_VERSION_MAJOR})
|
|
|
|
set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON${PythonInterp_FIND_VERSION_MAJOR}_VERSIONS})
|
2012-08-13 17:50:14 +00:00
|
|
|
endif()
|
|
|
|
else()
|
2012-01-17 17:25:10 +00:00
|
|
|
set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON3_VERSIONS} ${_PYTHON2_VERSIONS} ${_PYTHON1_VERSIONS})
|
2012-08-13 17:50:14 +00:00
|
|
|
endif()
|
2012-01-17 17:25:10 +00:00
|
|
|
find_program(PYTHON_EXECUTABLE NAMES ${_Python_NAMES})
|
2011-07-14 09:16:00 +00:00
|
|
|
|
2011-01-10 18:44:45 +00:00
|
|
|
# Set up the versions we know about, in the order we will search. Always add
|
|
|
|
# the user supplied additional versions to the front.
|
2014-03-05 22:01:26 +00:00
|
|
|
set(_Python_VERSIONS ${Python_ADDITIONAL_VERSIONS})
|
|
|
|
# If FindPythonInterp has already found the major and minor version,
|
|
|
|
# insert that version next to get consistent versions of the interpreter and
|
|
|
|
# library.
|
|
|
|
if(DEFINED PYTHONLIBS_VERSION_STRING)
|
|
|
|
string(REPLACE "." ";" _PYTHONLIBS_VERSION "${PYTHONLIBS_VERSION_STRING}")
|
|
|
|
list(GET _PYTHONLIBS_VERSION 0 _PYTHONLIBS_VERSION_MAJOR)
|
|
|
|
list(GET _PYTHONLIBS_VERSION 1 _PYTHONLIBS_VERSION_MINOR)
|
|
|
|
list(APPEND _Python_VERSIONS ${_PYTHONLIBS_VERSION_MAJOR}.${_PYTHONLIBS_VERSION_MINOR})
|
|
|
|
endif()
|
|
|
|
# Search for the current active python version first
|
|
|
|
list(APPEND _Python_VERSIONS ";")
|
|
|
|
list(APPEND _Python_VERSIONS ${_PYTHON_FIND_OTHER_VERSIONS})
|
2012-01-17 17:25:10 +00:00
|
|
|
|
|
|
|
unset(_PYTHON_FIND_OTHER_VERSIONS)
|
|
|
|
unset(_PYTHON1_VERSIONS)
|
|
|
|
unset(_PYTHON2_VERSIONS)
|
|
|
|
unset(_PYTHON3_VERSIONS)
|
2011-01-10 18:44:45 +00:00
|
|
|
|
2011-08-05 07:53:39 +00:00
|
|
|
# Search for newest python version if python executable isn't found
|
2011-01-10 18:44:45 +00:00
|
|
|
if(NOT PYTHON_EXECUTABLE)
|
2014-03-05 22:01:26 +00:00
|
|
|
foreach(_CURRENT_VERSION IN LISTS _Python_VERSIONS)
|
2011-07-14 09:16:00 +00:00
|
|
|
set(_Python_NAMES python${_CURRENT_VERSION})
|
2017-04-07 15:31:12 +00:00
|
|
|
if(CMAKE_HOST_WIN32)
|
2011-07-14 09:16:00 +00:00
|
|
|
list(APPEND _Python_NAMES python)
|
|
|
|
endif()
|
|
|
|
find_program(PYTHON_EXECUTABLE
|
|
|
|
NAMES ${_Python_NAMES}
|
2017-04-07 15:31:12 +00:00
|
|
|
PATHS
|
|
|
|
[HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]
|
|
|
|
[HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}-32\\InstallPath]
|
|
|
|
[HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}-64\\InstallPath]
|
2018-01-19 11:13:03 +00:00
|
|
|
[HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]
|
|
|
|
[HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}-32\\InstallPath]
|
|
|
|
[HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}-64\\InstallPath]
|
2011-07-14 09:16:00 +00:00
|
|
|
)
|
|
|
|
endforeach()
|
2011-01-10 18:44:45 +00:00
|
|
|
endif()
|
|
|
|
|
2011-08-05 07:53:39 +00:00
|
|
|
# determine python version string
|
2011-07-14 09:43:47 +00:00
|
|
|
if(PYTHON_EXECUTABLE)
|
2012-02-26 08:29:02 +00:00
|
|
|
execute_process(COMMAND "${PYTHON_EXECUTABLE}" -c
|
|
|
|
"import sys; sys.stdout.write(';'.join([str(x) for x in sys.version_info[:3]]))"
|
|
|
|
OUTPUT_VARIABLE _VERSION
|
2012-01-27 20:15:53 +00:00
|
|
|
RESULT_VARIABLE _PYTHON_VERSION_RESULT
|
2012-02-26 08:29:02 +00:00
|
|
|
ERROR_QUIET)
|
|
|
|
if(NOT _PYTHON_VERSION_RESULT)
|
|
|
|
string(REPLACE ";" "." PYTHON_VERSION_STRING "${_VERSION}")
|
|
|
|
list(GET _VERSION 0 PYTHON_VERSION_MAJOR)
|
|
|
|
list(GET _VERSION 1 PYTHON_VERSION_MINOR)
|
|
|
|
list(GET _VERSION 2 PYTHON_VERSION_PATCH)
|
|
|
|
if(PYTHON_VERSION_PATCH EQUAL 0)
|
|
|
|
# it's called "Python 2.7", not "2.7.0"
|
|
|
|
string(REGEX REPLACE "\\.0$" "" PYTHON_VERSION_STRING "${PYTHON_VERSION_STRING}")
|
|
|
|
endif()
|
|
|
|
else()
|
|
|
|
# sys.version predates sys.version_info, so use that
|
2019-01-21 15:41:59 +00:00
|
|
|
# sys.version was first documented for Python 1.5, so assume version 1.4
|
|
|
|
# if retrieving sys.version fails.
|
|
|
|
execute_process(COMMAND "${PYTHON_EXECUTABLE}" -c "try: import sys; sys.stdout.write(sys.version)\nexcept: sys.stdout.write(\"1.4.0\")"
|
2012-02-26 08:29:02 +00:00
|
|
|
OUTPUT_VARIABLE _VERSION
|
2012-01-27 20:15:53 +00:00
|
|
|
RESULT_VARIABLE _PYTHON_VERSION_RESULT
|
2012-02-26 08:29:02 +00:00
|
|
|
ERROR_QUIET)
|
|
|
|
if(NOT _PYTHON_VERSION_RESULT)
|
|
|
|
string(REGEX REPLACE " .*" "" PYTHON_VERSION_STRING "${_VERSION}")
|
|
|
|
string(REGEX REPLACE "^([0-9]+)\\.[0-9]+.*" "\\1" PYTHON_VERSION_MAJOR "${PYTHON_VERSION_STRING}")
|
|
|
|
string(REGEX REPLACE "^[0-9]+\\.([0-9])+.*" "\\1" PYTHON_VERSION_MINOR "${PYTHON_VERSION_STRING}")
|
2014-04-06 19:30:00 +00:00
|
|
|
if(PYTHON_VERSION_STRING MATCHES "^[0-9]+\\.[0-9]+\\.([0-9]+)")
|
|
|
|
set(PYTHON_VERSION_PATCH "${CMAKE_MATCH_1}")
|
2012-02-26 08:29:02 +00:00
|
|
|
else()
|
|
|
|
set(PYTHON_VERSION_PATCH "0")
|
|
|
|
endif()
|
|
|
|
else()
|
2019-01-21 15:41:59 +00:00
|
|
|
unset(PYTHON_VERSION_STRING)
|
|
|
|
unset(PYTHON_VERSION_MAJOR)
|
|
|
|
unset(PYTHON_VERSION_MINOR)
|
|
|
|
unset(PYTHON_VERSION_PATCH)
|
2012-01-19 22:31:38 +00:00
|
|
|
endif()
|
|
|
|
endif()
|
2012-01-27 20:15:53 +00:00
|
|
|
unset(_PYTHON_VERSION_RESULT)
|
|
|
|
unset(_VERSION)
|
2012-08-13 17:50:14 +00:00
|
|
|
endif()
|
2005-07-15 12:36:33 +00:00
|
|
|
|
Modules: Include builtin FindPackageHandleStandardArgs directly
The FindPackageHandleStandardArgs module was originally created outside
of CMake. It was added for CMake 2.6.0 by commit e118a627 (add a macro
FIND_PACKAGE_HANDLE_STANDARD_ARGS..., 2007-07-18). However, it also
proliferated into a number of other projects that at the time required
only CMake 2.4 and thus could not depend on CMake to provide the module.
CMake's own find modules started using the module in commit b5f656e0
(use the new FIND_PACKAGE_HANDLE_STANDARD_ARGS in some of the FindXXX
modules..., 2007-07-18).
Then commit d358cf5c (add 2nd, more powerful mode to
find_package_handle_standard_args, 2010-07-29) added a new feature to
the interface of the module that was fully optional and backward
compatible with all existing users of the module. Later commit 5f183caa
(FindZLIB: use the FPHSA version mode, 2010-08-04) and others shortly
thereafter started using the new interface in CMake's own find modules.
This change was also backward compatible because it was only an
implementation detail within each module.
Unforutnately these changes introduced a problem for projects that still
have an old copy of FindPackageHandleStandardArgs in CMAKE_MODULE_PATH.
When any such project uses one of CMake's builtin find modules the line
include(FindPackageHandleStandardArgs)
loads the copy from the project which does not have the new interface!
Then the including find module tries to use the new interface with the
old module and fails.
Whether this breakage can be considered a backward incompatible change
in CMake is debatable. The situation is analagous to copying a standard
library header from one version of a compiler into a project and then
observing problems when the next version of the compiler reports errors
in its other headers that depend on its new version of the original
header. Nevertheless it is a change to CMake that causes problems for
projects that worked with previous versions.
This problem was discovered during the 2.8.3 release candidate cycle.
It is an instance of a more general problem with projects that provide
their own versions of CMake modules when other CMake modules depend on
them. At the time we resolved this instance of the problem with commit
b0118402 (Use absolute path to FindPackageHandleStandardArgs.cmake
everywhere, 2010-09-28) for the 2.8.3 release.
In order to address the more general problem we introduced policy
CMP0017 in commit db44848f (Prefer files from CMAKE_ROOT when including
from CMAKE_ROOT, 2010-11-17). That change was followed by commit
ce28737c (Remove usage of CMAKE_CURRENT_LIST_DIR now that we have
CMP0017, 2010-12-20) which reverted the original workaround in favor of
using the policy. However, existing project releases do not set the
policy behavior to NEW and therefore still exhibit the problem.
We introduced in commit a364daf1 (Allow users to specify defaults for
unset policies, 2011-01-03) an option for users to build existing
projects by adding -DCMAKE_POLICY_DEFAULT_CMP0017=NEW to the command
line. Unfortunately this solution still does not allow such projects to
build out of the box, and there is no good way to suggest the use of the
new option.
The only remaining solution to keep existing projects that exhibit this
problem building is to restore the change originally made in commit
b0118402 (Use absolute path to FindPackageHandleStandardArgs.cmake
everywhere, 2010-09-28). This also avoids policy CMP0017 warnings for
this particular instance of the problem the policy addresses.
2011-01-20 15:56:49 +00:00
|
|
|
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
|
2011-08-23 07:36:17 +00:00
|
|
|
FIND_PACKAGE_HANDLE_STANDARD_ARGS(PythonInterp REQUIRED_VARS PYTHON_EXECUTABLE VERSION_VAR PYTHON_VERSION_STRING)
|
2007-07-23 15:22:14 +00:00
|
|
|
|
2011-01-10 18:44:45 +00:00
|
|
|
mark_as_advanced(PYTHON_EXECUTABLE)
|