python ctypes

Python の ctypes モジュールについて調べてみた。

下記のような dll を作成して、ctypes モジュールで引数、戻り値の設定の仕方をどのようにしたらよいか調査した。
---- ctypes_test.dll ----

extern "C" {
__declspec(dllexport) int plus(int, int);
__declspec(dllexport) void plus_pointer(int*, int*, int*);
__declspec(dllexport) int* alloc_int();
__declspec(dllexport) void free_int(int*);
__declspec(dllexport) int set_calc_func(int (*)(int, int));
};
int plus(int lhs, int rhs) {
　return lhs + rhs;
}
void plus_pointer(int* pLhs, int* pRhs, int* pResult) {
　*pResult = *pLhs + *pRhs;
}
int* alloc_int() {
　int* p = new int(10);
　std::cout << "new :" << p << std::endl;;
　return p;
}
void free_int(int* p) {
　std::cout << "delete :" << p << std::endl;;
　delete p;
}
int set_calc_func(int (*func)(int, int)) {
　return func(100, 25);
}


---- python側 ----

# -*- coding: utf-8 -*-

from ctypes import *
test = cdll.LoadLibrary('ctypes_test.dll')

# ---- 単純な足し算1 ----
result = test.plus(10, 20)
print result # ok 30
# 整数と文字列は気にせず利用することができるよう工夫されているそうな

# ---- 単純な足し算2 ----
lhs = c_int(32)
rhs = c_int(41)
result = test.plus(lhs, rhs)
print result # ok 73

# ---- アドレス渡し ----
lhs = c_int(15)
rhs = c_int(25)
result = c_int(0)
test.plus_pointer(byref(lhs), byref(rhs), byref(result))
print result # ok c_long(40)
print result.value # ok 40

# ---- ポインタ渡し ----
lhs = c_int(21)
rhs = c_int(47)
result = c_int(0)
test.plus_pointer(pointer(lhs), pointer(rhs), pointer(result))
print result # ok c_long(68)
print result.value # ok 68

# ---- ポインタ取得 ----

# "デフォルトでは、関数は C int を返すと仮定されます。
# 他の戻り値の型を指定するには、関数オブジェクトの restype 属性に設定します。"
# とのこと。
alloc_func = test.alloc_int
alloc_func.restype = POINTER(c_int) # 戻り値が int* 型であることを指定
ptr = alloc_func() # ok new
print ptr.contents # ok c_long 10
print ptr.contents.value # ok 10
test.free_int(ptr) # ok delete (new の場合と同じアドレスをdeleteしているのでok)

# ---- 関数ポインタ ----
def plus(i, j):
　　return i + j
def minus(i, j):
　　return i - j
FuncType = CFUNCTYPE(c_int, c_int, c_int)
plus_func = FuncType(plus)
result = test.set_calc_func(plus_func)
print result # ok c_long(125)
minus_func = FuncType(minus)
result = test.set_calc_func(minus_func)
print result # ok c_long(75)

# End of file


================================

大体、必要なことは、できそう。

C++アプリケーションからPythonのクラスのメンバ関数を呼び出す

C++アプリケーションからPythonの関数を呼び出すの続きで、Python内のクラスと、メンバ関数を呼び出します。

---- コード(Python側) testmodule.py ----

# -*- coding: utf-8 -*-

class TestClass:
　　value = 10
　　def testmethodplus(self, i, j):
　　　　return i + j + self.value;

---- コード(C++側) ----
// ---- main ----
int main(int argc, char *argv[])
{
　const char* moduleName = "testmodule";
　const char* className = "TestClass";
　char* funcName = "testmethodplus";
　Py_Initialize();

　PyObject* pyModule = NULL;
　PyObject* pyClass = NULL;
　PyObject* pyInstance = NULL;
　PyObject* pyResult = NULL;
　try {
　　PyObject* pyModuleName = PyString_FromString(moduleName);
　　pyModule = PyImport_Import(pyModuleName);
　　Py_DECREF(pyModuleName);
　　// module呼び出し失敗時に NULL が返る
　　if (NULL == pyModule) {
　　　throw PythonException();
　　}
　　// 以下、二つは、"借りた参照"
　　PyObject* pyDict = PyModule_GetDict(pyModule);
　　pyClass = PyDict_GetItemString(pyDict, className);

　　// --- クラスをcall ---

　　// 呼び出し不可オブジェクトの場合、0 が返る
　　if (0 == PyCallable_Check(pyClass)) {
　　　// --- エラー処理 ---
　　　throw PythonException();
　　}

　　// クラスの実体を取得
　　pyInstance = PyObject_CallObject(pyClass, NULL);

　　// --- メンバ関数をcall ---

　　if (NULL == pyInstance) {
　　　// --- エラー処理 ---
　　　throw PythonException();
　　}
　　pyResult = PyObject_CallMethod(pyInstance, funcName, "(ii)", 2, 5);

　　if (NULL == pyResult) {
　　　// --- エラー処理 ---
　　　throw PythonException();
　　}
　　std::cout << "Result: "
　　　<< PyInt_AsLong(pyResult) << std::endl;
　} catch (const PythonException& pyEx) {
　　if (PyErr_Occurred()) {
　　　PyErr_Print();
　　}
　　std::cout << pyEx.what() << std::endl;
　}
　Py_XDECREF(pyResult);
　Py_XDECREF(pyInstance);
　Py_XDECREF(pyModule);

　Py_Finalize();
　return 0;
}

