㈠ python C API使用時需要注意什麼
一:用C API為Python寫C語言函數,以方便Python中調用
1. 首先實現一個特定原型的函數,用Python C API來實現的話,所有函數必須是這種原型。必須是類似這樣的
PyObject *Fun(PyObject *self, PyObject *args)
self應該是在用類的時候才會用到(我沒有用到),args就是函數的參數。因為args是一個PyObject*類型(可以代表Python語言中的任何類型)
2. 將參數轉換成C 語言表示的內容,用PyArg_ParseTuple函數。
3. 執行完需要的操作後,也必須返回一個PyObject*類型的值。通過Py_BuildValue函數來構建。
這里要說的是,假如希望返回一個Tuple類型的值,可以先用
PyObject *tuple = Py_BuildValue("(iis)", 1, 2, "three");
形式來構建,假如很多的話,可以用下面的方式來構建
PyObject *t;
t = PyTuple_New(3);
PyTuple_SetItem(t, 0, PyLong_FromLong(1L));
PyTuple_SetItem(t, 1, PyLong_FromLong(2L));
PyTuple_SetItem(t, 2, PyString_FromString("three"));
這一點在剛開始開工的時候迷惑了很久。
4. 將要輸出的所有函數放入一個數組中,數組的結構是:
struct PyMethodDef {
const char *ml_name; /* The name of the built-in function/method */
PyCFunction ml_meth; /* The C function that implements it */
int ml_flags; /* Combination of METH_xxx flags, which mostly
describe the args expected by the C func */
const char *ml_doc; /* The __doc__ attribute, or NULL */
};
數組以{NULL, NULL}結束
5. 構造一個Python import時初始化的函數
類似
PyMODINIT_FUNC
initexample(void)
{
Py_InitMole("example", example_methods);
}
這里有個特別需要注意的是,初始化函數名字有嚴格要求,init後面必須跟模塊名,否則Python找不到確定的函數會報沒有初始化函數的錯誤
擴展模塊寫完後,編譯成動態庫(Python要求此動態庫名字為pyd,實際就是改個後綴而已)。就可以直接在Python腳本中用import的方式載入了,對於使用來說,根本不需要知道此庫是用C API擴展寫的還是直接用Python語句寫的(這點Lua做的也是一樣好)
最後,python的源代碼中附帶了一個叫做example_nt的例子,可以參考一樣,完整的擴展代碼如下:
#include "Python.h"
static PyObject *
ex_foo(PyObject *self, PyObject *args)
{
printf("Hello, world/n");
Py_INCREF(Py_None);
return Py_None;
}
static PyMethodDef example_methods[] = {
{"foo", ex_foo, METH_VARARGS, "foo() doc string"},
{NULL, NULL}
};
PyMODINIT_FUNC
initexample(void)
{
Py_InitMole("example", example_methods);
}
二.C語言中調用Python語句
首先,void Py_Initialize()用來初始化,void Py_Finalize()用來結束Python的調用,這是必須要的。
燃火分兩種情況,假如僅僅是幾條語句的話,那麼以PyRun_為前綴的一些函數都很好用,比如
int PyRun_SimpleString(const char *command)
函數就可以直接執行一條char*的Python語句。
需要獲得返回值得話
PyObject* PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals)
也很好用,以上兩個函數用來處理Python源代碼已經讀入內存的情況,在文件中的時候
int PyRun_SimpleFile(FILE *fp, const char *filename)
PyObject* PyRun_File(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)
使用類似。不多講了。
假如是個模塊的話(比如一個函數),希望在C語言中調用的話那麼使用起來就稍微復雜了一點。這種情況的需要在於你可以從C語言中向Python函數中傳入參數並且執行,然後獲取結果。
此處又分為幾種情況:
在文件中,在內存中,編譯過的,源代碼。
在文件中都很好解決,和上面一樣。這里主要講在內存中的情況。(事實上我工作中需要並且耗費了很長時間才找到解決方法的就是這種情況)
未編譯時:(也就是源代碼)
1.通過
PyObject* Py_CompileString(const char *str, const char *filename, int start)
API首先編譯一次。此API的參數我說明一下,str就是內存中的源代碼,filename主要是出錯時報錯誤用的,事實測試證明,你隨意給個字元串也沒有關系,但給NULL參數在運行時必然報錯。start我一般用的是Py_file_input,因為的確是從文件中讀取過來的,相對的還有Py_single_input用來表示一條語句,Py_eval_input的用法我也不是太清楚。
源代碼通過此函數調用後,獲得編譯後的PyObject*,(其實假如跟進源代碼中去看,是一個PyCodeObject結構)假設命名為lpCode。
2.此時再調用API
PyObject* PyImport_ExecCodeMole(char *name, PyObject *co)
導入模塊。參數也說明一下,name為導入的模塊名,co就是前面編譯過的代碼對象(lpCode)。返回的就是模塊對象了,假設命名為lpMod。
3.再調用API
PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name)
獲得函數對象。o就是模塊對象(lpMod),attr_name就是你想要調用的函數名了,假設叫main的函數,就是」main」,然後返回的就是函數對象,假設命名為lpFun。
4.此時可以用API
int PyCallable_Check(PyObject *o)
去檢查一下是不是獲得了一個函數。假如確定的話,就可以直接用
PyObject_Call開頭的一族函數調用lpFun了。這些函數包括很多,一般就是輸入參數的不同,但是效果都是一樣的,就是調用函數而已。參數一般可以通過前面說過的build函數來獲得,返回值也是獲得一個PyObject*,可以通過PyArg_那個函數來獲取,但是好像不太好,那是分析參數用的。推薦用確定類型(假設為type)的類似Py[type]_As的函數來獲取。
比如:
long PyLong_AsLong(PyObject *pylong)獲取long
double PyLong_AsDouble(PyObject *pylong)獲取double
這里想說的是,應該有直接從源代碼中獲取函數調用對象的方式,但是我本人沒有試出來,有人知道請一定賜教!
編譯過的代碼:
對於編譯過的代碼和上面就是獲得編譯後的PyCodeObject對象,當然在源代碼中表示還是PyObject*的方法不同(上例中的lpCode)。
當然要想以後獲得一個編譯後的lpCode,自然要先編譯一下啦。但是純粹編譯成pyc結尾的文件後,直接讀入內存,我沒有找到將其轉化為PyCodeObject對象的方法(也希望有人知道能告訴我!)
我找到的方法是先用
PyObject* PyMarshal_WriteObjectToString(PyObject *value, int version)
void PyMarshal_WriteLongToFile(long value, FILE *file, int version)
兩個函數先把PyCodeObject對象(lpCode)序列化到文件或者內存中。
再在需要的時候用函數
PyObject* PyMarshal_ReadObjectFromFile(FILE *file)
PyObject* PyMarshal_ReadObjectFromString(char *string, Py_ssize_t len)
讀出來,讀出來的PyObject*其實就是想要的PyCodeObject對象了(lpCode)。接下來的步驟與未編譯時的步驟一樣。
光是這個扭曲的方法我還是參考老總給的半邊資料反復研究出來的。而真正直接有效的方法我還是沒有找到。