c/c++调用python

比眉伴天荒 2022-12-05 05:10 240阅读 0赞

*  环境: `Ubuntu18.04`
 *  实验Python: `系统自带的python`和`conda创建的python环境gymlab(python3.6)`
 *  gcc版本 5.0
 *  目标: 通过gcc编译c++(包含python)

**注意: 前两节主要是介绍如何将c++与python联系, 后两节通过c/C++/python实例讲解如何调用python的包,函数, 和类等方法**

### 文章目录 ###

*  一. C++结合系统自带python
 *  二. C++结合conda的python环境gymlab
 *  三. C++调用python里面的函数, 类
 *   *  3.1 预备知识
     *  3.2 C++调用python里面的函数
     *  3.3 C++调用python里面的类和类方法

# 一. C++结合系统自带python #

**c++代码**

// 运行命令
    // g++ -I /usr/include/python3.6 main.cpp 
    // -L /usr/lib/python3.6/config-3.6m-x86_64-linux-gnu/ -l python3.6
    #include<iostream>
    // #include</home/zjq/.conda/envs/gymlab/include/python3.6m/Python.h> 
    //这里指定了头文件的绝对路径之后, 在编译命令就不需要-I /usr/include/python3.6
    #include <Python.h> //这里在编译命令-L指定了
    using namespace std;
    int main(int argc, char* argv[]){ 
        
        Py_Initialize(); //初始化python
        PyRun_SimpleString("import sys; sys.path.append('src_py/')"); // 添加包含python代码的路径
        PyRun_SimpleString("import hello"); // 加载python代码包
        Py_Finalize();
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDYwODE5_size_16_color_FFFFFF_t_70_pic_center]

**结果如下图所示**

zjq@DESKTOP-O28RVV3:28_c++调用python$ g++ -I "/usr/include/python3.6" main.cpp -L "/usr/lib/python3.6/config-3.6m-x86_64-linux-gnu/" -l python3.6 -o test.out
    zjq@DESKTOP-O28RVV3:28_c++调用python$ ./a.out
    hello world!!!

**命令含义**

*  `g++` c++编译器, 编译C++代码默认为a.out
 *  `-I` 大写i, 链接代码中用到的头文件的路径, 这里用到python.h, 因此-I告诉编译器该文件在哪个文件夹
 *  `-L` 大写l 链接代码中用到的库, 比如`libpython3.6.os` , 因此-L告诉编译器该库在哪个文件夹
 *  `-l` 小写l 刚大写l已经告诉库文件的目录文件夹, 这里告诉编译器库的名称, 如`libhello.so`, 则这里为`-lhello`
 *  `-o` 小写O, 指定编译输出为test.out, 这样就可以通过`./test.out`执行该代码

# 二. C++结合conda的python环境gymlab #

这里使用一里面的代码和指令, 只不过将执行命令的库连接路径修改了一下, 下面是出错原因  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDYwODE5_size_16_color_FFFFFF_t_70_pic_center 1]  
**解决方案:**

*  首先确定肯定是要使用gymlab环境的lib, 因此直接在gymlab搜索libpython, 结果搜索到了  
    ![在这里插入图片描述][20200909111805411.png_pic_center]
 *  所以这里使用该文件夹里面的库文件`libpython3.6m.so`进行测试, 没想到成功了

结果如下所示

$ g++ -I /home/zjq/.conda/envs/gymlab/include/python3.6m/ main.cpp -L /home/zjq/.conda/envs/lib/ -l python3.6m
    $ ls
    a.out  main.cpp  run_main.sh  search.cc  src_py
    $ ./a.out
    hello world!!!

# 三. C++调用python里面的函数, 类 #

[python官网3.6.8数据手册,网速较慢较卡][python_3.6.8]  
\[python自带doc 数据手册位置, 下面C++中用到的python\_api该文档下面都有\]\[D:\\ProgramFiles\\python3.6.8\\Doc\\python368.chm\]

# src_py/hello.py
    import os
    import sys
    
    print("hello world!!!")
    
    def f1(a,c,b):
        print(a+b+c+2.256)
        return float(a+b+c+2.256)
    
    class H():
        """docstring for H"""
        def __init__(self, aa=0,bb=1):
            super(H, self).__init__()
            self.aa = aa
            self.bb = bb
            print(self.aa, self.bb,"调用类成功")
        def f2(self,cc):
            return self.aa+self.bb+cc
    
    def f3(a):
        return ("hello"+str(a), float(23.3566),a)
        # return a+253
    
    def f4(a):
        return a+233
    
    def f5(a,b):
        return a*b,a+b,"hello", float(a/b)
    
    if __name__ == '__main__':
        print(f1(3,2,4))
        a = H(2,4)
        print(a.f2(12345))
        print(f3(234))
        print(f5(2,4))
    # 运行结果
    ''' hello world!!! 11.256 11.256 2 4 调用类成功 12351 ('hello234', 23.3566, 234) (8, 6, 'hello', 0.5) [Finished in 0.1s] '''