// End of file

前回のPythonの関数呼び出しのソースを流用していますが、関数呼び出しの部分が、 クラスcall→クラスの実体を取得→メンバ関数call となっている部分が異なります。
また、メンバ関数callで、 PyObject_CallMethod() 関数を使用しているため、引数の指定の仕方が違います。(PyObject_CallMethod()関数だけではなく、ほかにも方法はあります。)

クラスの実体を取得する際に使用した PyObject_CallObject() 関数は、"新たな参照"を返すため、 Py_DECREF() することを忘れないように...。

C++アプリケーションからPythonの関数を呼び出す

ここのソースをちょこっと改造しただけ。

---- コード(Python側) testmodule.py ----

# -*- coding: utf-8 -*-

def testplus(i, j):
return i + j + 3

---- コード(C++側) ----

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

#define VARNAME(var) #var
// ---- exception ----
class PythonException
{
protected:
　const char* message_;
　const char* varName_;
public:
　static const char* errorMessge_ImportModule;
　static const char* errorMessage_GetObject;
　static const char* errorMessage_CallFunction;
　static const char* errorMessage_CreateTuple;
　PythonException(const char* message, const char* varName)
　　　 : message_(message), varName_(varName) {}
　virtual ~PythonException() throw() {}
　virtual std::string what() const throw() {
　　std::stringstream ss;
　　ss << message_ << " (" << varName_ << ")";
　　return ss.str();
　}
};
const char* PythonException::errorMessge_ImportModule
　= "Module import error.";
const char* PythonException::errorMessage_GetObject
　= "Get object error.";
const char* PythonException::errorMessage_CallFunction
　= "Call function error.";
const char* PythonException::errorMessage_CreateTuple
　= "Create tuple error.";

// ---- main ----
int main(int argc, char *argv[])
{
　const char* moduleName = "testmodule";
　const char* funcName = "testplus";
　Py_Initialize();

　PyObject* pyModule = NULL;
　PyObject* pyFunc = NULL;
　PyObject* pyArgs = NULL;
　PyObject* pyArg1 = NULL;
　PyObject* pyArg2 = NULL;
　PyObject* pyResult = NULL;
　try {
　　PyObject* pyModuleName = PyString_FromString(moduleName);
　　pyModule = PyImport_Import(pyModuleName);
　　Py_DECREF(pyModuleName);
　　// module呼び出し失敗時に NULL が返る
　　if (NULL == pyModule) {
　　　throw PythonException(
　　　　PythonException::errorMessge_ImportModule,
　　　　VARNAME(pyModule));
　　}
　　// 以下、二つは、"借りた参照"
　　PyObject* pyDict = PyModule_GetDict(pyModule);
　　pyFunc = PyDict_GetItemString(pyDict, funcName);

　　// PyObject_GetAttrString()の場合、
　　// "新たな参照"のため、DECREFしないといけない
　　//PyObject* pyFunc = PyObject_GetAttrString(pyModule, funcName);

　　// 取得失敗時に NULL が返る(PyModule_GetDict()は失敗しない)
　　if (NULL == pyFunc) {
　　　throw PythonException(
　　　　PythonException::errorMessage_GetObject,
　　　　VARNAME(pyFunc));
　　}
　　// 呼び出し不可オブジェクトの場合、0 が返る
　　if (0 == PyCallable_Check(pyFunc)) {
　　　throw PythonException(
　　　　PythonException::errorMessage_CallFunction,
　　　　VARNAME(pyFunc));
　　}

　　// 以下、失敗時には NULL が返る
　　pyArgs = PyTuple_New(2);
　　if (NULL == pyArgs) {
　　　throw PythonException(
　　　　PythonException::errorMessage_CreateTuple,
　　　　VARNAME(pyArgs));
　　}
　　PyObject* pyArg1 = PyInt_FromLong(2);
　　if (NULL == pyArg1) {
　　　throw PythonException(
　　　　PythonException::errorMessage_GetObject,
　　　　VARNAME(pyArg1));
　　}
　　PyTuple_SetItem(pyArgs, 0, pyArg1);
　　PyObject* pyArg2 = PyInt_FromLong(5);
　　if (NULL == pyArg2) {
　　　throw PythonException(
　　　　PythonException::errorMessage_GetObject,
　　　　VARNAME(pyArg2));
　　}
　　PyTuple_SetItem(pyArgs, 1, pyArg2);
　　pyResult = PyObject_CallObject(pyFunc, pyArgs);
　　if (NULL == pyResult) {
　　　throw PythonException(
　　　　PythonException::errorMessage_GetObject,
　　　　VARNAME(pyResult));
　　}
　　std::cout << "Result: "
　　　<< PyInt_AsLong(pyResult) << std::endl;
　} catch (const PythonException& pyEx) {
　　if (PyErr_Occurred()) {
　　　PyErr_Print();
　　}
　　std::cout << pyEx.what() << std::endl;
　}
　Py_XDECREF(pyResult);
　Py_XDECREF(pyArg2);
　Py_XDECREF(pyArg1);
　Py_XDECREF(pyArgs);
　//Py_XDECREF(pyFunc); // PyObject_GetAttrString()の場合
　Py_XDECREF(pyModule);

　Py_Finalize();
　return 0;
}

