python模块与C和C++动态库相互调用实现过程示例

目录

• Python调用C/C++
• 1、Python调用C动态链接库
• C语言文件：pycall.c
• gcc编译生成动态库libpycall.so
• Python调用动态库的文件：pycall.py
• 运行结果：
• 2、Python调用C/C++原生态导出
• 3、Python调用C/C++通过boost实现
• 4、Python调用C/C++通过导出类
• 5、Python调用C/C++通过导出变参函数
• 6、Python调用C/C++通过导出带Python对象的接口

Python调用C/C++

1、Python调用C动态链接库

Python调用C库比较简单，不经过任何封装打包成so，再使用python的ctypes调用即可。

C语言文件：pycall.c

# include "stdio.h"
#include "stdlib.h"
int foof(int a,  int b){
    printf("you input %d and %d",a,b);
    return a+b;
}

gcc编译生成动态库libpycall.so

# include "stdio.h"
#include "stdlib.h"
int foof(int a,  int b){
    printf("you input %d and %d",a,b);
    return a+b;
}

Python调用动态库的文件：pycall.py

import ctypes
ll = ctypes.cdll.LoadLibrary
lib = ll("Cfoo.so")
lib.foof(1,3)

运行结果：

2、Python调用C/C++原生态导出

Python解释器就是用C实现，因此只要我们的C++的数据结构能让Python认识，理论上就是可以被直接调用的。我们实现test1.cpp如下：

#include <Python.h>
int Add(int x, int y)
{
    return x + y;
}
int Del(int x, int y)
{
    return x - y;
}
PyObject* WrappAdd(PyObject* self, PyObject* args)
{
    int x, y;
    if (!PyArg_ParseTuple(args, "ii", &x, &y))
    {
        return NULL;
    }
    return Py_BuildValue("i", Add(x, y));
}
PyObject* WrappDel(PyObject* self, PyObject* args)
{
    int x, y;
    if (!PyArg_ParseTuple(args, "ii", &x, &y))
    {
        return NULL;
    }
    return Py_BuildValue("i", Del(x, y));
}
static PyMethodDef test_methods[] = {
    {"Add", WrappAdd, METH_VARARGS, "something"},
    {"Del", WrappDel, METH_VARARGS, "something"},
    {NULL, NULL}
};
extern "C"
void inittest1()
{
    Py_InitModule("test1", test_methods);
}

编译命令如下：

g++ -fPIC -shared test1.cpp -I/usr/include/python2.7 -o test1.so

-fPIC：生成位置无关目标代码，适用于动态连接；
-L path：表示在path目录中搜索库文件，如-L.表示在当前目录；
-I path：表示在path目录中搜索头文件；
-o file：制定输出文件为file；
-shared：生成一个共享库文件；

运行Python解释器，测试如下:

>>> import test1
>>> test1.Add(1,2)
3

这里要注意一下几点:

1.如果生成的动态库名字为test1，则源文件里必须有inittest1这个函数，且Py_InitModule的第一个参数必须是“test1”，否则Python导入模块会失败

2.如果是cpp源文件，inittest1函数必须用extern "C"修饰，如果是c源文件，则不需要。原因是Python解释器在导入库时会寻找initxxx这样的函数，而C和C++对函数符号的编码方式不同，C++在对函数符号进行编码时会考虑函数长度和参数类型，具体可以通过nm test1.so查看函数符号，c++filt工具可通过符号反解出函数原型

3.PyArg_ParseTuple()函数的定义：
arg参数必须是一个元组对象,它包含了从Python传递到C语言函数的参数列表。format参数必须是格式字符串, 具体将在下方解释.其余参数必须是变量的地址,其类型由格式字符串决定。为了能成功的转换,arg对象必须与格式匹配,并且前后一一对应。
虽然 PyArg_ParseTuple() 检查Python是否具有所需类型, 但是它不能检查传递给调用的C变量地址的有效性: 如果在那里出错，您的代码可能会崩溃，或者覆盖内存中的随机位置。所以要小心

读取一个变体C变量C和商店为两个变量,第一个指针指向一个编码名称字符串(encoding),第二个一个指向指针的指针一个字符缓冲区(**buffer,缓冲用于存储编码数据)和第三个整数指针(*buffer_length,缓冲区长度)。
编码名称必须映射到已注册的编解码器。如果设置为NULL，则使用默认编码。

PyArg_ParseTuple()将使用PyMem_NEW()分配一个所需大小的缓冲区，将已编码的数据复制到这个缓冲区中，并调整*buffer以引用新分配的存储。调用方负责调用PyMem_Free()以在使用后释放分配的缓冲区。
编码名称必须映射到已注册的编解码器。如果设置为NULL，则使用默认编码。操作方式有两种:

如果buffer指向空指针，PyArg_ParseTuple()将使用PyMem_NEW()分配一个所需大小的缓冲区，将已编码的数据复制到这个缓冲区，并调整buffer以引用新分配的存储。调用方负责在使用后调用PyMem_Free()来释放分配的缓冲区。

如果buffer指向非空指针(已经分配的缓冲区)，PyArg_ParseTuple()将使用这个位置作为缓冲区，并将buffer_length解释为缓冲区大小。然后，它将把编码后的数据复制到缓冲区中，并终止(0-terminate)它。缓冲区溢出以异常信号表示。

在这两种情况下，都将*buffer_length设置为编码数据的长度，没有后面的0字节(0-byte)。

