C語言調(diào)用Python代碼的方法
問題
你想在C中安全的執(zhí)行某個(gè)Python調(diào)用并返回結(jié)果給C。 例如,你想在C語言中使用某個(gè)Python函數(shù)作為一個(gè)回調(diào)。
解決方案
在C語言中調(diào)用Python非常簡(jiǎn)單,不過涉及到一些小竅門。 下面的C代碼告訴你怎樣安全的調(diào)用:
#include <Python.h> /* Execute func(x,y) in the Python interpreter. The arguments and return result of the function must be Python floats */ double call_func(PyObject *func, double x, double y) { PyObject *args; PyObject *kwargs; PyObject *result = 0; double retval; /* Make sure we own the GIL */ PyGILState_STATE state = PyGILState_Ensure(); /* Verify that func is a proper callable */ if (!PyCallable_Check(func)) { fprintf(stderr,”call_func: expected a callablen”); goto fail; } /* Build arguments */ args = Py_BuildValue(“(dd)”, x, y); kwargs = NULL; /* Call the function */ result = PyObject_Call(func, args, kwargs); Py_DECREF(args); Py_XDECREF(kwargs); /* Check for Python exceptions (if any) */ if (PyErr_Occurred()) { PyErr_Print(); goto fail; } /* Verify the result is a float object */ if (!PyFloat_Check(result)) { fprintf(stderr,”call_func: callable didn't return a floatn”); goto fail; } /* Create the return value */ retval = PyFloat_AsDouble(result); Py_DECREF(result); /* Restore previous GIL state and return */ PyGILState_Release(state); return retval; fail: Py_XDECREF(result); PyGILState_Release(state); abort(); // Change to something more appropriate }
要使用這個(gè)函數(shù),你需要獲取傳遞過來的某個(gè)已存在Python調(diào)用的引用。 有很多種方法可以讓你這樣做, 比如將一個(gè)可調(diào)用對(duì)象傳給一個(gè)擴(kuò)展模塊或直接寫C代碼從已存在模塊中提取出來。
下面是一個(gè)簡(jiǎn)單例子用來展示從一個(gè)嵌入的Python解釋器中調(diào)用一個(gè)函數(shù):
#include <Python.h> /* Definition of call_func() same as above */ ... /* Load a symbol from a module */ PyObject *import_name(const char *modname, const char *symbol) { PyObject *u_name, *module; u_name = PyUnicode_FromString(modname); module = PyImport_Import(u_name); Py_DECREF(u_name); return PyObject_GetAttrString(module, symbol); } /* Simple embedding example */ int main() { PyObject *pow_func; double x; Py_Initialize(); /* Get a reference to the math.pow function */ pow_func = import_name("math","pow"); /* Call it using our call_func() code */ for (x = 0.0; x < 10.0; x += 0.1) { printf("%0.2f %0.2f\n", x, call_func(pow_func,x,2.0)); } /* Done */ Py_DECREF(pow_func); Py_Finalize(); return 0; }
要構(gòu)建例子代碼,你需要編譯C并將它鏈接到Python解釋器。 下面的Makefile可以教你怎樣做(不過在你機(jī)器上面需要一些配置)。
all:: cc -g embed.c -I/usr/local/include/python3.3m \ -L/usr/local/lib/python3.3/config-3.3m -lpython3.3m
編譯并運(yùn)行會(huì)產(chǎn)生類似下面的輸出:
0.00 0.00
0.10 0.01
0.20 0.04
0.30 0.09
0.40 0.16
...
下面是一個(gè)稍微不同的例子,展示了一個(gè)擴(kuò)展函數(shù), 它接受一個(gè)可調(diào)用對(duì)象和其他參數(shù),并將它們傳遞給 call_func() 來做測(cè)試:
/* Extension function for testing the C-Python callback */ PyObject *py_call_func(PyObject *self, PyObject *args) { PyObject *func; double x, y, result; if (!PyArg_ParseTuple(args,"Odd", &func,&x,&y)) { return NULL; } result = call_func(func, x, y); return Py_BuildValue("d", result); }
使用這個(gè)擴(kuò)展函數(shù),你要像下面這樣測(cè)試它:
>>> import sample >>> def add(x,y): ... return x+y ... >>> sample.call_func(add,3,4) 7.0 >>>
討論
如果你在C語言中調(diào)用Python,要記住最重要的是C語言會(huì)是主體。 也就是說,C語言負(fù)責(zé)構(gòu)造參數(shù)、調(diào)用Python函數(shù)、檢查異常、檢查類型、提取返回值等。
作為第一步,你必須先有一個(gè)表示你將要調(diào)用的Python可調(diào)用對(duì)象。 這可以是一個(gè)函數(shù)、類、方法、內(nèi)置方法或其他任意實(shí)現(xiàn)了 __call__()
操作的東西。 為了確保是可調(diào)用的,可以像下面的代碼這樣利用 PyCallable_Check()
做檢查:
double call_func(PyObject *func, double x, double y) { ... /* Verify that func is a proper callable */ if (!PyCallable_Check(func)) { fprintf(stderr,"call_func: expected a callable\n"); goto fail; } ...
在C代碼里處理錯(cuò)誤你需要格外的小心。一般來講,你不能僅僅拋出一個(gè)Python異常。 錯(cuò)誤應(yīng)該使用C代碼方式來被處理。在這里,我們打算將對(duì)錯(cuò)誤的控制傳給一個(gè)叫 abort()
的錯(cuò)誤處理器。 它會(huì)結(jié)束掉整個(gè)程序,在真實(shí)環(huán)境下面你應(yīng)該要處理的更加優(yōu)雅些(返回一個(gè)狀態(tài)碼)。 你要記住的是在這里C是主角,因此并沒有跟拋出異常相對(duì)應(yīng)的操作。 錯(cuò)誤處理是你在編程時(shí)必須要考慮的事情。
調(diào)用一個(gè)函數(shù)相對(duì)來講很簡(jiǎn)單——只需要使用 PyObject_Call()
, 傳一個(gè)可調(diào)用對(duì)象給它、一個(gè)參數(shù)元組和一個(gè)可選的關(guān)鍵字字典。 要構(gòu)建參數(shù)元組或字典,你可以使用 Py_BuildValue()
,如下:
double call_func(PyObject *func, double x, double y) { PyObject *args; PyObject *kwargs; ... /* Build arguments */ args = Py_BuildValue("(dd)", x, y); kwargs = NULL; /* Call the function */ result = PyObject_Call(func, args, kwargs); Py_DECREF(args); Py_XDECREF(kwargs); ...
如果沒有關(guān)鍵字參數(shù),你可以傳遞NULL。當(dāng)你要調(diào)用函數(shù)時(shí), 需要確保使用了 Py_DECREF()
或者 Py_XDECREF()
清理參數(shù)。 第二個(gè)函數(shù)相對(duì)安全點(diǎn),因?yàn)樗试S傳遞NULL指針(直接忽略它), 這也是為什么我們使用它來清理可選的關(guān)鍵字參數(shù)。
調(diào)用完P(guān)ython函數(shù)之后,你必須檢查是否有異常發(fā)生。 PyErr_Occurred() 函數(shù)可被用來做這件事。 對(duì)于異常的處理就有點(diǎn)麻煩了,由于是用C語言寫的,沒有Python那樣的異常機(jī)制。 因此,你必須要設(shè)置一個(gè)異常狀態(tài)碼,打印異常信息或其他相應(yīng)處理。 在這里,我們選擇了簡(jiǎn)單的 abort()
來處理。另外,傳統(tǒng)C程序員可能會(huì)直接讓程序奔潰。
... /* Check for Python exceptions (if any) */ if (PyErr_Occurred()) { PyErr_Print(); goto fail; } ... fail: PyGILState_Release(state); abort();
從調(diào)用Python函數(shù)的返回值中提取信息通常要進(jìn)行類型檢查和提取值。 要這樣做的話,你必須使用Python對(duì)象層中的函數(shù)。 在這里我們使用了 PyFloat_Check()
和 PyFloat_AsDouble()
來檢查和提取Python浮點(diǎn)數(shù)。
最后一個(gè)問題是對(duì)于Python全局鎖的管理。 在C語言中訪問Python的時(shí)候,你需要確保GIL被正確的獲取和釋放了。 不然的話,可能會(huì)導(dǎo)致解釋器返回錯(cuò)誤數(shù)據(jù)或者直接奔潰。 調(diào)用 PyGILState_Ensure() 和 PyGILState_Release() 可以確保一切都能正常。
double call_func(PyObject *func, double x, double y) { ... double retval; /* Make sure we own the GIL */ PyGILState_STATE state = PyGILState_Ensure(); ... /* Code that uses Python C API functions */ ... /* Restore previous GIL state and return */ PyGILState_Release(state); return retval; fail: PyGILState_Release(state); abort(); }
一旦返回,PyGILState_Ensure()
可以確保調(diào)用線程獨(dú)占Python解釋器。 就算C代碼運(yùn)行于另外一個(gè)解釋器不知道的線程也沒事。 這時(shí)候,C代碼可以自由的使用任何它想要的Python C-API 函數(shù)。 調(diào)用成功后,PyGILState_Release()被用來將解釋器恢復(fù)到原始狀態(tài)。
要注意的是每一個(gè) PyGILState_Ensure()
調(diào)用必須跟著一個(gè)匹配的 PyGILState_Release()
調(diào)用——即便有錯(cuò)誤發(fā)生。 在這里,我們使用一個(gè) goto
語句看上去是個(gè)可怕的設(shè)計(jì), 但是實(shí)際上我們使用它來將控制權(quán)轉(zhuǎn)移給一個(gè)普通的exit塊來執(zhí)行相應(yīng)的操作。 在 fail
: 標(biāo)簽后面的代碼和Python的 final
: 塊的用途是一樣的。
如果你使用所有這些約定來編寫C代碼,包括對(duì)GIL的管理、異常檢查和錯(cuò)誤檢查, 你會(huì)發(fā)現(xiàn)從C語言中調(diào)用Python解釋器是可靠的——就算再復(fù)雜的程序,用到了高級(jí)編程技巧比如多線程都沒問題。
以上就是C語言調(diào)用Python代碼的方法的詳細(xì)內(nèi)容,更多關(guān)于C語言調(diào)用Python的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
詳解C語言 三大循環(huán) 四大跳轉(zhuǎn) 和判斷語句
這篇文章主要介紹了詳解C語言 三大循環(huán) 四大跳轉(zhuǎn) 和判斷語句的相關(guān)資料,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-07-07c語言實(shí)現(xiàn)兩個(gè)值互相交換的函數(shù)
本文通過代碼給大家介紹c語言實(shí)現(xiàn)兩個(gè)值互相交換的函數(shù),通過實(shí)例代碼給大家講解的很詳細(xì),具有一定的參考借鑒價(jià)值,對(duì)c語言兩個(gè)值互換函數(shù)相關(guān)知識(shí)感興趣的朋友一起看看吧2021-05-05