Find Python 3 interpreter, compiler and development environment (include directories and libraries).
Three components are supported:
Interpreter
: search for Python 3 interpreterCompiler
: search for Python 3 compiler. Only offered by IronPython.Development
: search for development artifacts (include directories and libraries)NumPy
: search for NumPy include directories.If no COMPONENTS
is specified, Interpreter
is assumed.
To ensure consistent versions between components Interpreter
, Compiler
, Development
and NumPy
, specify all components at the same time:
find_package (Python3 COMPONENTS Interpreter Development)
This module looks only for version 3 of Python. This module can be used concurrently with FindPython2
module to use both Python versions.
The FindPython
module can be used if Python version does not matter for you.
Note
If components Interpreter
and Development
are both specified, this module search only for interpreter with same platform architecture as the one defined by CMake
configuration. This contraint does not apply if only Interpreter
component is specified.
This module defines the following Imported Targets (when CMAKE_ROLE
is PROJECT
):
Python3::Interpreter
Interpreter
is found.Python3::Compiler
Compiler
is found.Python3::Python
Development
is found.Python3::Module
Development
is found.Python3::NumPy
NumPy
is found.This module will set the following variables in your project (see Standard Variable Names):
Python3_FOUND
Python3_Interpreter_FOUND
Python3_EXECUTABLE
Python3_INTERPRETER_ID
Python3_STDLIB
Standard platform independent installation directory.
Information returned by distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=True)
.
Python3_STDARCH
Standard platform dependent installation directory.
Information returned by distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=True)
.
Python3_SITELIB
Third-party platform independent installation directory.
Information returned by distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=False)
.
Python3_SITEARCH
Third-party platform dependent installation directory.
Information returned by distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=False)
.
Python3_Compiler_FOUND
Python3_COMPILER
Python3_COMPILER_ID
Python3_Development_FOUND
Python3_INCLUDE_DIRS
Python3_LIBRARIES
Python3_LIBRARY_DIRS
Python3_RUNTIME_LIBRARY_DIRS
Python3_VERSION
Python3_VERSION_MAJOR
Python3_VERSION_MINOR
Python3_VERSION_PATCH
Python3_NumPy_FOUND
Python3_NumPy_INCLUDE_DIRS
Python3_NumPy_VERSION
Python3_ROOT_DIR
Python3_USE_STATIC_LIBS
Python3_FIND_STRATEGY
This variable defines how lookup will be done. The Python3_FIND_STRATEGY
variable can be set to empty or one of the following:
Python3_FIND_REGISTRY
On Windows the Python3_FIND_REGISTRY
variable determine the order of preference between registry and environment variables. The Python3_FIND_REGISTRY
variable can be set to empty or one of the following:
FIRST
: Try to use registry before environment variables. This is the default.LAST
: Try to use registry after environment variables.NEVER
: Never try to use registry.Python3_FIND_FRAMEWORK
On macOS the Python3_FIND_FRAMEWORK
variable determine the order of preference between Apple-style and unix-style package components. This variable can be set to empty or take same values as CMAKE_FIND_FRAMEWORK
variable.
Note
Value ONLY
is not supported so FIRST
will be used instead.
If Python3_FIND_FRAMEWORK
is not defined, CMAKE_FIND_FRAMEWORK
variable will be used, if any.
Python3_FIND_VIRTUALENV
This variable defines the handling of virtual environments. It is meaningfull only when a virtual environment is active (i.e. the activate
script has been evaluated). In this case, it takes precedence over Python3_FIND_REGISTRY
and CMAKE_FIND_FRAMEWORK
variables. The Python3_FIND_VIRTUALENV
variable can be set to empty or one of the following:
FIRST
: The virtual environment is used before any other standard paths to look-up for the interpreter. This is the default.ONLY
: Only the virtual environment is used to look-up for the interpreter.STANDARD
: The virtual environment is not used to look-up for the interpreter. In this case, variable Python3_FIND_REGISTRY
(Windows) or CMAKE_FIND_FRAMEWORK
(macOS) can be set with value LAST
or NEVER
to select preferably the interpreter from the virtual environment.This module defines the command Python_add_library
(when CMAKE_ROLE
is PROJECT
), which has the same semantics as add_library()
and adds a dependency to target Python3::Python
or, when library type is MODULE
, to target Python3::Module
and takes care of Python module naming rules:
Python3_add_library (my_module MODULE src1.cpp)
If library type is not specified, MODULE
is assumed.
© 2000–2019 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.15/module/FindPython3.html