## 3.1 预备知识 ##

*  必备API

Py_Initialize(); //初始化python
    if (!Py_IsInitialized()) { 
        printf("初始化失败！");
        return 0;}
    PyRun_SimpleString("import sys; sys.path.append('src_py/')"); // 添加包含包的路径
    PyObject* pModule = PyImport_ImportModule("hello");  // 存储导入的.py文件模块, 即三节开头的python文件
    PyObject* pFunc1 = PyObject_GetAttrString(pModule, "function_name"); // 导入函数function_name
    PyObject *pyArgs = PyTuple_New(3); //参数元组,这里定义元组长度为3
    PyTuple_SetItem(pyArgs, 0, Py_BuildValue("i", 25)); //这里设置元组的第一个数据为"i"-int型25
    PyObject *pyResult = PyObject_CallObject(pFunc1, pyArgs); //这里调用函数,给函数传递刚设置好的参数
    cout<< PyFloat_AsDouble(pyResult) << "---F4的结果"<<endl; //这里将结果转化为double型
    
    PyObject *pyResult = PyObject_CallMethod(pModule, "function_name", "i", 12);  //包的函数function_name传递给int型12,直接调用函数
    PyArg_Parse(pyResult, "i", &result);//转换返回类型, 将py的返回结果转化为c++格式, 保存到result中, i为int型, 如果一次性返回多个值, "iis"表示返回int,int,char*
    PyArg_ParseTuple(pyResult, "iisd", &result,&result1,&s1, f1);
     // 返回元组重新复制成c++可用类型
    Py_Finalize(); //关闭python

*  数据类型,参数传递

Py_BuildValue("") // None
    Py_BuildValue("i", 123) // 123
    Py_BuildValue("iii", 123, 456, 789) // (123, 456, 789)
    Py_BuildValue("s", "hello")  //'hello'
    Py_BuildValue("ss", "hello", "world") // ('hello', 'world')
    Py_BuildValue("s#", "hello", 4) //'hell'
    Py_BuildValue("()")  //()
    Py_BuildValue("(i)", 123) // (123,)
    Py_BuildValue("(ii)", 123, 456) //(123, 456)
    Py_BuildValue("(i,i)", 123, 456) //(123, 456)
    Py_BuildValue("[i,i]", 123, 456) //[123, 456] 
    Py_BuildValue("{s:i,s:i}", "abc", 123, "def", 456) //{ 'abc': 123, 'def': 456}
    Py_BuildValue("((ii)(ii)) (ii)", 1, 2, 3, 4, 5, 6) //(((1, 2), (3, 4)), (5, 6))

*  数据类型对比

<table> 
 <thead> 
  <tr> 
   <th align="center">FormatCode</th> 
   <th align="center">python type</th> 
   <th align="center">C/C++ type</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">s</td> 
   <td align="center">str</td> 
   <td align="center">char*</td> 
  </tr> 
  <tr> 
   <td align="center">z</td> 
   <td align="center">str/None</td> 
   <td align="center">char*/NULL</td> 
  </tr> 
  <tr> 
   <td align="center">i</td> 
   <td align="center">int</td> 
   <td align="center">int</td> 
  </tr> 
  <tr> 
   <td align="center">l</td> 
   <td align="center">long</td> 
   <td align="center">long</td> 
  </tr> 
  <tr> 
   <td align="center">c</td> 
   <td align="center">str</td> 
   <td align="center">char</td> 
  </tr> 
  <tr> 
   <td align="center">d</td> 
   <td align="center">float</td> 
   <td align="center">double</td> 
  </tr> 
  <tr> 
   <td align="center">D</td> 
   <td align="center">complex</td> 
   <td align="center">Py_Complex*</td> 
  </tr> 
  <tr> 
   <td align="center">o</td> 
   <td align="center">(any)</td> 
   <td align="center">PyObject*</td> 
  </tr> 
  <tr> 
   <td align="center">s</td> 
   <td align="center">str</td> 
   <td align="center">PyStringObject</td> 
  </tr> 
 </tbody> 
</table>

## 3.2 C++调用python里面的函数 ##

文件名称为`main_function.cpp`  
**这里用到了两种函数调用的方法和两种结果转化为C++类型的方法, 建议对比学习**

