CMake 学习笔记（访问Python）

于 2024-05-08 09:24:50 发布
阅读量843 收藏 13
点赞数 11
分类专栏： CMake 学习笔记 文章标签： CMake
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liyuanbhu/article/details/138558065
版权

CMake 学习笔记（访问Python）

利用Python可以做很多事情。比如：

  1. 利用 Python 自动生成一些代码。

  2. 在我们的程序中植入一个 Python 解释器。

为了做这些事情。就需要 CMake 能够知道 python 装在哪里，装的是什么版本的 python，装了哪些包。是否安装了Python 相关的库。

下面就依次介绍如何实现这些功能。最核心的知识就是学会如何使用 find_package( ) 命令。

检测 Python 解释器

下面是个简单的例子。

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
project(recipe-01 LANGUAGES NONE)
find_package(PythonInterp REQUIRED)
execute_process(
    COMMAND
    	${PYTHON_EXECUTABLE} "-c" "print('Hello, world!')"
    RESULT_VARIABLE _status
    OUTPUT_VARIABLE _hello_world
    ERROR_QUIET
    OUTPUT_STRIP_TRAILING_WHITESPACE
)
message(STATUS "RESULT_VARIABLE is: ${_status}")
message(STATUS "OUTPUT_VARIABLE is: ${_hello_world}")

# compare the "manual" messages with the following handy helper
include(CMakePrintHelpers)
cmake_print_variables(_status _hello_world)

上面的代码最核心的有两句。find_package 用来查找 python。

find_package(PythonInterp REQUIRED)

如果需要指定 python 版本。可以像下面这样，下面的代码要求Python 版本不低于 3.5：

find_package(PythonInterp 3.5 REQUIRED)

如果要求Python 版本必须是某一个特定版本。可以像下面这样写：

find_package(PythonLibs 3.11.5 EXACT REQUIRED)

上面的代码要求python 的版本必须是3.11.5。find_package() 执行完后会自动生成一系列的变量，我们可以在后面的代码中使用这些变量。

  • PYTHONINTERP_FOUND, 布尔变量，记录是否找到 python 解释器
  • PYTHON_EXECUTABLE, python 解释器的路径
  • PYTHON_VERSION_STRING, python 的版本
  • PYTHON_VERSION_MAJOR, python 的主版本号
  • PYTHON_VERSION_MINOR, python 的副版本号
  • PYTHON_VERSION_PATCH, python 的版本修订号

另外需要掌握的是 execute_process()。 用这个命令可以调用 python ，执行一段特殊的程序。通常我们是利用 python 生成一段源代码。之所以用 python 生成代码。是因为可以利用 python 对当前系统做很多探测，根据系统的情况生成最适合的代码。或者我们的代码里有很多重复的地方。用python可以快速生成这些重复的代码。

总之，用上面的类似的方法，我们可以调用任意一段 python 程序，做我们想做的任意事情。

如果python 安装到了 cmake 无法自动检测到的位置，我们可以通过命令行告诉cmake 去哪里找 python:

cmake -D PYTHON_EXECUTABLE=/custom/location/python

检测 Python 库

第二种使用 python 的方法是在我们的程序中直接调用 python 。下面是一个简单的程序：

#include <Python.h>
int main(int argc, char *argv[]) 
{
    Py_SetProgramName(argv[0]); /* optional but recommended */
    Py_Initialize();
    PyRun_SimpleString("from time import time,ctime\n"
    "print 'Today is',ctime(time())\n");
    Py_Finalize();
    return 0;
}

我们要编译这个程序。

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
project(recipe-02 LANGUAGES C)
set(CMAKE_C_STANDARD 99)
set(CMAKE_C_EXTENSIONS OFF)
set(CMAKE_C_STANDARD_REQUIRED ON)
find_package(PythonInterp REQUIRED)
find_package(PythonLibs ${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR} EXACT REQUIRED)
add_executable(hello-embedded-python hello-embedded-python.c)

target_include_directories(hello-embedded-python
PRIVATE
${PYTHON_INCLUDE_DIRS}
)

target_link_libraries(hello-embedded-python
PRIVATE
${PYTHON_LIBRARIES}
)

在我的电脑上运行的结果是这样的：

Could not find platform independent libraries <prefix>
Today is Tue May  7 08:51:16 2024

第一行是因为我没有设置环境变量，这个程序找不到我电脑里的python。但是这个并不影响程序运行。

检测 Python 包

