C++ CMake 使用 Python3

本是古典何须时尚 2021-09-25 01:48 991阅读 0赞

# C++ CMake 使用 Python3 #

## CMakeListst 设置 ##

# 如果使用的是非系统目录下的 Python 可以通过指定 Python3_ROOT_DIR 改变查找路径
    # set(Python3_ROOT_DIR "${CMAKE_SOURCE_DIR}/venv")
    find_package(Python3 COMPONENTS Interpreter Development REQUIRED)
    add_executable(cpp-python-test main.cpp)
    target_include_directories(${PROJECT_NAME} PRIVATE ${Python3_INCLUDE_DIRS})
    target_link_libraries(${PROJECT_NAME} ${Python3_LIBRARIES})

## 测试代码 ##

#include <Python.h>
    
    int main(int, char **)
    { 
        Py_Initialize();
        PyRun_SimpleString("print('Hello World')");
        Py_Finalize();
        return 0;
    }

## FindPython3 ##

找到 Python3 的解释器、编译器和开发环境（包括 include 的文件和库文件）

提供如下组件：

*  `Interpreter`：寻找 Python3 解释器
 *  `Compiler`：寻找 Python3 编译器。仅使用 `IronPython` 时提供
 *  `Development`：寻找开发环境套件（包含 include 目录和库文件）
 *  `NumPy`：寻找 `NumPy` 的 include 目录

如果没有 `COMPONENT` 被指定，那么默认使用 `Interpreter`

为了确保所有组件 `Interperter`，`Compiler`，`Development`，`NumPy`的版本一致，需要同时指定所有的组件，如下所示：

find_package(Python3 COMPONENTS Interpreter Development)

这个模块仅寻找 Python3 的版本。该模块可以和 `FindPython2` 同时使用，以便可以使用两个版本的 Python

同时如果 python 的版本对你并无大碍，可以使用 `FindPython` 模块

> 注意：如果 `Interpreter` 和 `Development` 组件都被指定的话，这个模块只会搜索 `Cmake` 配置的平台架构的解释器。如果仅指定了 `Interpreter` 组件的话，这个约束不会生效。

### 导入的目标 ###

这个模块定义了如下几个导入目标（当 `CMAKE_ROLE` 为项目时）

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">Python3::Interpreter</td> 
   <td>Python3 解释器。如果找到 <code>Interpreter</code> 组件那么目标会被定义。</td> 
  </tr> 
  <tr> 
   <td align="left">Python3::Compiler</td> 
   <td>Python3 编译器。如果找到 <code>Compiler</code> 组件那么目标有定义。</td> 
  </tr> 
  <tr> 
   <td align="left">Python3::Python</td> 
   <td>Python3 嵌入库。如果找到 <code>Development</code> 组件那么目标有定义。</td> 
  </tr> 
  <tr> 
   <td align="left">Python3::Module</td> 
   <td>Python3 模块。如果找到 <code>Development</code> 组件那么目标有定义。</td> 
  </tr> 
  <tr> 
   <td align="left">Python3::NumPy</td> 
   <td>Python3 的 Numpy 组件。如果找到 <code>NumPy</code> 组件那么目标有定义。</td> 
  </tr> 
 </tbody> 
</table>

### 结果变量 ###

这个模块会在项目中定义下列的变量（可以查看标准变量命名）

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Python3_Found</td> 
   <td>系统具有 Python3 需要的组件</td> 
  </tr> 
  <tr> 
   <td>Python3_Interpreter_Found</td> 
   <td>系统具有 Python3 解释器</td> 
  </tr> 
  <tr> 
   <td>Python3_EXECUTABLE</td> 
   <td>Python3 解释器的路径</td> 
  </tr> 
  <tr> 
   <td>Python3_INTERPRETER_ID</td> 
   <td>解释器名称的唯一标识，可能是 <code>Python</code>、<code>ActivePython</code>、<code>Anaconda</code>、<code>Canopy</code>、<code>IronPython</code>之一</td> 
  </tr> 
  <tr> 
   <td>Python3_STDLIB</td> 
   <td>标准平台独立安装的目录。可以通过 <code>distutils.sysconfig.get_python_lib(plat_specific=False, standard_lib=True)</code> 获取信息</td> 
  </tr> 
  <tr> 
   <td>Python3_STDARCH</td> 
   <td>标准平台依赖安装的目录。可以通过 <code>distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=True)</code> 获取信息</td> 
  </tr> 
  <tr> 
   <td>Python3_SOABI</td> 
   <td>模块的扩展名后缀。可以通过 <code>distutils.sysconfig.get_config_flag('SOABI')</code> 或 <code>distutils.sysconfig.get_config_flag('EXT_SUFFIX')</code> 或 <code>python3-config --extension-suffix</code> 获取信息</td> 
  </tr> 
  <tr> 
   <td>Python3_Compiler_FOUND</td> 
   <td>系统具有 Python3 编译器</td> 
  </tr> 
  <tr> 
   <td>Python3_COMPILER</td> 
   <td>Python3 编译器的路径，只有使用 <code>IronPython</code> 时提供</td> 
  </tr> 
  <tr> 
   <td>Python3_COMPILER_ID</td> 
   <td>编译器名称的唯一标识，可能是 <code>IronPython</code></td> 
  </tr> 
  <tr> 
   <td>Python3_Development_FOUND</td> 
   <td>系统具有 Python3 开发环境套件</td> 
  </tr> 
  <tr> 
   <td>Python3_INCLUDE_DIRS</td> 
   <td>Python3 include 文件目录</td> 
  </tr> 
  <tr> 
   <td>Python3_LIBRARIES</td> 
   <td>Python3 库文件</td> 
  </tr> 
  <tr> 
   <td>Python3_LIBRARY_DIRS</td> 
   <td>Python3 库文件路径</td> 
  </tr> 
  <tr> 
   <td>Python3_RUNTIME_LIBRARY_DIRS</td> 
   <td>Python3 运行时库文件路径</td> 
  </tr> 
  <tr> 
   <td>Python3_VERSION</td> 
   <td>Python3 版本</td> 
  </tr> 
  <tr> 
   <td>Python3_VERSION_MAJOR</td> 
   <td>Python3 主版本</td> 
  </tr> 
  <tr> 
   <td>Python3_VERSION_MINOR</td> 
   <td>Python3 此版本</td> 
  </tr> 
  <tr> 
   <td>Python3_VERSION_PATCH</td> 
   <td>Python3 小版本</td> 
  </tr> 
  <tr> 
   <td>Python3_NumPy_FOUND</td> 
   <td>系统具有 <code>Numpy</code></td> 
  </tr> 
  <tr> 
   <td>Python3_NumPy_INCLUDE_DIRS</td> 
   <td><code>NumPy</code> include 文件目录</td> 
  </tr> 
  <tr> 
   <td>Python3_NumPy_VERSION</td> 
   <td><code>NumPy</code> 版本</td> 
  </tr> 
 </tbody> 
</table>

### 提示 ###

用户可以通过修改如下变量的属性更改使用的 Python3 的属性，例如安装位置等

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Python3_ROOT_DIR</td> 
   <td>定义 Python3 安装的根目录路径</td> 
  </tr> 
 </tbody> 
</table>

## 参考文章 ##

[FindPython3][]  
[浅析 C++ 调用 Python 模块][C_ _ Python]

[FindPython3]: https://cmake.org/cmake/help/v3.17/module/FindPython3.html
[C_ _ Python]: https://www.cnblogs.com/findumars/p/6142330.html