FindPython2¶
New in version 3.12.
Find Python 2 interpreter, compiler and development environment (include directories and libraries).
New in version 3.19: When a version is requested, it can be specified as a simple value or as a
range. For a detailed description of version range usage and capabilities,
refer to the find_package()
command.
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).New in version 3.18: This component includes two sub-components which can be specified independently:
Development.Module
: search for artifacts for Python 2 module developments.Development.Embed
: search for artifacts for Python 2 embedding developments.
NumPy
: search for NumPy include directories.
New in version 3.14: Added the NumPy
component.
If no COMPONENTS
are specified, Interpreter
is assumed.
If component Development
is specified, it implies sub-components
Development.Module
and Development.Embed
.
To ensure consistent versions between components Interpreter
, Compiler
,
Development
(or one of its sub-components) 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
(or one of its
sub-components) are both specified, this module search only for interpreter
with same platform architecture as the one defined by CMake
configuration. This constraint does not apply if only Interpreter
component is specified.
Imported Targets¶
This module defines the following Imported Targets:
Changed in version 3.14: Imported Targets are only created 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::Module
New in version 3.15.
Python 2 library for Python module. Target defined if component
Development.Module
is found.Python2::Python
Python 2 library for Python embedding. Target defined if component
Development.Embed
is found.Python2::NumPy
New in version 3.14.
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
PyPy
Python2_STDLIB
Standard platform independent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=True)
or elsesysconfig.get_path('stdlib')
.Python2_STDARCH
Standard platform dependent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=True)
or elsesysconfig.get_path('platstdlib')
.Python2_SITELIB
Third-party platform independent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=False)
or elsesysconfig.get_path('purelib')
.Python2_SITEARCH
Third-party platform dependent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=False)
or elsesysconfig.get_path('platlib')
.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_DOTNET_LAUNCHER
New in version 3.18.
The
.Net
interpreter. Only used byIronPython
implementation.Python2_Development_FOUND
System has the Python 2 development artifacts.
Python2_Development.Module_FOUND
New in version 3.18.
System has the Python 2 development artifacts for Python module.
Python2_Development.Embed_FOUND
New in version 3.18.
System has the Python 2 development artifacts for Python embedding.
Python2_INCLUDE_DIRS
The Python 2 include directories.
Python2_LINK_OPTIONS
New in version 3.19.
The Python 2 link options. Some configurations require specific link options for a correct build and execution.
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_PyPy_VERSION
New in version 3.18.
Python 2 PyPy version.
Python2_NumPy_FOUND
New in version 3.14.
System has the NumPy.
Python2_NumPy_INCLUDE_DIRS
New in version 3.14.
The NumPy include directories.
Python2_NumPy_VERSION
New in version 3.14.
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.
Note
This hint will be ignored on
Windows
because static libraries are not available on this platform.Python2_FIND_STRATEGY
New in version 3.15.
This variable defines how lookup will be done. The
Python2_FIND_STRATEGY
variable can be set to one of the following:Python2_FIND_REGISTRY
New in version 3.13.
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
New in version 3.15.
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
New in version 3.15.
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 but environment variablePATH
is always considered. 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.
New in version 3.17: Added support for
conda
environments.Note
If the component
Development
is requested, it is strongly recommended to also include the componentInterpreter
to get expected result.Python2_FIND_IMPLEMENTATIONS
New in version 3.18.
This variable defines, in an ordered list, the different implementations which will be searched. The
Python2_FIND_IMPLEMENTATIONS
variable can hold the following values:CPython
: this is the standard implementation. Various products, likeAnaconda
orActivePython
, rely on this implementation.IronPython
: This implementation use theCSharp
language for.NET Framework
on top of the Dynamic Language Runtime (DLR
). See IronPython.PyPy
: This implementation useRPython
language andRPython translation toolchain
to produce the python interpreter. See PyPy.
The default value is:
Windows platform:
CPython
,IronPython
Other platforms:
CPython
Note
This hint has the lowest priority of all hints, so even if, for example, you specify
IronPython
first andCPython
in second, a python product based onCPython
can be selected because, for example withPython2_FIND_STRATEGY=LOCATION
, each location will be search first forIronPython
and second forCPython
.Note
When
IronPython
is specified, on platforms other thanWindows
, the.Net
interpreter (i.e.mono
command) is expected to be available through thePATH
variable.Python2_FIND_UNVERSIONED_NAMES
New in version 3.20.
This variable defines how the generic names will be searched. Currently, it only applies to the generic names of the interpreter, namely,
python2
andpython
. ThePython2_FIND_UNVERSIONED_NAMES
variable can be set to one of the following values:FIRST
: The generic names are searched before the more specialized ones (such aspython2.5
for example).LAST
: The generic names are searched after the more specialized ones. This is the default.NEVER
: The generic name are not searched at all.
Artifacts Specification¶
New in version 3.16.
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_DOTNET_LAUNCHER
New in version 3.18.
The
.Net
interpreter. Only used byIronPython
implementation.Python2_LIBRARY
The path to the library. It will be used to compute the variables
Python2_LIBRARIES
,Python2_LIBRARY_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 responsibility to ensure the consistency of the various artifacts.
By default, this module supports multiple calls in different directories of a
project with different version/component requirements while providing correct
and consistent results for each call. To support this behavior, CMake
cache
is not used in the traditional way which can be problematic for interactive
specification. So, to enable also interactive specification, module behavior
can be controlled with the following variable:
Python2_ARTIFACTS_INTERACTIVE
New in version 3.18.
Selects the behavior of the module. This is a boolean variable:
If set to
TRUE
: Create CMake cache entries for the above artifact specification variables so that users can edit them interactively. This disables support for multiple version/component requirements.If set to
FALSE
or undefined: Enable multiple version/component requirements.
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.