下面是个更复杂的代码。里面调用了 Python 的包。为了能编译运行这个代码，需要cmake 检测我们的 python 是否安装了对应的包。

/*
 * Code example from:
 *    https://docs.python.org/3.5/extending/embedding.html#pure-embedding
 */

#include <Python.h>

int main(int argc, char *argv[]) {
  PyObject *pName, *pModule, *pDict, *pFunc;
  PyObject *pArgs, *pValue;
  int i;

  if (argc < 3) {
    fprintf(stderr, "Usage: pure-embedding pythonfile funcname [args]\n");
    return 1;
  }

  Py_Initialize();

  PyRun_SimpleString("import sys");
  PyRun_SimpleString("sys.path.append(\".\")");

  pName = PyUnicode_DecodeFSDefault(argv[1]);
  /* Error checking of pName left out */

  pModule = PyImport_Import(pName);
  Py_DECREF(pName);

  if (pModule != NULL) {
    pFunc = PyObject_GetAttrString(pModule, argv[2]);
    /* pFunc is a new reference */

    if (pFunc && PyCallable_Check(pFunc)) {
      pArgs = PyTuple_New(argc - 3);
      for (i = 0; i < argc - 3; ++i) {
        pValue = PyLong_FromLong(atoi(argv[i + 3]));
        if (!pValue) {
          Py_DECREF(pArgs);
          Py_DECREF(pModule);
          fprintf(stderr, "Cannot convert argument\n");
          return 1;
        }
        /* pValue reference stolen here: */
        PyTuple_SetItem(pArgs, i, pValue);
      }
      pValue = PyObject_CallObject(pFunc, pArgs);
      Py_DECREF(pArgs);
      if (pValue != NULL) {
        printf("Result of call: %ld\n", PyLong_AsLong(pValue));
        Py_DECREF(pValue);
      } else {
        Py_DECREF(pFunc);
        Py_DECREF(pModule);
        PyErr_Print();
        fprintf(stderr, "Call failed\n");
        return 1;
      }
    } else {
      if (PyErr_Occurred())
        PyErr_Print();
      fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);
    }
    Py_XDECREF(pFunc);
    Py_DECREF(pModule);
  } else {
    PyErr_Print();
    fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);
    return 1;
  }
  Py_Finalize();
  return 0;
}

我们的这个程序还要调用一段 python 代码：

import numpy as np
def print_ones(rows, cols):
A = np.ones(shape=(rows, cols), dtype=float)
print(A)
# we return the number of elements to verify
# that the C++ code is able to receive return values
num_elements = rows*cols
return(num_elements)

cmake 文件前部分还是一样的：

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
project(recipe-03 LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_EXTENSIONS OFF)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
find_package(PythonInterp REQUIRED)
find_package(PythonLibs ${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR} EXACT REQUIRED)

后面的部分就不同了。首先要检测有没有安装 numpy:


# Find NumPy location
execute_process(
  COMMAND
    ${PYTHON_EXECUTABLE} "-c" "import re, numpy; print(re.compile('/__init__.py.*').sub('',numpy.__file__))"
  RESULT_VARIABLE _numpy_status
  OUTPUT_VARIABLE _numpy_location
  ERROR_QUIET
  OUTPUT_STRIP_TRAILING_WHITESPACE
  )
if(NOT _numpy_status)
  set(NumPy ${_numpy_location} CACHE STRING "Location of NumPy")
endif()

# Find NumPy version
execute_process(
  COMMAND
    ${PYTHON_EXECUTABLE} "-c" "import numpy; print(numpy.__version__)"
  OUTPUT_VARIABLE _numpy_version
  ERROR_QUIET
  OUTPUT_STRIP_TRAILING_WHITESPACE
  )

include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(NumPy
  FOUND_VAR NumPy_FOUND
  REQUIRED_VARS NumPy
  VERSION_VAR _numpy_version
  )

这一段代码主要有2部分组成。首先是判断有没有安装 numpy，代码如下。

execute_process(
  COMMAND
    ${PYTHON_EXECUTABLE} "-c" "import re, numpy; print(re.compile('/__init__.py.*').sub('',numpy.__file__))"
  RESULT_VARIABLE _numpy_status
  OUTPUT_VARIABLE _numpy_location
  ERROR_QUIET
  OUTPUT_STRIP_TRAILING_WHITESPACE
  )
  if(NOT _numpy_status)
  set(NumPy ${_numpy_location} CACHE STRING "Location of NumPy")
endif()

