ctypes-初心者

私は、PythonライブラリにCライブラリを「ラッピング」するタスクを持っています。この件に関して、ドキュメントは非常にあいまいです。彼らは、上級のpythonユーザーだけがctypesを実装することを期待しているようです。まあ私はpythonの初心者であり、助けが必要です。

一歩一歩手助けが素晴らしいでしょう。

だから私は私のcライブラリを持っています。私は何をしますか？どのファイルをどこに置きますか？ライブラリをインポートするにはどうすればよいですか？Pythonに「自動ラップ」する方法があるかもしれないと読んだことがありますか？

（ちなみに、私はpython.netでctypesチュートリアルを実行しましたが、機能しません。つまり、残りの手順を実行できるはずだと彼らが思っているのです。

実際、これは私が彼らのコードで得るエラーです：

File "importtest.py", line 1
   >>> from ctypes import *
   SyntaxError: invalid syntax

私は本当にこれについていくつかの段階的なヘルプを使うことができました！ありがとう〜

これは、素早くて汚いctypesチュートリアルです。

まず、Cライブラリを記述します。次に、簡単なHello worldの例を示します。

testlib.c

#include <stdio.h>

void myprint(void);

void myprint()
{
    printf("hello world\n");
}

共有ライブラリとしてコンパイルします（ここでMacの修正を見つけます）：

$ gcc -shared -Wl,-soname,testlib -o testlib.so -fPIC testlib.c

# or... for Mac OS X 
$ gcc -shared -Wl,-install_name,testlib.so -o testlib.so -fPIC testlib.c

次に、ctypesを使用してラッパーを記述します。

testlibwrapper.py

import ctypes

testlib = ctypes.CDLL('/full/path/to/testlib.so')
testlib.myprint()

それを実行します：

$ python testlibwrapper.py

そして、あなたは出力を見るはずです

Hello world
$

すでにライブラリを念頭に置いている場合は、チュートリアルのPython以外の部分をスキップできます。ctypesがライブラリ/usr/libまたは別の標準ディレクトリにライブラリを配置できることを確認してください。これを行う場合、ラッパーを作成するときに完全なパスを指定する必要はありません。これを行わない場合は、を呼び出すときにライブラリの完全パスを指定する必要がありますctypes.CDLL()。

これはより包括的なチュートリアルの場所ではありませんが、このサイトで特定の問題についてヘルプを求める場合、コミュニティがあなたを助けると確信しています。

PS：Linuxを使用していると思いますctypes.CDLL('libc.so.6')。別のOSを使用している場合、状況は少し（またはかなり）変化する可能性があります。

Chinmay Kanchiの答えは素晴らしいですが、C ++コードに変数/配列を渡して返す関数の例が必要でした。他の人に役立つので、ここに含めておきます。

整数の受け渡し

整数を受け取り、戻り値に1を加える関数のC ++コード、

extern "C" int add_one(int i)
{
    return i+1;
}

ファイルとして保存されtest.cpp、必要な extern "C" に注意してください（これはCコードでは削除できます）。これはg ++を使用してコンパイルされており、Chinmay Kanchiの回答と同様の引数があります。

g++ -shared -o testlib.so -fPIC test.cpp

Pythonコードは、Pythonスクリプトと同じディレクトリにある共有ライブラリへのパスを想定して使用load_libraryしnumpy.ctypeslibます。

import numpy.ctypeslib as ctl
import ctypes

libname = 'testlib.so'
libdir = './'
lib=ctl.load_library(libname, libdir)

py_add_one = lib.add_one
py_add_one.argtypes = [ctypes.c_int]
value = 5
results = py_add_one(value)
print(results)

これは期待どおり6を印刷します。

配列の受け渡しと印刷

Cコードで配列の要素を出力するには、次のように配列を渡すこともできます。

extern "C" void print_array(double* array, int N)
{
    for (int i=0; i<N; i++) 
        cout << i << " " << array[i] << endl;
}

以前と同じようにコンパイルされ、同じ方法でインポートされます。この関数を使用するための追加のPythonコードは次のようになります。

import numpy as np

py_print_array = lib.print_array
py_print_array.argtypes = [ctl.ndpointer(np.float64, 
                                         flags='aligned, c_contiguous'), 
                           ctypes.c_int]
A = np.array([1.4,2.6,3.0], dtype=np.float64)
py_print_array(A, 3)

ここで、配列を指定します。最初の引数はprint_array、整列されたc_contiguous 64ビットfloatのNumpy配列へのポインターとして、2番目の引数は、Numpy配列の要素数をCコードに伝える整数として指定します。これは、Cコードによって次のように出力されます。

1.4
2.6
3.0

まず>>>、Pythonの例にあるコードは、それがPythonコードであることを示す方法です。Pythonコードを出力から分離するために使用されます。このような：

>>> 4+5
9

ここで、始まる行が>>>Pythonコードであり、9がその結果であることがわかります。これが、Pythonインタープリターを開始した場合の外観です。そのため、このようになっています。

>>>パーツを.pyファイルに入力することはありません。

これで構文エラーが処理されます。

次に、ctypesはPythonライブラリをラップするいくつかの方法の1つにすぎません。他の方法は SWIGです。これはPythonライブラリを調べ、C APIを公開するPython C拡張モジュールを生成します。もう1つの方法は、Cythonを使用することです。

それらにはすべて利点と欠点があります。

SWIGはC APIのみをPythonに公開します。つまり、オブジェクトも何も取得されず、それを行う別のPythonファイルを作成する必要があります。ただし、「wowza」と呼ばれるモジュールと、C APIのラッパーである「_wowza」と呼ばれるSWIGモジュールを使用することは一般的です。これは、物事を行うのに便利で簡単な方法です。

CythonはC-Extensionファイルを生成します。これには、作成するすべてのPythonコードがCで作成されるという利点があるため、作成するオブジェクトもCで作成されるため、パフォーマンスが向上します。しかし、Cとどのようにインターフェースするかを学ぶ必要があるので、Cの使い方を学ぶのは少し余分な作業です。

ctypesには、コンパイルするCコードがないという利点があるため、他の誰かが作成した標準ライブラリをラップするのに使用すると非常に便利で、WindowsおよびOS Xのバイナリバージョンにはすでに存在します。