python模塊與C和C++動態(tài)庫相互調(diào)用實現(xiàn)過程示例
Python調(diào)用C/C++
1、Python調(diào)用C動態(tài)鏈接庫
Python調(diào)用C庫比較簡單，不經(jīng)過任何封裝打包成so，再使用python的ctypes調(diào)用即可。
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編譯生成動態(tài)庫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調(diào)用動態(tài)庫的文件：pycall.py
import ctypes
ll = ctypes.cdll.LoadLibrary
lib = ll("Cfoo.so")
lib.foof(1,3)
運(yùn)行結(jié)果：
2、Python調(diào)用C/C++原生態(tài)導(dǎo)出
Python解釋器就是用C實現(xiàn)，因此只要我們的C++的數(shù)據(jù)結(jié)構(gòu)能讓Python認(rèn)識，理論上就是可以被直接調(diào)用的。我們實現(xiàn)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：生成位置無關(guān)目標(biāo)代碼，適用于動態(tài)連接；-L path：表示在path目錄中搜索庫文件，如-L.表示在當(dāng)前目錄；-I path：表示在path目錄中搜索頭文件；-o file：制定輸出文件為file；-shared：生成一個共享庫文件；
運(yùn)行Python解釋器，測試如下:
>>> import test1 >>> test1.Add(1,2) 3
這里要注意一下幾點:
1.如果生成的動態(tài)庫名字為test1，則源文件里必須有inittest1這個函數(shù)，且Py_InitModule的第一個參數(shù)必須是“test1”，否則Python導(dǎo)入模塊會失敗
2.如果是cpp源文件，inittest1函數(shù)必須用extern "C"修飾，如果是c源文件，則不需要。原因是Python解釋器在導(dǎo)入庫時會尋找initxxx這樣的函數(shù)，而C和C++對函數(shù)符號的編碼方式不同，C++在對函數(shù)符號進(jìn)行編碼時會考慮函數(shù)長度和參數(shù)類型，具體可以通過nm test1.so查看函數(shù)符號，c++filt工具可通過符號反解出函數(shù)原型
3.PyArg_ParseTuple()函數(shù)的定義：
arg參數(shù)必須是一個元組對象,它包含了從Python傳遞到C語言函數(shù)的參數(shù)列表。format參數(shù)必須是格式字符串, 具體將在下方解釋.其余參數(shù)必須是變量的地址,其類型由格式字符串決定。為了能成功的轉(zhuǎn)換,arg對象必須與格式匹配,并且前后一一對應(yīng)。
雖然 PyArg_ParseTuple() 檢查Python是否具有所需類型, 但是它不能檢查傳遞給調(diào)用的C變量地址的有效性: 如果在那里出錯，您的代碼可能會崩潰，或者覆蓋內(nèi)存中的隨機(jī)位置。所以要小心
| 字符串 | 備注 |
|---|---|
| “s” (string or Unicode object) [char *] | 將Python字符串或Unicode對象轉(zhuǎn)換為指向字符串的C指針。不能為字符串本身提供存儲;指向現(xiàn)有字符串的指針存儲在您傳遞地址的字符指針變量中。C字符串以NULL結(jié)尾。Python字符串不能包含嵌入的空字節(jié);如果有，就會引發(fā)TypeError異常。使用默認(rèn)編碼將Unicode對象轉(zhuǎn)換為C字符串。如果轉(zhuǎn)換失敗，就會引發(fā)一個UnicodeError異常 |
| “s#” (string,Unicode or any read buffer compatible object) [char *, int] | “s”上的這個變體存儲在兩個C變量中，第一個變量是指向字符串的指針，第二個變量是字符串的長度。在這種情況下，Python字符串可能包含嵌入的空字節(jié)。如果可能的話，Unicode對象會返回一個指向?qū)ο蟮哪J(rèn)編碼字符串版本的指針。所有其他與讀取緩沖區(qū)兼容的對象都將對原始內(nèi)部數(shù)據(jù)表示的引用傳回。 |
| “z” (string or None) [char *] | 與“s”類似，但是Python對象也可能是None，在這種情況下，C指針被設(shè)置為NULL。 |
| “z#” (string or None or any read buffer compatible object) [char *, int] | 這是"s#"就像"z"是"s"一樣。 |
| “u” (Unicode object) [Py_UNICODE *] | 將Python Unicode對象轉(zhuǎn)換為指向16位Unicode (UTF-16)數(shù)據(jù)的空端緩沖區(qū)的C指針。與“s”一樣，不需要為Unicode數(shù)據(jù)緩沖區(qū)提供存儲;指向現(xiàn)有Unicode數(shù)據(jù)的指針被存儲到Py_UNICODE指針變量中，您傳遞的地址就是這個變量。 |
| “u#” (Unicode object) [Py_UNICODE *, int] | “u”上的這個變體存儲在兩個C變量中，第一個變量是指向Unicode數(shù)據(jù)緩沖區(qū)的指針，第二個變量是它的長度。 |
| “es” (string,Unicode object or character buffer compatible object) [const char *encoding,char **buffer] | 這個“s”的變體用于編碼Unicode和轉(zhuǎn)換為Unicode的對象到字符緩沖區(qū)。它只適用于不嵌入空字節(jié)的編碼數(shù)據(jù)。 |
讀取一個變體C變量C和商店為兩個變量,第一個指針指向一個編碼名稱字符串(encoding),第二個一個指向指針的指針一個字符緩沖區(qū)(**buffer,緩沖用于存儲編碼數(shù)據(jù))和第三個整數(shù)指針(*buffer_length,緩沖區(qū)長度)。
編碼名稱必須映射到已注冊的編解碼器。如果設(shè)置為NULL，則使用默認(rèn)編碼。
PyArg_ParseTuple()將使用PyMem_NEW()分配一個所需大小的緩沖區(qū)，將已編碼的數(shù)據(jù)復(fù)制到這個緩沖區(qū)中，并調(diào)整*buffer以引用新分配的存儲。調(diào)用方負(fù)責(zé)調(diào)用PyMem_Free()以在使用后釋放分配的緩沖區(qū)。
編碼名稱必須映射到已注冊的編解碼器。如果設(shè)置為NULL，則使用默認(rèn)編碼。操作方式有兩種:
如果buffer指向空指針，PyArg_ParseTuple()將使用PyMem_NEW()分配一個所需大小的緩沖區(qū)，將已編碼的數(shù)據(jù)復(fù)制到這個緩沖區(qū)，并調(diào)整buffer以引用新分配的存儲。調(diào)用方負(fù)責(zé)在使用后調(diào)用PyMem_Free()來釋放分配的緩沖區(qū)。
如果buffer指向非空指針(已經(jīng)分配的緩沖區(qū))，PyArg_ParseTuple()將使用這個位置作為緩沖區(qū)，并將buffer_length解釋為緩沖區(qū)大小。然后，它將把編碼后的數(shù)據(jù)復(fù)制到緩沖區(qū)中，并終止(0-terminate)它。緩沖區(qū)溢出以異常信號表示。
在這兩種情況下，都將*buffer_length設(shè)置為編碼數(shù)據(jù)的長度，沒有后面的0字節(jié)(0-byte)。
| 字符串 | 備注 |
|---|---|
| “b” (integer) [char] | 將Python整數(shù)轉(zhuǎn)換為存儲在C語言char中的一個小int(tiny int)。 |
| “h” (integer) [short int] | 將Python整數(shù)轉(zhuǎn)換為C語言short int。 |
| “i” (integer) [int] | 將Python整數(shù)轉(zhuǎn)換為普通的C語言int。 |
| “l(fā)” (integer) [long int] | 將Python整數(shù)轉(zhuǎn)換為C語言long int。 |
| “c” (string of length 1) [char] | 將長度為1的字符串表示的Python字符轉(zhuǎn)換為C語言char。 |
| “f” (float) [float] | 將Python浮點數(shù)轉(zhuǎn)換為C語言float。 |
| “d” (float) [double] | 將Python浮點數(shù)轉(zhuǎn)換為C 語言double。 |
| “D” (complex) [Py_complex] | 將Python復(fù)數(shù)轉(zhuǎn)換為C語言Py_complex結(jié)構(gòu)。 |
| “O” (object) [PyObject *] | 在C對象指針中存儲Python對象(不進(jìn)行任何轉(zhuǎn)換)。因此，C程序接收傳遞的實際對象。對象的引用計數(shù)沒有增加。存儲的指針不是空的(NULL)。 |
| “O!” (object)[typeobject, PyObject *] | 將Python對象存儲在C對象指針中。這類似于“O”，但是接受兩個C參數(shù):第一個是Python類型對象的地址，第二個是對象指針存儲在其中的C變量(類型為PyObject *)的地址。如果Python對象沒有所需的類型，就會引發(fā)類型錯誤(TypeError)。 |
| “O&” (object)[converter,anything] | 通過轉(zhuǎn)換器函數(shù)將Python對象轉(zhuǎn)換為C變量。這需要兩個參數(shù):第一個是函數(shù)，第二個是C變量(任意類型)的地址，轉(zhuǎn)換為void *。該轉(zhuǎn)換器功能依次調(diào)用如下:status = converter(object,address);對象是要轉(zhuǎn)換的Python對象，地址是傳遞給PyArg_ConvertTuple()的void *參數(shù)。對于成功的轉(zhuǎn)換，返回的狀態(tài)應(yīng)該是1，如果轉(zhuǎn)換失敗，則返回0。當(dāng)轉(zhuǎn)換失敗時，converter(函數(shù)名可能錯誤)函數(shù)應(yīng)該引發(fā)異常。 |
| “S” (string) [PyStringObject *] | 與“O”類似，但要求Python對象是字符串對象。如果對象不是字符串對象，則引發(fā)類型錯誤(TypeError)。C變量也可以聲明為PyObject *。 |
| “U” (Unicode string) [PyUnicodeObject *] | 與“O”類似，但要求Python對象是Unicode對象。如果對象不是Unicode對象，則引發(fā)類型錯誤(TypeError)。C變量也可以聲明為PyObject *。 |
| “t#” (read-only character buffer) [char *, int] | 與“s#”類似，但接受任何實現(xiàn)只讀緩沖區(qū)接口的對象。char *變量設(shè)置為指向緩沖區(qū)的第一個字節(jié)，int設(shè)置為緩沖區(qū)的長度。只接受單段緩沖對象;對所有其他類型都引發(fā)類型錯誤(TypeError)。 |
| “w” (read-write character buffer) [char *] | 類似于“s”，但接受任何實現(xiàn)讀寫緩沖區(qū)接口的對象。調(diào)用者必須通過其他方法確定緩沖區(qū)的長度，或者使用“w#”。只接受單段緩沖對象;對所有其他類型都引發(fā)類型錯誤(TypeError)。 |
| “w#” (read-write character buffer) [char *, int] | 與“s#”類似，但接受任何實現(xiàn)讀寫緩沖區(qū)接口的對象。char *變量設(shè)置為指向緩沖區(qū)的第一個字節(jié)，int設(shè)置為緩沖區(qū)的長度。只接受單段緩沖對象;對所有其他類型都引發(fā)類型錯誤(TypeError)。 |
| “(items)” (tuple) [matching-items] | 對象必須是一個Python序列，其長度是項中的格式單元數(shù)。C參數(shù)必須對應(yīng)于項中的單個格式單元。序列的格式單元可以嵌套。 |
3、Python調(diào)用C/C++通過boost實現(xiàn)
我們使用和上面同樣的例子，實現(xiàn)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的參數(shù)為要導(dǎo)出的模塊名字，編譯命令如下：
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導(dǎo)出模塊：
#!/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的第一個參數(shù)為模塊名，第二個參數(shù)為文件名
執(zhí)行如下命令：
python setup.py build
這時會生成build目錄，找到里面的test2.so，并進(jìn)入同一級目錄，驗證如下：
>>> import test2 >>> test2.Add(1,2) 3 >>> test2.Del(1,2) -1
4、Python調(diào)用C/C++通過導(dǎo)出類
test3.cpp實現(xiàn)如下：
#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調(diào)用C/C++通過導(dǎo)出變參函數(shù)
test4.cpp實現(xiàn)如下：
#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函數(shù)均采用了默認(rèn)參數(shù)，Del為普通函數(shù)，Add為類成員函數(shù)，這里分別調(diào)用了不同的宏，宏的最后兩個參數(shù)分別代表函數(shù)的最少參數(shù)個數(shù)和最多參數(shù)個數(shù)
編譯命令如下：
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調(diào)用C/C++通過導(dǎo)出帶Python對象的接口
既然是導(dǎo)出為Python接口，調(diào)用者難免會使用Python特有的數(shù)據(jù)結(jié)構(gòu)，比如tuple,list,dict，由于原生態(tài)方法太麻煩，這里只記錄boost的使用方法，假設(shè)要實現(xiàn)如下的Python函數(shù)功能：
def Square(list_a)
{
return [x * x for x in list_a]
}
``
`
即對傳入的list每個元素計算平方，返回list類型的結(jié)果，代碼如下：
```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實現(xiàn)了boost::python::tuple, boost::python::list, boost::python::dict這幾個數(shù)據(jù)類型，使用方法基本和Python保持一致，具體方法可以查看boost頭文件里的boost/python/tuple.hpp及其它對應(yīng)文件
另外比較常用的一個函數(shù)是boost::python::make_tuple() ，使用方法如下
boost::python::tuple(int a, int b, int c)
{
return boost::python::make_tuple(a, b, c);
}
以上就是python模塊與C和C++動態(tài)庫相互調(diào)用實現(xiàn)過程示例的詳細(xì)內(nèi)容，更多關(guān)于python模塊與C和C++動態(tài)庫相互調(diào)用的資料請關(guān)注本站其它相關(guān)文章！
版權(quán)聲明：本站文章來源標(biāo)注為YINGSOO的內(nèi)容版權(quán)均為本站所有，歡迎引用、轉(zhuǎn)載，請保持原文完整并注明來源及原文鏈接。禁止復(fù)制或仿造本網(wǎng)站，禁止在非www.sddonglingsh.com所屬的服務(wù)器上建立鏡像，否則將依法追究法律責(zé)任。本站部分內(nèi)容來源于網(wǎng)友推薦、互聯(lián)網(wǎng)收集整理而來，僅供學(xué)習(xí)參考，不代表本站立場，如有內(nèi)容涉嫌侵權(quán)，請聯(lián)系alex-e#qq.com處理。
關(guān)注官方微信