如果找到了numpy， _numpy_status = 0。 所以后面的判断条件是 if(NOT _numpy_status) 。

找到 numpy 后，将numpy 的位置保存到一个变量 NumPy 中，并且这个 变量是 CACHE 的，也就是后面用户可以自己编辑这个变量的值。

然后是检测 numpy 的版本：

# Find NumPy version
execute_process(
  COMMAND
    ${PYTHON_EXECUTABLE} "-c" "import numpy; print(numpy.__version__)"
  OUTPUT_VARIABLE _numpy_version
  ERROR_QUIET
  OUTPUT_STRIP_TRAILING_WHITESPACE
  )

版本号保存到 _numpy_version 这个变量中。然后用 FindPackageHandleStandardArgs 这个包的功能设置 NumPy_FOUND 变量。这里使用FindPackageHandleStandardArgs 的目的其实只有一个，就是当 NumPy 没找到时，cmake 可以抱错并停下来。

include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(NumPy
FOUND_VAR NumPy_FOUND
REQUIRED_VARS NumPy
VERSION_VAR _numpy_version
)

后面如何编译exe文件，这里也用了些技巧，比如用到了 PYTHON_VERSION_MAJOR：

add_executable(pure-embedding "")
target_sources(pure-embedding
PRIVATE
Py${PYTHON_VERSION_MAJOR}-pure-embedding.cpp
)
target_include_directories(pure-embedding
PRIVATE
${PYTHON_INCLUDE_DIRS}
)
target_link_libraries(pure-embedding
PRIVATE
${PYTHON_LIBRARIES}
)

还有最后一部分，我们要把 use_numpy.py 文件拷贝到 exe 所在目录，因为我们的程序要调用这个文件：


add_custom_command(
  OUTPUT
    ${CMAKE_CURRENT_BINARY_DIR}/use_numpy.py
  COMMAND
    ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/use_numpy.py
                                          ${CMAKE_CURRENT_BINARY_DIR}/use_numpy.py
  DEPENDS
    ${CMAKE_CURRENT_SOURCE_DIR}/use_numpy.py
  )

# make sure building pure-embedding triggers the above
# custom command
target_sources(pure-embedding
  PRIVATE
    ${CMAKE_CURRENT_BINARY_DIR}/use_numpy.py
  )

编译生成 pure-embedding.exe 后可以试着运行一下。

./pure-embedding use_numpy print_ones 2 3

结果如下：

