如何在C++中調用Python
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'來卸載它(它們)。 將會同時安裝下列軟件： 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 http://repo.huaweicloud.com/ubuntu focal/main amd64 libexpat1-dev amd64 2.2.9-1build1 [116 kB] 獲取:2 http://repo.huaweicloud.com/ubuntu focal-updates/universe amd64 libpython3.9 amd64 3.9.0-5~20.04 [1,710 kB] 獲取:3 http://repo.huaweicloud.com/ubuntu focal-updates/universe amd64 libpython3.9-dev amd64 3.9.0-5~20.04 [4,119 kB] 獲取:4 http://repo.huaweicloud.com/ubuntu focal-updates/main amd64 zlib1g-dev amd64 1:1.2.11.dfsg-2ubuntu1.2 [155 kB] 獲取:5 http://repo.huaweicloud.com/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中打開這個配置文件：
{
"configurations": [
{
"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系統，則會生成一個cpy.exe的文件。讓我們執行這個文件：
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[])
{
Py_Initialize();
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;
}
這個也可以理解，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++的最明顯優勢就是在於其性能的天然優越性。但是我們不需要對哪一種編程語言有所偏倚，都有所掌握，並且能夠有所互通，利用好各自的優勢，才能夠發揮最大的價值。
以上就是如何在C++中調用Python的詳細內容，更多關於C++ 調用Python的資料請關註WalkonNet其它相關文章！
推薦閱讀：
- C++調用python(執行py文件)的全過程
- 膠水語言Python與C/C++的相互調用的實現
- 詳解如何在VS2019和VScode中配置C++調用python接口
- Python與C/C++的相互調用案例
- c++ 實現文件逐行讀取與字符匹配