FindPython2¶
Find Python 2 interpreter, compiler and development environment (include directories and libraries).
The following components are supported:
Interpreter
: search for Python 2 interpreterCompiler
: search for Python 2 compiler. Only offered by IronPython.Development
: search for development artifacts (include directories and libraries)NumPy
: search for NumPy include directories.
If no COMPONENTS
are specified, Interpreter
is assumed.
To ensure consistent versions between components Interpreter
, Compiler
,
Development
and NumPy
, specify all components at the same time:
find_package (Python2 COMPONENTS Interpreter Development)
This module looks only for version 2 of Python. This module can be used
concurrently with FindPython3
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.
Imported Targets¶
This module defines the following Imported Targets
(when CMAKE_ROLE
is PROJECT
):
Python2::Interpreter
Python 2 interpreter. Target defined if component
Interpreter
is found.Python2::Compiler
Python 2 compiler. Target defined if component
Compiler
is found.Python2::Python
Python 2 library for Python embedding. Target defined if component
Development
is found.Python2::Module
Python 2 library for Python module. Target defined if component
Development
is found.Python2::NumPy
NumPy library for Python 2. Target defined if component
NumPy
is found.
Result Variables¶
This module will set the following variables in your project (see Standard Variable Names):
Python2_FOUND
System has the Python 2 requested components.
Python2_Interpreter_FOUND
System has the Python 2 interpreter.
Python2_EXECUTABLE
Path to the Python 2 interpreter.
Python2_INTERPRETER_ID
- A short string unique to the interpreter. Possible values include:
Python
ActivePython
Anaconda
Canopy
IronPython
Python2_STDLIB
Standard platform independent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=True)
.Python2_STDARCH
Standard platform dependent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=True)
.Python2_SITELIB
Third-party platform independent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=False)
.Python2_SITEARCH
Third-party platform dependent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=False)
.Python2_Compiler_FOUND
System has the Python 2 compiler.
Python2_COMPILER
Path to the Python 2 compiler. Only offered by IronPython.
Python2_COMPILER_ID
- A short string unique to the compiler. Possible values include:
IronPython
Python2_Development_FOUND
System has the Python 2 development artifacts.
Python2_INCLUDE_DIRS
The Python 2 include directories.
Python2_LIBRARIES
The Python 2 libraries.
Python2_LIBRARY_DIRS
The Python 2 library directories.
Python2_RUNTIME_LIBRARY_DIRS
The Python 2 runtime library directories.
Python2_VERSION
Python 2 version.
Python2_VERSION_MAJOR
Python 2 major version.
Python2_VERSION_MINOR
Python 2 minor version.
Python2_VERSION_PATCH
Python 2 patch version.
Python2_NumPy_FOUND
System has the NumPy.
Python2_NumPy_INCLUDE_DIRS
The NumPy include directries.
Python2_NumPy_VERSION
The NumPy version.
Hints¶
Python2_ROOT_DIR
Define the root directory of a Python 2 installation.
Python2_USE_STATIC_LIBS
If not defined, search for shared libraries and static libraries in that order.
If set to TRUE, search only for static libraries.
If set to FALSE, search only for shared libraries.
Python2_FIND_STRATEGY
This variable defines how lookup will be done. The
Python2_FIND_STRATEGY
variable can be set to one of the following:Python2_FIND_REGISTRY
On Windows the
Python2_FIND_REGISTRY
variable determine the order of preference between registry and environment variables. thePython2_FIND_REGISTRY
variable can be set to 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.
Python2_FIND_FRAMEWORK
On macOS the
Python2_FIND_FRAMEWORK
variable determine the order of preference between Apple-style and unix-style package components. This variable can take same values asCMAKE_FIND_FRAMEWORK
variable.Note
Value
ONLY
is not supported soFIRST
will be used instead.If
Python2_FIND_FRAMEWORK
is not defined,CMAKE_FIND_FRAMEWORK
variable will be used, if any.Python2_FIND_VIRTUALENV
This variable defines the handling of virtual environments managed by
virtualenv
orconda
. It is meaningful only when a virtual environment is active (i.e. theactivate
script has been evaluated). In this case, it takes precedence overPython2_FIND_REGISTRY
andCMAKE_FIND_FRAMEWORK
variables. ThePython2_FIND_VIRTUALENV
variable can be set to 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, variablePython2_FIND_REGISTRY
(Windows) orCMAKE_FIND_FRAMEWORK
(macOS) can be set with valueLAST
orNEVER
to select preferably the interpreter from the virtual environment.
Note
If the component
Development
is requested, it is strongly recommended to also include the componentInterpreter
to get expected result.
Artifacts Specification¶
To solve special cases, it is possible to specify directly the artifacts by setting the following variables:
Python2_EXECUTABLE
The path to the interpreter.
Python2_COMPILER
The path to the compiler.
Python2_LIBRARY
The path to the library. It will be used to compute the variables
Python2_LIBRARIES
,Python2_LIBRAY_DIRS
andPython2_RUNTIME_LIBRARY_DIRS
.Python2_INCLUDE_DIR
The path to the directory of the
Python
headers. It will be used to compute the variablePython2_INCLUDE_DIRS
.Python2_NumPy_INCLUDE_DIR
The path to the directory of the
NumPy
headers. It will be used to compute the variablePython2_NumPy_INCLUDE_DIRS
.
Note
All paths must be absolute. Any artifact specified with a relative path will be ignored.
Note
When an artifact is specified, all HINTS
will be ignored and no search
will be performed for this artifact.
If more than one artifact is specified, it is the user’s responsability to ensure the consistency of the various artifacts.
Commands¶
This module defines the command Python2_add_library
(when
CMAKE_ROLE
is PROJECT
), which has the same semantics as
add_library()
and adds a dependency to target Python2::Python
or,
when library type is MODULE
, to target Python2::Module
and takes care
of Python module naming rules:
Python2_add_library (<name> [STATIC | SHARED | MODULE]
<source1> [<source2> ...])
If library type is not specified, MODULE
is assumed.