C言語で書いたメソッドを既存のPythonクラスに追加する方法

C拡張モジュールから新しいPythonクラスを定義する手法を紹介します。クラスの各メソッドはC言語で実装されますが、出来上がったクラスは通常のPythonクラスと同じように、インスタンス化・サブクラス化・さらに拡張することも自由に行えます。

さらに、この手法に継承を組み合わせれば、C言語で書いたメソッドを使って既存のPythonクラスを拡張することも可能になります。

PyClass_Newの第一引数が鍵

このテクニックのポイントは、PyClass_New() の第一引数の扱いです。ここに NULL を渡すと、「新しいクラスには基底クラスが存在しない」ことを示します。逆に、この引数に基底クラスのタプルを渡すようにすれば、新しく定義するクラスがPythonのソースコードではなくC拡張モジュールの中で構築されている場合であっても、通常のPythonと同じ継承の振る舞いを実現できます。

サンプルコード

以下は、C拡張モジュール内で「Foo」という名前のクラスを生成し、__init__ と doSomething の2つのメソッドを追加する例です。

#include <Python.h>

static PyObject* Foo_init(PyObject *self, PyObject *args)
{
    printf("Foo.__init__ called\n");
    Py_INCREF(Py_None);
    return Py_None;
}

static PyObject* Foo_doSomething(PyObject *self, PyObject *args)
{
    printf("Foo.doSomething called\n");
    Py_INCREF(Py_None);
    return Py_None;
}

static PyMethodDef FooMethods[] =
{
    {"__init__", Foo_init, METH_VARARGS, "doc string"},
    {"doSomething", Foo_doSomething, METH_VARARGS, "doc string"},
    {0, 0},
};

static PyMethodDef ModuleMethods[] = { {0, 0} };

#ifdef __cplusplus
extern "C"
#endif
void initFoo(void)
{
    PyMethodDef *def;

    /* モジュールオブジェクトとクラスオブジェクトを作成 */
    PyObject *module = Py_InitModule("Foo", ModuleMethods);
    PyObject *moduleDict = PyModule_GetDict(module);
    PyObject *classDict = PyDict_New();
    PyObject *className = PyString_FromString("Foo");
    PyObject *fooClass = PyClass_New(NULL, classDict, className);

    PyDict_SetItemString(moduleDict, "Foo", fooClass);
    Py_DECREF(classDict);
    Py_DECREF(className);
    Py_DECREF(fooClass);

    /* クラスにメソッドを追加 */
    for (def = FooMethods; def->ml_name != NULL; def++) {
        PyObject *func = PyCFunction_New(def, NULL);
        PyObject *method = PyMethod_New(func, NULL, fooClass);
        PyDict_SetItemString(classDict, def->ml_name, method);
        Py_DECREF(func);
        Py_DECREF(method);
    }
}

補足：Python 3での扱いについて

このサンプルで使用している PyClass_New、Py_InitModule、PyString_FromString などのAPIは、Python 2系で利用されていた旧式のC APIです。Python 3以降では、C拡張でクラス（型）を定義する際に PyType_FromSpec や静的な PyTypeObject 構造体を使うのが標準的な方法となっています。現行バージョンで同様の処理を実装する場合は、これらの新しいAPIへの読み替えが必要になる点にご注意ください。