Cython を使ってみる
1. エグゼクティブサマリー
Cython は,Python コードを C 言語に変換・コンパイルし,Python の拡張モジュールを生成する仕組みである。本記事では,Cython の導入からビルド・動作確認までの手順を扱う。.pyx ファイルに Python コードを記述し,setup.py によるビルドまたは cythonize コマンドによる直接ビルドで,共有ライブラリファイル(Windows では .pyd)を生成する。
2. 前準備(必要ソフトウェアの入手)
ここでは、最低限の事前準備について説明する。機械学習や深層学習を行う場合は、NVIDIA CUDA、Visual Studio、Cursorなどを追加でインストールすると便利である。これらについては別ページ https://www.kkaneko.jp/cc/dev/aiassist.htmlで詳しく解説しているので、必要に応じて参照してください。
Python 3.12 のインストール(Windows 上) [クリックして展開]
以下のいずれかの方法で Python 3.12 をインストールする。Python がインストール済みの場合、この手順は不要である。
方法1:winget によるインストール
管理者権限のコマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。
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"
--scope machine を指定することで、システム全体(全ユーザー向け)にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動すると PATH が自動的に設定される。
方法2:インストーラーによるインストール
- Python 公式サイト(https://www.python.org/downloads/)にアクセスし、「Download Python 3.x.x」ボタンから Windows 用インストーラーをダウンロードする。
- ダウンロードしたインストーラーを実行する。
- 初期画面の下部に表示される「Add python.exe to PATH」に必ずチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから
pythonコマンドを実行できない。 - 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。
インストールの確認
コマンドプロンプトで以下を実行する。
python --version
バージョン番号(例:Python 3.12.x)が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。
AIエディタ Windsurf のインストール(Windows 上) [クリックして展開]
Pythonプログラムの編集・実行には、AIエディタの利用を推奨する。ここでは、Windsurfのインストールを説明する。Windsurf がインストール済みの場合、この手順は不要である。
管理者権限のコマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。
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"
--scope machine を指定することで、システム全体(全ユーザー向け)にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動すると PATH が自動的に設定される。
【関連する外部ページ】
Windsurf の公式ページ: https://windsurf.com/
必要なライブラリのインストール [クリックして展開]
管理者権限のコマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。
python -m pip install cython setuptools
3. 実行のための準備とその確認手順(Windows 前提)
3.1 プログラムファイルの準備
第5章のソースコードをテキストエディタ(メモ帳,Windsurf 等)で以下の2ファイルとして保存する(文字コード:UTF-8)。両ファイルは同一ディレクトリに配置する。
helloworld.pyx— Cython ソースファイルsetup.py— ビルド設定ファイル
3.2 実行コマンド
コマンドプロンプトでファイルの保存先ディレクトリに移動し,以下のいずれかを実行する。
方法1:setup.py を使用したビルド
python setup.py build_ext --inplace
方法2:cythonize コマンドによるビルド
setup.py を使わず,以下のコマンドで .pyx ファイルのコンパイルからリンクまでを一括実行できる。
cythonize -i helloworld.pyx
動作確認
ビルドが成功すると,カレントディレクトリに共有ライブラリファイル(Windows では helloworld.pyd,Linux/macOS では helloworld.so)が生成される。以下のコマンドで動作を確認する。
python -c "import helloworld"
「Hello World」と表示されれば成功である。
3.3 動作確認チェックリスト
| 確認項目 | 期待される結果 |
|---|---|
python setup.py build_ext --inplace の実行 | エラーなく完了し,helloworld.pyd(Windows)または helloworld.so(Linux/macOS)が生成される |
cythonize -i helloworld.pyx の実行 | エラーなく完了し,共有ライブラリファイルが生成される |
python -c "import helloworld" の実行 | 「Hello World」と表示される |
4. 概要・使い方・実行上の注意
Cython を使うには,まず .pyx ファイルに Python コードを記述する。次に setup.py を作成し,python setup.py build_ext --inplace を実行すると,C 言語へのコンパイルと共有ライブラリの生成が行われる。生成された共有ライブラリは,通常の Python モジュールと同様に import で読み込める。
setup.py では setuptools と Cython.Build.cythonize を使用する。cythonize 関数に .pyx ファイルのパスを渡すことで,ビルド設定が行われる。
setup.py を使わず cythonize -i helloworld.pyx で直接ビルドする方法もある。
ソースコードは第5章に掲載する。
5. ソースコード
helloworld.pyx
print("Hello World")
setup.py
from setuptools import setup
from Cython.Build import cythonize
setup(
ext_modules=cythonize("helloworld.pyx")
)
6. まとめ
Cython の役割
Cython は Python コードを C 言語に変換・コンパイルし,Python の拡張モジュールを生成する仕組みである。
.pyx ファイル
.pyx ファイルは Cython のソースファイルであり,ビルド対象となる Python コードを記述する。
setup.py によるビルド
setuptools と Cython.Build.cythonize を用いた setup.py を作成し,python setup.py build_ext --inplace を実行すると,共有ライブラリファイル(Windows では .pyd,Linux/macOS では .so)が生成される。
cythonize コマンドによるビルド
cythonize -i helloworld.pyx で,setup.py を使わずにビルドを一括実行できる。
動作確認
生成された共有ライブラリは import helloworld で読み込める。「Hello World」と表示されれば成功である。