// 运行命令
    // g++ -I /usr/include/python3.6 main_function.cpp 
    // -L /usr/lib/python3.6/config-3.6m-x86_64-linux-gnu/ -l python3.6
    #include<iostream>
    // #include</home/zjq/.conda/envs/gymlab/include/python3.6m/Python.h> 
    //这里指定了头文件的绝对路径之后, 在编译命令就不需要-I /usr/include/python3.6
    #include <Python.h>
    using namespace std;
    int main(int argc, char* argv[]){ 
        
        //初始化python
        Py_Initialize(); 
        if (!Py_IsInitialized()) { 
            printf("初始化失败！");
            return 0;
        }
    
        PyRun_SimpleString("import sys; sys.path.append('src_py/')"); // 添加路径
        PyObject* pModule = PyImport_ImportModule("hello");  // 存储导入的.py文件模块
        if (pModule==NULL) { 
            cout << "没有找到该模块" << endl;
        }cout<< "发现模块hello" <<endl;
    
        PyObject* pRet = NULL;
        PyObject *pyResult = NULL;
    
        // f4调用的两种方法和两种处理结果的方法, ---用于验证函数调用
        PyObject* pFunc1 = PyObject_GetAttrString(pModule, "f4");
        PyObject *pyArgs = PyTuple_New(1);
        PyTuple_SetItem(pyArgs, 0, Py_BuildValue("i", 25));
        pyResult = PyObject_CallObject(pFunc1, pyArgs);
        cout<< PyFloat_AsDouble(pyResult) << "---F4的结果"<<endl;
    
        pyResult = PyObject_CallMethod(pModule, "f4", "i", 12); //直接调用包里面f4函数, 函数传递的值为int型12
        cout<< PyFloat_AsDouble(pyResult) << "---F4的结果"<<endl;
    
        int result=0,result1=0;
        PyArg_Parse(pyResult, "i", &result);//转换返回类型
        cout<< result<< "---F4的结果" <<endl;
    
        // f5调用, ---用于返回结果的显示 int, int, char, 这里float有错
        char * s1 ;
        double f1=1.12;
        pyResult = PyObject_CallMethod(pModule, "f5", "ii", 12,2); //直接调用包里面f4函数, 函数传递的值为int型12
        cout<< PyFloat_AsDouble(pyResult) << "---F5的结果"<<endl;
        PyArg_ParseTuple(pyResult, "iisd", &result,&result1,&s1, f1);
        cout<< result<<"--"<<result1<< "---F5的结果" <<s1<<f1<<endl;
        Py_Finalize();
    }

执行结果:

$ g++ -I /home/zjq/.conda/envs/gymlab/include/python3.6m/ main_function.cpp -L /home/zjq/.conda/envs/lib/ -l python3.6m
    $ ./a.out
    hello world!!!
    发现模块hello
    258---F4的结果
    245---F4的结果
    245---F4的结果
    -1---F5的结果 //这里是错误的输出
    24--14---F5的结果hello1.12

## 3.3 C++调用python里面的类和类方法 ##

// 运行命令
    // g++ -I /usr/include/python3.6 main_class.cpp 
    // -L /usr/lib/python3.6/config-3.6m-x86_64-linux-gnu/ -l python3.6
    #include<iostream>
    // #include</home/zjq/.conda/envs/gymlab/include/python3.6m/Python.h> 
    //这里指定了头文件的绝对路径之后, 在编译命令就不需要-I /usr/include/python3.6
    #include <Python.h>
    using namespace std;
    int main(int argc, char* argv[]){ 
        
        //初始化python
        Py_Initialize(); 
        if (!Py_IsInitialized()) { 
            printf("初始化失败！");
            return 0;
        }
    
        PyRun_SimpleString("import sys; sys.path.append('src_py/')"); // 添加路径
        PyObject* pyResult=NULL;
        PyObject* pModule=NULL;
        PyObject* pInstance_H=NULL;
        PyObject* pClass=NULL;
        PyObject* pFunc=NULL;
        PyObject* pyClassInstance=NULL;
        PyObject* pyArgs=NULL;
    
        pModule = PyImport_ImportModule("hello");  // 存储导入的.py文件模块
        pClass = PyObject_GetAttrString(pModule, "H"); // 加载对象
        pyArgs = PyTuple_New(2);
        PyTuple_SetItem(pyArgs, 0, Py_BuildValue("i", 25));
        PyTuple_SetItem(pyArgs, 1, Py_BuildValue("i", 32));
        pyClassInstance = PyObject_CallObject(pClass, pyArgs); //创建对象, 并给对象传递参数
        
        // 调用对象里面的函数
        pyResult = PyObject_CallMethod(pyClassInstance, "f2", "i", 12);
        cout<<"第一个函数调用结果"<<PyFloat_AsDouble(pyResult)<<endl;
        int result=0;
        PyArg_Parse(pyResult, "i", &result); //将函数返回结果转化为long型 
        cout<<"神奇的一幕出现了"<<result<<endl;
    
        Py_Finalize();
    }

执行结果:

$ g++ -I /home/zjq/.conda/envs/gymlab/include/python3.6m/ main_class.cpp -L /home/zjq/.conda/envs/lib/ -l python3.6m
    $ ./a.out
    hello world!!!
    25 32 调用类成功
    第一个函数调用结果69
    神奇的一幕出现了69

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDYwODE5_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/3976f7db7f4b4e1484ba3c89958351dd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDYwODE5_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/e1d2734361a04ba6b851b11eb4eb67ea.png
[20200909111805411.png_pic_center]: /images/20221123/2f7ad1b2c4b3475da0f023ca9ce06542.png
[python_3.6.8]: https://docs.python.org/3.6/search.html?q=PyBytes_AsString&check_keywords=yes&area=default