C++调用Python的方法

0 背景

在一个C/C++应用程序中，我们可以用一组插件来实现一些具有统一接口的功能，一般插件都是使用动态链接库实现，如果插件的变化比较频繁，我们可以使用 Python 来代替动态链接库形式的插件，这样可以很方便地更具需要求的变化改写脚本代码（进行不同的数据处理），而不是必须重新编译链接二进制的动态链接库。

在《Python调用C++程序的几种方法》中，我们介绍了 python 调用 c++ 的一些方法，实际项目中，有时会遇到 c++ 调用 python 的需求，比如实现代码加密、扩展 c++ 功能等功能，因此本文对相关方法做一个整理记录。

1 调用流程

c++ 调用 python ，本质上是在 c++ 中启动了一个 python 解释器，由解释器对 python 相关的代码进行执行，执行完毕后释放资源，达到调用目的。

下边的代码 main.cpp 包含了调用流程内容

// main.cpp
#include <Python.h>
int main(int argc, char *argv[]) {
  // 初始化python解释器.C/C++中调用Python之前必须先初始化解释器
  Py_Initialize();
  
  // 执行一个简单的执行python脚本命令
  PyRun_SimpleString("print('hello world')\n");

  // 撤销Py_Initialize()和随后使用Python/C API函数进行的所有初始化
  Py_Finalize();
  return 0;
}

编译方法（注意这里要替换为你实际使用的 python 库和头文件路径，可以使用 whereis python 指令找到）

g++ main.cpp  -I/usr/include/python3.5 -lpython3.5m -o test

运行后输出如下

2 无参函数调用

在上边的例子中，我们介绍了在 c++ 中执行 python 语句的方法，简单的完成了一个 print 功能。而实际使用时，我们需要调用 python 模块以及模块中的函数，并且有可能需要参数传递以及返回值获取。我们首先先实现一个简单的无参数传递的函数调用功能。

#include <Python.h>
#include <iostream>

using namespace std;

int main(){
    // 1、初始化python接口  
	Py_Initialize();
	if(!Py_IsInitialized()){
		cout << "python init fail" << endl;
		return 0;
	}
    // 2、初始化python系统文件路径，保证可以访问到 .py文件
	PyRun_SimpleString("import sys");
	PyRun_SimpleString("sys.path.append('./script')");

    // 3、调用python文件名，不用写后缀
	PyObject* pModule = PyImport_ImportModule("sayhello");
	if( pModule == NULL ){
		cout <<"module not found" << endl;
		return 1;
	}
    // 4、调用函数
	PyObject* pFunc = PyObject_GetAttrString(pModule, "say");
	if( !pFunc || !PyCallable_Check(pFunc)){
		cout <<"not found function add_num" << endl;
		return 0;
	}
    // 
    PyObject_CallObject(pFunc, NULL);
    // 5、结束python接口初始化
	Py_Finalize();
	return 0;
}

 python 脚本内容

def say():
    print("hello")

编译并执行

3 有参函数调用

// test2.cpp
#include<Python.h> 
#include <iostream>
using namespace std;
 
int main()
{
    Py_Initialize(); //1、初始化python接口
    
    //初始化使用的变量
    PyObject* pModule = NULL;
    PyObject* pFunc = NULL;
    PyObject* pName = NULL;
    
    //2、初始化python系统文件路径，保证可以访问到 .py文件
    PyRun_SimpleString("import sys");
    PyRun_SimpleString("sys.path.append('./')");
    
    //3、调用python文件名。当前的测试python文件名是 myadd.py
    // 在使用这个函数的时候，只需要写文件的名称就可以了。不用写后缀。
    pModule = PyImport_ImportModule("myadd");
    
    //4、调用函数
    pFunc = PyObject_GetAttrString(pModule, "AdditionFc");
    
    //5、给python传参数
    // 函数调用的参数传递均是以元组的形式打包的,2表示参数个数
    // 如果AdditionFc中只有一个参数时，写1就可以了
    PyObject* pArgs = PyTuple_New(2);

    // 0：第一个参数，传入 int 类型的值 2
    PyTuple_SetItem(pArgs, 0, Py_BuildValue("i", 2)); 
    // 1：第二个参数，传入 int 类型的值 4
    PyTuple_SetItem(pArgs, 1, Py_BuildValue("i", 4)); 
    
    // 6、使用C++的python接口调用该函数
    PyObject* pReturn = PyEval_CallObject(pFunc, pArgs);
    
    // 7、接收python计算好的返回值
    int nResult;
    // i表示转换成int型变量。
    // 在这里，最需要注意的是：PyArg_Parse的最后一个参数，必须加上“&”符号
    PyArg_Parse(pReturn, "i", &nResult);
    cout << "return result is " << nResult << endl;
    
    //8、结束python接口初始化
    Py_Finalize();
}

其中 python 脚本内容如下

# myadd.py
def AdditionFc(a, b):
    print("Now is in python module")
    print("{} + {} = {}".format(a, b, a+b))
    return a + b

编译并测试如下