3、Python调用C/C++通过boost实现

我们使用和上面同样的例子，实现test2.cpp如下：

#include <boost/python/module.hpp>
#include <boost/python/def.hpp>
using namespace boost::python;
int Add(const int x, const int y)
{
    return x + y;
} 

int Del(const int x, const int y)
{
    return x - y;
}
BOOST_PYTHON_MODULE(test2)
{
    def("Add", Add);
    def("Del", Del);
}

其中BOOST_PYTHON_MODULE的参数为要导出的模块名字，编译命令如下：

g++ test2.cpp -fPIC -shared -o test2.so -I/usr/include/python2.7 -I/usr/local/include -L/usr/local/lib -lboost_python

注意： 编译时需要指定boost头文件和库的路径，我这里分别是/usr/local/include和/usr/local/lib

或者通过setup.py导出模块：

#!/usr/bin/env python
from distutils.core import setup
from distutils.extension import Extension
setup(name="PackageName",
 ext_modules=[
  Extension("test2", ["test2.cpp"],
  libraries = ["boost_python"])
 ])

Extension的第一个参数为模块名，第二个参数为文件名
执行如下命令：

python setup.py build

这时会生成build目录，找到里面的test2.so，并进入同一级目录，验证如下：

>>> import test2
>>> test2.Add(1,2)
3
>>> test2.Del(1,2)
-1

4、Python调用C/C++通过导出类

test3.cpp实现如下：

#include <boost/python.hpp>
using namespace boost::python;
class Test
{
    public:
        int Add(const int x, const int y)
        {
            return x + y;
        } 

        int Del(const int x, const int y)
        {
            return x - y;
        }
};
BOOST_PYTHON_MODULE(test3)
{
    class_<Test>("Test")
        .def("Add", &Test::Add)
        .def("Del", &Test::Del);
}

注意：BOOST_PYTHON_MODULE里的.def使用方法有点类似Python的语法，等同于：

class_<Test>("Test").def("Add", &Test::Add);
class_<Test>("Test").def("Del", &Test::Del);

编译命令如下：

g++ test3.cpp -fPIC -shared -o test3.so -I/usr/include/python2.7 -I/usr/local/include/boost -L/usr/local/lib -lboost_python

测试如下：

>>> import test3
>>> test = test3.Test()
>>> test.Add(1,2)
3
>>> test.Del(1,2)
-1

5、Python调用C/C++通过导出变参函数

test4.cpp实现如下：

#include <boost/python.hpp>
using namespace boost::python; 

class Test
{
    public:
        int Add(const int x, const int y, const int z = 100)
        {
        return x + y + z;
        }
}; 

int Del(const int x, const int y, const int z = 100)
{
    return x - y - z;
} 

BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(Add_member_overloads, Add, 2, 3)
BOOST_PYTHON_FUNCTION_OVERLOADS(Del_overloads, Del, 2, 3) 

BOOST_PYTHON_MODULE(test4)
{
    class_<Test>("Test")
        .def("Add", &Test::Add, Add_member_overloads(args("x", "y", "z"), "something"));
    def("Del", Del, Del_overloads(args("x", "y", "z"), "something"));
    }

这里Add和Del函数均采用了默认参数，Del为普通函数，Add为类成员函数，这里分别调用了不同的宏，宏的最后两个参数分别代表函数的最少参数个数和最多参数个数
编译命令如下：

g++ test4.cpp -fPIC -shared -o test4.so -I/usr/include/python2.7 -I/usr/local/include/boost -L/usr/local/lib -lboost_python

测试如下：

>>> import test4
>>> test = test4.Test()
>>> print test.Add(1,2)
103
>>> print test.Add(1,2,z=3)
6
>>> print test4.Del(1,2)
-1
>>> print test4.Del(1,2,z=3)
-1

6、Python调用C/C++通过导出带Python对象的接口

既然是导出为Python接口，调用者难免会使用Python特有的数据结构，比如tuple,list,dict，由于原生态方法太麻烦，这里只记录boost的使用方法，假设要实现如下的Python函数功能：

def Square(list_a)
{
    return [x * x for x in list_a]
}
``
`
即对传入的list每个元素计算平方，返回list类型的结果，代码如下：

```cpp
#include <boost/python.hpp> 

boost::python::list Square(boost::python::list& data)
{
    boost::python::list ret;
    for (int i = 0; i < len(data); ++i)
    {
        ret.append(data[i] * data[i]);
    } 

    return ret;
}
BOOST_PYTHON_MODULE(test5)
{
    def("Square", Square);
}

编译命令如下

g++ test5.cpp -fPIC -shared -o test5.so -I/usr/include/python2.7 -I/usr/local/include/boost -L/usr/local/lib -lboost_python

测试如下：

>>> import test5
>>> test5.Square([1,2,3])
[1, 4, 9]

boost实现了boost::python::tuple, boost::python::list, boost::python::dict这几个数据类型，使用方法基本和Python保持一致，具体方法可以查看boost头文件里的boost/python/tuple.hpp及其它对应文件
另外比较常用的一个函数是boost::python::make_tuple() ，使用方法如下

boost::python::tuple(int a, int b, int c)
{
    return boost::python::make_tuple(a, b, c);
}

以上就是python模块与C和C++动态库相互调用实现过程示例的详细内容，更多关于python模块与C和C++动态库相互调用的资料请关注我们其它相关文章！