FindPython3¶
Find Python 3 interpreter, compiler and development environment (include directories and libraries).
The following 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 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 (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.
Imported Targets¶
This module defines the following Imported Targets
(when CMAKE_ROLE is PROJECT):
Python3::Interpreter- Python 3 interpreter. Target defined if component
Interpreteris found. Python3::Compiler- Python 3 compiler. Target defined if component
Compileris found. Python3::Python- Python 3 library for Python embedding. Target defined if component
Developmentis found. Python3::Module- Python 3 library for Python module. Target defined if component
Developmentis found. Python3::NumPy- NumPy library for Python 3. Target defined if component
NumPyis found.
Result Variables¶
This module will set the following variables in your project (see Standard Variable Names):
Python3_FOUND- System has the Python 3 requested components.
Python3_Interpreter_FOUND- System has the Python 3 interpreter.
Python3_EXECUTABLE- Path to the Python 3 interpreter.
Python3_INTERPRETER_ID- A short string unique to the interpreter. Possible values include:
- Python
- ActivePython
- Anaconda
- Canopy
- IronPython
Python3_STDLIBStandard platform independent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=True).Python3_STDARCHStandard platform dependent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=True).Python3_SITELIBThird-party platform independent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=False).Python3_SITEARCHThird-party platform dependent installation directory.
Information returned by
distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=False).Python3_SOABIExtension suffix for modules.
Information returned by
distutils.sysconfig.get_config_flag('SOABI')or computed fromdistutils.sysconfig.get_config_flag('EXT_SUFFIX')orpython3-config --extension-suffix.Python3_Compiler_FOUND- System has the Python 3 compiler.
Python3_COMPILER- Path to the Python 3 compiler. Only offered by IronPython.
Python3_COMPILER_ID- A short string unique to the compiler. Possible values include:
- IronPython
Python3_Development_FOUND- System has the Python 3 development artifacts.
Python3_INCLUDE_DIRS- The Python 3 include directories.
Python3_LIBRARIES- The Python 3 libraries.
Python3_LIBRARY_DIRS- The Python 3 library directories.
Python3_RUNTIME_LIBRARY_DIRS- The Python 3 runtime library directories.
Python3_VERSION- Python 3 version.
Python3_VERSION_MAJOR- Python 3 major version.
Python3_VERSION_MINOR- Python 3 minor version.
Python3_VERSION_PATCH- Python 3 patch version.
Python3_NumPy_FOUND- System has the NumPy.
Python3_NumPy_INCLUDE_DIRS- The NumPy include directries.
Python3_NumPy_VERSION- The NumPy version.
Hints¶
Python3_ROOT_DIR- Define the root directory of a Python 3 installation.
Python3_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.
Python3_FIND_ABIThis variable defines which ABIs, as defined in PEP 3149, should be searched.
Note
If
Python3_FIND_ABIis not defined, any ABI will be searched.The
Python3_FIND_ABIvariable is a 3-tuple specifying, in that order,pydebug(d),pymalloc(m) andunicode(u) flags. Each element can be set to one of the following:ON: Corresponding flag is selected.OFF: Corresponding flag is not selected.ANY: The two posibilties (ONandOFF) will be searched.
From this 3-tuple, various ABIs will be searched starting from the most specialized to the most general. Moreover,
debugversions will be searched afternon-debugones.For example, if we have:
set (Python3_FIND_ABI "ON" "ANY" "ANY")
The following flags combinations will be appended, in that order, to the artifact names:
dmu,dm,du, andd.And to search any possible ABIs:
set (Python3_FIND_ABI "ANY" "ANY" "ANY")
The following combinations, in that order, will be used:
mu,m,u,<empty>,dmu,dm,duandd.Note
This hint is useful only on
POSIXsystems. So, onWindowssystems, whenPython3_FIND_ABIis defined,Pythondistributions from python.org will be found only if value for each flag isOFForANY.Python3_FIND_STRATEGYThis variable defines how lookup will be done. The
Python3_FIND_STRATEGYvariable can be set to one of the following:Python3_FIND_REGISTRYOn Windows the
Python3_FIND_REGISTRYvariable determine the order of preference between registry and environment variables. ThePython3_FIND_REGISTRYvariable 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.
Python3_FIND_FRAMEWORKOn macOS the
Python3_FIND_FRAMEWORKvariable determine the order of preference between Apple-style and unix-style package components. This variable can take same values asCMAKE_FIND_FRAMEWORKvariable.Note
Value
ONLYis not supported soFIRSTwill be used instead.If
Python3_FIND_FRAMEWORKis not defined,CMAKE_FIND_FRAMEWORKvariable will be used, if any.Python3_FIND_VIRTUALENVThis variable defines the handling of virtual environments managed by
virtualenvorconda. It is meaningful only when a virtual environment is active (i.e. theactivatescript has been evaluated). In this case, it takes precedence overPython3_FIND_REGISTRYandCMAKE_FIND_FRAMEWORKvariables. ThePython3_FIND_VIRTUALENVvariable 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, variablePython3_FIND_REGISTRY(Windows) orCMAKE_FIND_FRAMEWORK(macOS) can be set with valueLASTorNEVERto select preferably the interpreter from the virtual environment.
Note
If the component
Developmentis requested, it is strongly recommended to also include the componentInterpreterto get expected result.
Artifacts Specification¶
To solve special cases, it is possible to specify directly the artifacts by setting the following variables:
Python3_EXECUTABLE- The path to the interpreter.
Python3_COMPILER- The path to the compiler.
Python3_LIBRARY- The path to the library. It will be used to compute the
variables
Python3_LIBRARIES,Python3_LIBRAY_DIRSandPython3_RUNTIME_LIBRARY_DIRS. Python3_INCLUDE_DIR- The path to the directory of the
Pythonheaders. It will be used to compute the variablePython3_INCLUDE_DIRS. Python3_NumPy_INCLUDE_DIR- The path to the directory of the
NumPyheaders. It will be used to compute the variablePython3_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 Python3_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 (<name> [STATIC | SHARED | MODULE [WITH_SOABI]]
<source1> [<source2> ...])
If the library type is not specified, MODULE is assumed.
For MODULE library type, if option WITH_SOABI is specified, the
module suffix will include the Python3_SOABI value, if any.