Python で SWIG を使ってみる

1. エグゼクティブサマリー

https://www.swig.org/Doc4.3/Python.html#Python_nn6 に記載のサンプルプログラムを用いて，SWIG の基本的な使い方を確認する．C 言語で実装した階乗関数 fact および最大公約数関数 gcd に対して SWIG インターフェースファイルを作成し，setuptools で Python 拡張モジュールをビルドし，Python から C 関数を呼び出す一連の手順を示す．

2. 前準備（必要ソフトウェアの入手）

ここでは、最低限の事前準備について説明する。機械学習や深層学習を行う場合は、NVIDIA CUDA、Visual Studio、Cursorなどを追加でインストールすると便利である。これらについては別ページ https://www.kkaneko.jp/cc/dev/aiassist.htmlで詳しく解説しているので、必要に応じて参照してください。

winget install --scope machine --id Python.Python.3.12 -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_pip=1 Include_test=0 Include_launcher=1 InstallLauncherAllUsers=1"

python --version

winget install --scope machine --id Codeium.Windsurf -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --custom "/SP- /SUPPRESSMSGBOXES /NORESTART /CLOSEAPPLICATIONS /DIR=""C:\Program Files\Windsurf"" /MERGETASKS=!runcode,addtopath,associatewithfiles,!desktopicon"
powershell -Command "$env:Path=[System.Environment]::GetEnvironmentVariable('Path','Machine')+';'+[System.Environment]::GetEnvironmentVariable('Path','User'); windsurf --install-extension MS-CEINTL.vscode-language-pack-ja --force; windsurf --install-extension ms-python.python --force; windsurf --install-extension Codeium.windsurfPyright --force"

pip install -U setuptools

3. 実行のための準備とその確認手順（Windows 前提）

3.1 プログラムファイルの準備

第5章に掲載する4つのソースコードをテキストエディタ（メモ帳，Windsurf 等）にそれぞれ貼り付け，以下のファイル名で同一ディレクトリに保存する（文字コード：UTF-8）．

• example.i（SWIG インターフェースファイル）
• example.c（C 言語ソースファイル）
• example.h（C 言語ヘッダファイル）
• setup.py（ビルド設定ファイル）

3.2 実行コマンド

コマンドプロンプトでファイルの保存先ディレクトリに移動し，以下を順に実行する．

swig -python example.i
python setup.py build_ext --inplace

ビルド完了後，Python を起動してモジュールの動作を確認する．

python

Python の対話モードで以下を入力する．

import example
print(example.fact(4))
print(example.gcd(12, 8))

3.3 動作確認チェックリスト

4. 概要・使い方・実行上の注意

本記事では，SWIG 公式ドキュメントのサンプルプログラムを用いる．各ファイルの役割は以下のとおりである．

• example.i：SWIG インターフェースファイル．%module example でモジュール名を指定し，Python に公開する C 関数（fact，gcd）を宣言する．
• example.c：C 言語ソースファイル．階乗を計算する fact 関数と，ユークリッドの互除法で最大公約数を計算する gcd 関数を実装している．
• example.h：C 言語ヘッダファイル．fact 関数と gcd 関数のプロトタイプ宣言を記載している．
• setup.py：setuptools によるビルド設定ファイル．Extension で拡張モジュール _example を定義し，example_wrap.c と example.c をソースファイルに指定する．

ビルドは2段階で行う．まず swig -python example.i で，SWIG がラッパーコード example_wrap.c と Python モジュールファイル example.py を生成する．次に python setup.py build_ext --inplace で，setuptools が C コンパイラを呼び出して共有ライブラリをビルドし，カレントディレクトリに配置する．

ビルド完了後，Python から import example を実行すると，C 関数を Python 関数として呼び出せる．ソースコードは第5章に掲載する．

5. ソースコード

example.i（SWIG インターフェースファイル）

%module example

%{
#include "example.h"
%}

int fact(int n);
int gcd(int x, int y);

example.c（C 言語ソースファイル）

#include "example.h"

int fact(int n) {
    if (n == 0) return 1;
    return n * fact(n - 1);
}

int gcd(int x, int y) {
    if (y == 0) return x;
    return gcd(y, x % y);
}

example.h（C 言語ヘッダファイル）

int fact(int n);
int gcd(int x, int y);

setup.py（ビルド設定ファイル）

from setuptools import setup, Extension

example_module = Extension('_example', sources=['example_wrap.c', 'example.c'])

setup(name='example',
      version='0.1',
      ext_modules=[example_module],
      py_modules=['example'])

Python 実行例

import example
print(example.fact(4))
print(example.gcd(12, 8))

6. まとめ

SWIG インターフェースファイル

SWIG インターフェースファイル（.i）で %module によりモジュール名を指定し，Python に公開する C 関数を宣言する．このファイルがラッパーコード生成の起点となる．

C 関数の Python からの呼び出し

C 言語で実装した fact 関数や gcd 関数を，import example のあとに example.fact(4) のように Python 関数として呼び出せる．

setuptools によるビルド

setup.py で setuptools の Extension を用いて拡張モジュールを定義し，python setup.py build_ext --inplace で共有ライブラリをビルドする．

2段階のビルド手順

swig -python example.i でラッパーコードと Python モジュールファイルを生成し，python setup.py build_ext --inplace で共有ライブラリをビルドする．この2段階の操作で Python から C 関数を利用可能になる．