[Python/C API] Cで作ったポインタ変数が引数にある関数をPythonで呼び出し使用したい。

Question

やりたいこと・知りたい事

やりたいこと

• 表題にある通り、Cで作ったポインタ引数のある関数をPythonで使用したい。

そのため、下記のような関数のラッパーファイルを作成するとき、どのように記載したら良いか知りたい。

• 下記の関数はポインタを使用しない方法でも実装できるが、後学のため、ポインタを関数の引数に置くことを条件としている。

void pointer_func(int n1,int n2,int *sum,int *diff){
    *sum = n1 + n2;
    *diff = (n1 > n2) ? n1 -n2 : n2 - n1;    
}

作成したラッパーファイル・呼び出し

作成したラッパーファイル

#include "/usr/~~~/python3.8/Python.h"
 
extern void pointer_func(int n1,int n2,int *sum,int *diff);
PyObject* f_pointer_func(PyObject* self, PyObject* args){
	
    int n1,n2;
	int* sum;
	int* diff;

    //変数 int* sum,int* diff に使用できる "" がわからない
	if (!PyArg_ParseTuple(args, "iiii" ,&n1,&n2,&sum,&diff)){
		return NULL;
	}

	pointer_func(n1,n2,sum,diff);
	return Py_BuildValue("");
}


static PyMethodDef methods[] = {
    {"pointer_func", f_pointer_func, METH_VARARGS, "pointer_ch" },
	{NULL}
};

static struct PyModuleDef pointer_check =
{
	PyModuleDef_HEAD_INIT,
	"pointer_check",
	"",
	-1,
	methods
};

PyMODINIT_FUNC PyInit_pointer_check(void)
{
	return PyModule_Create(&pointer_check);
}

呼び出し
コンパイルした後、下記のようなファイルを作成し、import と呼び出しをした。

import pointer_check as ptc
wa = 0
sa = 0
ptc.pointer_func(10,20,wa,sa);

###エラーメッセージ

segmentation fault (core dumped)

調べたこと・試してること

リファレンスの PyArg_ParseTuple() の項目を参照してもポインタ引数を扱うものが見当たらないため質問しました。

別途で
PyCapsule_New がポインタを格納できると記載されていたので、下記の参考資料のURLを見ながら引数単体で使用できないか調べています。

補足情報・参考資料

Python/C API リファレンスマニュアル
PyArg_ParseTuple
https://docs.python.org/ja/3/c-api/arg.html?highlight=pyarg_parsetuple#c.PyArg_ParseTuple
カプセル
https://docs.python.org/ja/3/c-api/capsule.html
PythonのC/C++拡張パターン - ポインタ
https://qiita.com/junkoda/items/2b1eda7569186809ca14

Answer 1

まず最初に、Pythonはctypesモジュールを使用しなければ、C言語のポインタを扱えません。

妥当な回答

一番妥当なのは、結果は戻り値として返すやり方です。

PyObject * test01(PyObject *self, PyObject *args)
{
	int n1, n2;
	int sum, diff;

	if (!PyArg_ParseTuple(args, "ii", &n1, &n2)) {
		return NULL;
	}
	pointer_func(n1, n2, &sum, &diff);
	return Py_BuildValue("ii", sum, diff);
}

>>> import hoge
>>> hoge.test01(2, 3)
(5, 1)

GTK+(C言語のGUIフレームワーク)を例に挙げます。
gtk_tree_selection_get_selectedという関数があります。

• GtkTreeSelection: GTK+ 3 Reference Manual

どういう関数かの説明は省きますが、第2・3引数は値を受け取るためにポインタになっています。

GTK+をバインディングしたPythonのライブラリはどのような仕様になっているかというと、以下のようになっています。

• Gtk.TreeSelection - Gtk 3.0

このように、C言語の関数での第2・3引数で受け取る値は、戻り値として返すようになっています。

ちょっと遊んだ回答

「ctypesモジュールを使わなければ」ポインタは扱えませんが、じゃctypesモジュールを使えばいいんですよ。

/*
 *	import ctypes
 *	addr = ctypes.addressof(obj)
 *
 *	相当の処理をする。
 */
int * query_address(PyObject *obj)
{
	static PyObject *ctypes_module = NULL;
	PyObject *result_obj;
	unsigned long address;

	if (ctypes_module == NULL) {
		ctypes_module = PyImport_ImportModule("ctypes");
		if (ctypes_module == NULL) {
			return NULL;
		}
	}
	result_obj = PyObject_CallMethod(ctypes_module, "addressof", "O", obj);
	if (result_obj == NULL) {
		return NULL;
	}
	address = PyLong_AsUnsignedLong(result_obj);
	Py_DECREF(result_obj);
	return (PyErr_Occurred() == NULL? (int *)address: NULL);
}

PyObject * test02(PyObject *self, PyObject *args)
{
	int n1, n2;
	PyObject *sum_obj, *diff_obj;
	int *sum_ptr, *diff_ptr;

	if (!PyArg_ParseTuple(args, "iiOO", &n1, &n2, &sum_obj, &diff_obj)) {
		return NULL;
	}
	sum_ptr = query_address(sum_obj);
	if (sum_ptr == NULL) {
		return NULL;
	}
	diff_ptr = query_address(diff_obj);
	if (diff_ptr == NULL) {
		return NULL;
	}
	pointer_func(n1, n2, sum_ptr, diff_ptr);
	Py_RETURN_NONE;
}

>>> import hoge
>>> import ctypes
>>> s = ctypes.c_int()
>>> d = ctypes.c_int()
>>> hoge.test02(2, 3, s, d)
>>> print(s.value, d.value)
5 1

ただし、わざわざctypesモジュールを使ってまでやることかは、疑問に思います。
前述の方法のほうがよりスマートでしょう。

---

PyCapsuleAPIは使ったことがありませんが、ここを読む限り、拡張モジュール同士でのデータのやり取りに使用するためのものであって、目的にあったものではないと思います。

Python はある拡張モジュールの C レベルの情報 (ポインタ) を別のモジュールに渡すための特殊な機構: Capsule (カプセル)を提供しています。 Capsule はポインタ (void *) を記憶する Python のデータ型です。 Capsule は C API を介してのみ生成したりアクセスしたりできますが、他の Python オブジェクトと同じように受け渡しできます。

---

質問とは関係ありませんが、ちょっと気になった点です。

    return Py_BuildValue("");

おそらく特に戻り値を必要としないためにこのような書き方をしていると思いますが、Pythonではそのような場合にはNoneを返すことを慣例としています。
更に、その慣例を手っ取り早く書くためにPy_RETURN_NONEというマクロが用意されています。

    //return Py_BuildValue("");
    Py_RETURN_NONE;

Comments

[toriaezu_NAMA]

知りたかった以上の事まで教えて頂き大変勉強になりました。
ありがとうございました。
現状、回答に対して質問内容が見当たりませんので、BAにさせて頂きます。