// End of file

コードは、ほぼ真似なので...(^^; 気をつけなければいけないことは、参照カウンタの操作です。 Python/C API関数を使用した際、戻り値の PyObject* が"新たな参照" の場合、 Py_DECREF() し、"借りた参照" の場合は、Py_DECREF()してはいけません。 これらについては、Python/C API リファレンスマニュアルで、それぞれの関数の戻り値を調べれば、わかるかと思います。

上記の例では、モジュールから、関数を取得する場合に、PyModule_GetDict()と、PyDict_GetItemString()を使用しています。
この二つは、"借りた参照"を返すため、戻り値の PyObject* を Py_DECREF() していません。
しかし、PyObject_GetAttrString() でも関数を取得できますが、こちらは、"新たな参照"を返すため、Py_DECREF() をします。そうしないと、メモリにごみが残ります。
参照カウンタの詳しい説明は、以下などを見ればよいかと思います。
GCアルゴリズム詳細解説
Py_DECREF() には、以下の2種類があります。
Py_DECREF() は、参照カウンタを1デクリメントします。
Py_XDECREF() は、NULLオブジェクトの場合、Py_DECREF()しません。NULLかどうかわからない場合は、こちらを使用したほうがよいでしょう。

Python setattr()でクラス内の関数を設定する

setattr()を使用することで、属性の設定ができるので、それを利用して、クラス内の関数の変更方法などを調べてみました。

---- コード ----

# -*- coding: utf-8 -*-

class Calc:
　　data = 10
　　def run(self, a, b):
　　　　return a + b

def minus(a, b):
　　return a - b

def plus(self, a, b):
　　return a + b + self.data

def main():
　　calc = Calc()
　　print calc.run(1, 2)　　　　# 3　を出力

　　calc_minus = Calc()
　　setattr(calc_minus, "run", minus)

　　print calc.run(1, 2)　　　　# 3　を出力
　　print calc_minus.run(1, 2)　# -1 を出力

　　setattr(Calc, "run", plus)
　　calc_plus = Calc()
　　print calc.run(1, 2)　　　　# 13 を出力
　　print calc_minus.run(1, 2)　# -1 を出力
　　print calc_plus.run(1, 2)　 # 13 を出力

if __name__ == "__main__":
　　main()

================================

コードの例の calc_minus のように setattr(インスタンス, "属性名", 関数) とすることによって、関数をインスタンスに設定することは可能だが、その関数では、メンバ(属性)を利用することができない。
calc_plus のように、setattr(クラスオブジェクト, "属性名", 関数) とすることによって、メンバ(属性)を関数で使用することができる。

なお、関数のアドレスは、
　print calc.run
　print Calc.run
で確認することが可能です。

pythonでプロパティ

pythonでプロパティを使用する例。

---- コード ----

# -*- coding: utf-8 -*-

class Coordinate:
　　_coord = [0.0, 0.0, 0.0] # x, y, z

　　def __init__(self, x = 0.0, y = 0.0, z = 0.0):
　　　　self._coord[0], self._coord[1], self._coord[2] = x, y, z

　　def getx(self):
　　　　return self._coord[0]
　　def setx(self, value):
　　　　self._coord[0] = value
　　x = property(getx, setx)
　　def gety(self):
　　　　return self._coord[1]
　　def sety(self, value):
　　　　self._coord[1] = value
　　y = property(gety, sety)
　　def getz(self):
　　　　return self._coord[2]
　　def setz(self, value):
　　　　self._coord[2] = value
　　z = property(getz, setz)

coord = Coordinate(11.2, 12.3)
coord.x = 15.0
coord.y = 12.8

if __name__ == "__main__":
　　print coord.x, coord.y, coord.z

# end of file