[[1. 1. 1.]
[1. 1. 1.]]
Result of call: 6
liyuanbhu
关注
  • 11
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
ROS2学习笔记之创建自己的功能包
01-06
ROS2学习笔记之创建自己的功能包背景前期准备学习内容1. 创建一个包2. 编译新建的包3 Source工作空间的配置文件4 使用新建的包5. 查看包的内容6. 自定义 package.xml总结 学习目标: 使用CMake或Python创建一个新的包...
Cmake小结
weixin_43892514的博客
06-09 2414
一、CMake编译原理 CMake是一种跨平台编译工具，比make更为高级，使用起来要方便得多。CMake主要是编写CMakeLists.txt文件，然后用cmake命令将CMakeLists.txt文件转化为make所需要的makefile文件，最后用make命令编译源码生成可执行程序或共享库（so(shared object)）。因此CMake的编译基本就两个步骤： cmake make cmake 指向CMakeLists.txt所在的目录，例如cmake … 表示CMakeLists.txt在当前
cmake 04 使用 python 管理 cmake 工程
u014254963的专栏
01-22 1438
使用 python 管理 cmake 工程
CMake:检测python解释器和python库
jjjstephen的博客
08-05 2987
解释器及其开发组件匹配为完全相同的版本可能非常困难，对于那些将它们安装在非标准位置或系统上安装了多个版本的情况尤其如此。除了在系统上实际查找包模块之外，查找模块还会设置了一些有用的变量，反映实际找到了什么，也可以在自己的。编写的工具，从而将主程序和库打包在一起，或者在配置或构建过程中使用。无法找到模块包时，可以阅读相应检测模块的文档，以了解如何正确地使用。最后：用积极的态度面对生活，正面面对生活中的任何人、事！模块，并在使用它们之前详细阅读它们的文档。，以便找到及定位相应的版本的组件。，查找特定版本的包。
CMake + Python 搭建构建系统
https://van-link.github.io/
07-31 276
cmake、Makefile、 python 脚本，构建工具
cmake 06 使用 python 管理 cmake 工程 0.2
u014254963的专栏
01-26 831
使用 python 管理 cmake 工程 0.2
cmake 调用 python
luoganttcc_son的博客
07-29 794
代码】cmake调用python。
cmake 学习笔记(一) - 1+1=10 - 博客频道 - CSDN1
08-03
最大的Qt4程序群(KDE4)采用cmake作为构建系统Qt4的python绑定(pyside)采用了cmake作为构建系统开源的图像处理库 opencv 采用
ROS2一些学习笔记仅个人记录
02-25
ROS2 学习笔记 ROS2 是一个开源的机器人操作系统，提供了一个灵活的框架来构建机器人应用程序。下面是 ROS2 的一些学习笔记，涵盖了从安装到使用的一些基本概念和命令。 安装和环境变量设置 为了使用 ROS2，需要...
cmakeconf:一个使用更简单，直接的构建文件的python库，该文件将生成Cmake文件。 这样可以避免学习Cmake语法
04-27
这将在cmake之上添加另一个抽象层以简化项目，并且不需要学习cmake语法。指定的选项（到目前为止）[项目设置] 项目的简单设置，例如： 项目名最低CMAKE版本UseFolders开| 关闭（用于在解决方案文件中使用Visual ...
python3.6安装dlib,不用安装cmake
03-03
windows python3.6安装dlib,不用安装cmake,也不用安装boost.............
python 下 CMake 安装配置 OPENCV 4.1.1的方法
09-18
主要介绍了python 下 CMake 安装配置 OPENCV 4.1.1的方法，文中给大家提到了CMake 安装配置 OPENCV 4.1.1 解决各种问题,需要的朋友可以参考下
cmake-fullpython:cmake集成python3（> = 3.7），pybind11，virtualenv
04-17
地位 [ 要解决的问题 cmake-fullpython.cmake的主要目标是提供一个框架，以帮助开发人员解决需要cmake下游python集成的项目中的软件碎片问题。 拟议的解决方案 cmake-fullpython.cmake提供了一个属于以下图的python可执行文件。 | ----------------------------------------- | | | | upstream cmake project | | | | ----------------------------------------- | |
miniWiki：按『个人Wiki』风格整理的学习笔记
02-18
布局标题页首页编写说明语言《》《》《》包含大量数学公式，因此整理为LyX文档。本页内部的链接指向可单独编译的分卷，不同分卷可能包含重复的章节。 『大致 』大致按逻辑顺序重新编排了章节（重复的只保留一份）。...
Cmake/Gcc调用 Python模块
～勿据散客～的博客
07-08 1483
系统： ubuntu 18.04 python 3.6.9 gcc 9.1.0安装库： 其他系统的安装方法CmakeList.txt c_python.cpp c_py_test.py 运行结果：如果上面cmake编译不通，可以试试gcc版本： 执行 若遇到类似抱错： 需要： Reference 如何实现 C/C++ 与 Python 的通信？ Python.h的Cmake配置 python文档 – 拓展和嵌入 python文档 – python/C API接口 上面文档的中译版 cmake的项目c++调
CMake:检测python模块和包
最新发布
jjjstephen的博客
08-09 396
的目标（通常是一个可执行文件或库）指定了源文件。命令，用于定义自定义的构建步骤，以及生成相应的输出文件。视为目标的源文件之一，并确保在构建过程中该文件已经生成。这可以确保在构建过程中，始终使用最新的。发生变化，就执行指定的命令来将该文件复制到构建目录。的位置，以便后续的构建过程可以使用它。最后：希望大家都勇于向邪恶势力作斗争！库的版本号，以便后续的构建过程可以使用。这段代码的作用是在构建过程中，如果。来抑制进程生成的任何错误，并且使用。模块或包的项目中，确定满足对这些。通常，代码是依赖于特定的。
ubantu python完整安装示例（ubantu16.04 python3.7.1演示）、包含cmake完整安装流程（主要适用于arm linux机器）
a284365的博客
02-21 4547
本文主要介绍了ubantu python源码编译安装的完整流程（使用python3.7.1演示安装），同时也介绍了常规的安装方法。
python CMAKE的使用
Dontla的博客
10-02 6063
参考文章：https://github.com/IntelRealSense/librealsense/tree/master/wrappers/python#building-from-source
cmakelist 链接boost python
06-01
```cmake find_package(Boost REQUIRED COMPONENTS python) include_directories(${Boost_INCLUDE_DIRS}) add_library(your_library SHARED your_source_files.cpp) target_link_libraries(your_library ${Boost_...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值