在C++中调⽤Python
技术背景
虽然现在Python编程语⾔⼗分的⽕爆，但是实际上⾮要⽤⼀门语⾔去完成所有的任务，并不是说不可以，⽽是不合适。在⼀些特定的、对于性能要求⽐较⾼的场景，还是需要⽤到传统的C++来进⾏编程的。但是C++的⼀个缺点是⽐较难到很好的轮⼦，这也是很多⼈专⽤Python的⼀个重要原因。这篇⽂章我们要介绍的是⼀个⽐较特殊的场景——⽤C++的代码去调⽤Python函数中实现的⼀些功能。这样的话，如果代码的主体还是⽤C++完成的，⽽部分功能为了简便，引⼊⼀些Python中已经封装好的函数，这样就可以很好的结合两种语⾔各⾃的特点。⽽另⼀种⼯作⽅式：通过Python来调⽤⼀些C++或者Fortran中实现的⾼性能函数，可以参考这⼀篇。这两种不同的使⽤⽅法各有优劣，但是如果以Python为主导，就很难避开GIL的问题，这⾥我们就不过多的展开。
Python的安装
为了使⽤Python.h这个扩展项，我们需要安装⼀个python*-dev⽽不是python*，这两者略有区别，下⾯的案例展⽰的是在Ubuntu20.04下安装python3.9-dev的⽅法：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ sudo apt install python3.9-dev
正在读取软件包列表... 完成
正在分析软件包的依赖关系树
正在读取状态信息... 完成
下列软件包是⾃动安装的并且现在不需要了：
chromium-codecs-ffmpeg-extra gstreamer1.0-vaapi
libgstreamer-plugins-bad1.0-0 linux-headers-5.8.0-43-generic
linux-hwe-5.8-headers-5.8.0-43 linux-image-5.8.0-43-generic
linux-modules-5.8.0-43-generic linux-modules-extra-5.8.0-43-generic
使⽤'sudo apt autoremove'来卸载它(它们)。
ubuntu怎么安装python
将会同时安装下列软件：
libexpat1-dev libpython3.9 libpython3.9-dev zlib1g-dev
下列【新】软件包将被安装：
libexpat1-dev libpython3.9 libpython3.9-dev python3.9-dev zlib1g-dev
升级了 0 个软件包，新安装了 5 个软件包，要卸载 0 个软件包，有 30 个软件包未被升级。
需要下载 6,613 kB 的归档。
解压缩后会消耗 28.7 MB 的额外空间。
您希望继续执⾏吗？ [Y/n] Y
获取:1 repo.huaweicloud/ubuntu focal/main amd64 libexpat1-dev amd64 2.2.9-1build1 [116 kB]
获取:2 repo.huaweicloud/ubuntu focal-updates/universe amd64 libpython3.9 amd64 3.9.0-5~20.04 [1,710 kB]
获取:3 repo.huaweicloud/ubuntu focal-updates/universe amd64 libpython3.9-dev amd64 3.9.0-5~20.04 [4,119 kB]
获取:4 repo.huaweicloud/ubuntu focal-updates/main amd64 zlib1g-dev amd64 1:1.2.11.dfsg-2ubuntu1.2 [155 kB]
获取:5 repo.huaweicloud/ubuntu focal-updates/universe amd64 python3.9-dev amd64 3.9.0-5~20.04 [512 kB]
已下载 6,613 kB，耗时 4秒 (1,594 kB/s)
正在选中未选择的软件包 libexpat1-dev:amd64。
(正在读取数据库 ... 系统当前共安装有 269544 个⽂件和⽬录。)
准备解压 .../libexpat1-dev_2.2.9-1build1_amd64.deb  ...
正在解压 libexpat1-dev:amd64 (2.2.9-1build1) ...
正在选中未选择的软件包 libpython3.9:amd64。
准备解压 .../libpython3.9_3.9.0-5~20.04_amd64.deb  ...
正在解压 libpython3.9:amd64 (3.9.0-5~20.04) ...
正在选中未选择的软件包 libpython3.9-dev:amd64。
准备解压 .../libpython3.9-dev_3.9.0-5~20.04_amd64.deb  ...
正在解压 libpython3.9-dev:amd64 (3.9.0-5~20.04) ...
正在选中未选择的软件包 zlib1g-dev:amd64。
准备解压 .../zlib1g-dev_1%3a1.2.11.dfsg-2ubuntu1.2_amd64.deb  ...
正在解压 zlib1g-dev:amd64 (1:1.2.11.dfsg-2ubuntu1.2) ...
正在选中未选择的软件包 python3.9-dev。
准备解压 .../python3.9-dev_3.9.0-5~20.04_amd64.deb  ...
正在解压 python3.9-dev (3.9.0-5~20.04) ...
正在设置 libpython3.9:amd64 (3.9.0-5~20.04) ...
正在设置 libexpat1-dev:amd64 (2.2.9-1build1) ...
正在设置 zlib1g-dev:amd64 (1:1.2.11.dfsg-2ubuntu1.2) ...
正在设置 libpython3.9-dev:amd64 (3.9.0-5~20.04) ...
正在设置 python3.9-dev (3.9.0-5~20.04) ...
正在处理⽤于 man-db (2.9.1-1) 的触发器 ...
正在处理⽤于 libc-bin (2.31-0ubuntu9.2) 的触发器 ...
安装完成后，如果在当前命令⾏下运⾏python3.9，是可以看到⼀个python专属的命令⾏界⾯的，可以通过exit()退出。但是我们这⾥侧重的是跟C++的配合⼯作，因此我们更加关注lib和include⽬录下是否有⽣成相关的⽬录，可以执⾏如下指令进⾏查看：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ ll /usr/lib/ | grep python
drwxr-xr-x  26 root root  20480 5⽉  7 16:27 python2.7/
drwxr-xr-x  3 root root    4096 2⽉  10 02:47 python3/
drwxr-xr-x  30 root root  20480 5⽉  7 16:30 python3.8/
drwxr-xr-x  31 root root  12288 5⽉  20 16:31 python3.9/
这⾥我们看到有⼀个3.9的版本，也就是我们刚才安装的版本，再看看include下的⽬录：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ ll /usr/include/ | grep python
drwxr-xr-x  2 root root  4096 5⽉  7 16:31 python3.8/
drwxr-xr-x  4 root root  4096 5⽉  20 16:31 python3.9/
这⾥我们就可以看到⼀些区别了，有⼀些版本的python不⼀定会有这两个⽬录，但是只有具备了这两个⽬录，才能够被C++调⽤。
VS Code配置
这⾥我们使⽤的IDE是VS Code，但是上述提到的⼏个路径，在VS Code中默认是不被包含的，因此在代码编辑的过程中在include <Python.h>这⼀步就会报错了。这⼀章节的⽬的主要是解决IDE中的报错问题，还不是最终运⾏中出现的问题，因为运⾏时我是通过命令⾏执⾏g++来运⾏的，⽽不是直接⽤IDE来跑。⾸先在VS Code界⾯上按顺序同时按
住：ctrl+shift+P，在弹出的窗⼝中输⼊C/C++ Edit Configurations(JSON)查相关JSON配置⽂件，在列表中点击后会⾃动在VS Code中打开这个配置⽂件：
{
"name": "Linux",
"includePath": [
"${workspaceFolder}/**"
],
"defines": [],
"compilerPath": "/usr/bin/gcc",
"cStandard": "gnu17",
"cppStandard": "c++11",
"intelliSenseMode": "linux-gcc-x64"
}
],
"version": 4
}
我们所需要做的⼯作就是，在这个includePath中把相关的路径都加上，⽐如我这边添加的路径是以下3个：
{
"configurations": [
{
"name": "Linux",
"includePath": [
"${workspaceFolder}/**",
"/usr/include/python3.9/",
"/usr/lib/python3.9/",
"/usr/include/python3.9/cpython/"
],
"defines": [],
"compilerPath": "/usr/bin/gcc",
"cStandard": "gnu17",
"cppStandard": "c++11",
"intelliSenseMode": "linux-gcc-x64"
}
],
"version": 4
}
添加后，include <Python.h>就不会显⽰报错了。
Hello World测试
⾏业潜规则，我们先⽤C++来调⽤⼀个Python的打印函数，输出Hello World试试：
// cp.cpp
#include <Python.h>
int main(int argc, char *argv[]) {
Py_Initialize();
PyRun_SimpleString("print('hello world')\n");
Py_Finalize();
return 0;
}
这⾥需要注意的是⼀个运⾏⽅式，我们是⽤g++来进⾏编译的，但是g++默认是不到我们刚才在IDE中所设定的⼏个includePath的，因此需要我们⼿动在编译的时候加上⼏个参数。这些参数其实也可以运⾏python3.9-config去⼀个⼀个查看，这⾥我们直接推荐⼀种可以运⾏成功的参数，其中最重要的是-I和-l这两个路径⼀定要包含：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ g++ -o cpy cp.cpp -lm -std=c++11 -I/usr/include/python3.9/ -lpython3.9
dechin@ubuntu2004:~/projects/gitlab/dechin/$ ll
总⽤量 4697388
drwxrwxr-x 2 dechin dechin      4096 5⽉  20 17:10 ./
drwxrwxr-x 8 dechin dechin      4096 5⽉  19 15:32 ../
-rw-rw-r-- 1 dechin dechin        152 5⽉  20 17:04 cp.cpp
-rwxrwxr-x 1 dechin dechin      16776 5⽉  20 17:10 cpy*
运⾏完成后，就会在当前⽬录下⽣成⼀个刚才指定的名字cpy的⼀个可执⾏⽂件，如果是windows系统，则会⽣成⼀个的⽂件。让我们执⾏这个⽂件：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ ./cpy
hello world
成功打印Hello World，⼜离成功更近了⼀步。
调⽤Python函数string.split()
在C++中如果我们想分割⼀个字符串，虽然说也是可以实现的，但是应该没有⽐Python中执⾏⼀个string.split()更加⽅便快捷的⽅案了，因此我们测试⼀个⽤C++调⽤Python的split 函数的功能。
第⼀次尝试
⼀开始我们是写了这样⼀个简单的案例，⽤PyImport_ImportModule⽅法去调⽤pysplit这个python模块：
/
/ cp.cpp
#include <Python.h>
#include <iostream>
using namespace std;
int main(int argc, char *argv[])
if (!Py_IsInitialized())
{
cout << "Initialize failed!" << endl;
return 0;
}
PyObject* pModule = NULL;
PyObject* pFunc;
PyRun_SimpleString("import os");
PyRun_SimpleString("os.system('pwd')");
pModule = PyImport_ImportModule("pysplit");
if (pModule == NULL)
{
cout << "Module Not Found!" << endl;
}
// pFunc = PyObject_GetAttrString(pModule, "sp");
// PyObject* args = Py_BuildValue("s", "Test String Hello Every One !");
// PyObject* pRet = PyObject_CallObject(pFunc, args);
string cList[10];
// PyArg_Parse(pRet, "[items]", &cList);
cout << "res:" << cList << endl;
Py_Finalize();
return 0;
}
对应的Python模块的内容为：
# pysplit.py
def sp(string):
return string.split()
这是⼀个⾮常简单的函数，但是我们在调⽤的时候就直接返回了⼀个错误：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ g++ -o cpy cp.cpp -lm -std=c++11 -I/usr/include/python3.9/ -lpython3.9 && ./cpy
['pysplit.py', 'cpy', 'cp.cpp']
Module Not Found!
res:0x7ffc622ae900
这个错误是说，不到pysplit这个模块。但是我们同时借助于PyRun_SimpleString调⽤了Python中的os库，执⾏了⼀个查看路径和当前路径下⽂件的功能，我们发现这个C++⽂件和需要引⼊的pysplit.py其实是在同⼀个路径下的，这就很奇怪了没有导⼊成功。
第⼆次尝试
经过⼀番的资料查询，最后发现，即使是在相同的路径下，也需要通过Python的sys将当前⽬录添加到系统路径中，才能够识别到这个模块，同样也是使⽤PyRun_SimpleString的函数：
// cp.cpp
#include <Python.h>
#include <iostream>
using namespace std;
int main(int argc, char *argv[])
{
Py_Initialize();
if (!Py_IsInitialized())
{
cout << "Initialize failed!" << endl;
return 0;
}
PyObject* pModule = NULL;
PyObject* pFunc;
PyRun_SimpleString("import sys");
PyRun_SimpleString("sys.path.append('./')");
pModule = PyImport_ImportModule("pysplit");
if (pModule == NULL)
{
cout << "Module Not Found!" << endl;
}
pFunc = PyObject_GetAttrString(pModule, "sp");
PyObject* args = Py_BuildValue("s", "Test String Hello Every One !");
PyObject* pRet = PyObject_CallObject(pFunc, args);
string cList[10];
// PyArg_Parse(pRet, "[items]", &cList);
cout << "res:" << cList << endl;
Py_Finalize();
return 0;
}
但是执⾏后，⼜出现了⼀个新的问题，说输⼊格式必须要是⼀个tuple格式的：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ g++ -o cpy cp.cpp -lm -std=c++11 -I/usr/include/python3.9/ -lpython3.9 && ./cpy
res:0x7ffe94beb320
TypeError: argument list must be a tuple
这个也可以理解，Python中的函数调⽤，输⼊参数都被打包成了⼀个tuple格式，⽐如**args，⽽类似**kwargs则是打包成⼀个字典格式，类似的功能在这篇中有所介绍。
第三次尝试
上⾯的问题，在StackOverFlow上有⼀个类似的情况，有解决了这个问题，解决⽅案是，⽤PyObject_CallFunctionObjArgs来替代PyObject_CallObject去实现函数调⽤命令，相关代码如下：
// cp.cpp
#include <Python.h>
#include <iostream>
using namespace std;
int main(int argc, char *argv[])
{
Py_Initialize();
if (!Py_IsInitialized())
{
cout << "Initialize failed!" << endl;
return 0;
}
PyObject* pModule = NULL;
PyObject* pFunc;
PyRun_SimpleString("import sys");
PyRun_SimpleString("sys.path.append('./')");
pModule = PyImport_ImportModule("pysplit");
if (pModule == NULL)
{
cout << "Module Not Found!" << endl;
}
pFunc = PyObject_GetAttrString(pModule, "sp");
PyObject* args = Py_BuildValue("s", "Test String Hello Every One !");
PyObject* pRet = PyObject_CallFunctionObjArgs(pFunc, args, NULL);
int size = PyList_Size(pRet);
cout << "List size is: " << size << endl;
for(int i=0;i<size;i++)
{
PyObject* cRet = PyList_GET_ITEM(pRet, i);
char* s;
PyArg_Parse(cRet, "s", &s);
cout << "The " << i << "th term is: " << s << endl;
}
Py_Finalize();
return 0;
}
最后，因为从Python中获取的是⼀个List格式的数据，因此我们⾸先需要⽤PyList_GET_ITEM去逐项提取，然后⽤PyArg_Parse将提取出来的元素保存到⼀个C++的char字符串中，执⾏结果如下：
dechin@ubuntu2004:~/projects/gitlab/dechin/$ g++ -o cpy cp.cpp -lm -std=c++11 -I/usr/include/python3.9/ -lpython3.9 && ./cpy
List size is: 6
The 0th term is: Test
The 1th term is: String
The 2th term is: Hello
The 3th term is: Every
The 4th term is: One
The 5th term is: !
Yes！终于成功了！
总结概要
本⽂介绍了⼀个在C++内部调⽤Python中封装的函数或者接⼝的⽅法，从环境配置到具体⽰例都有讲解，并且在其中包含有不少的坑点，需要⼀步⼀步去踩。不同的编程语⾔具有不同的优势，Python轮⼦众多⽽语法简单，上⼿容易，但是性能⽐较⾸先，C++的最明显优势就是在于其性能的天然优越性。但是我们不需要对哪⼀种编程语⾔有所偏倚，都有所掌握，并且能够有所互通，利⽤好各⾃的优势，才能够发挥最⼤的价值。
版权声明
参考链接

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。