setuptoolsを使ったpluginサンプル¶
Pythonでplugin的な仕組みを作るとしたら__import__やimpを使う方法が ありますが、今の流れ的にはsetuptools対応して簡単にパッケージング や配布、PyPIでの公開、buildoutへの対応など行うことも視野に入れて いきたいところです。
と言ってもやらないと行けないことは少ないので、__import__の使い方 を調べて試行錯誤するよりも簡単かもしれません。
前準備¶
Python環境にsetuptoolsをインストールしておきます。
OSの構成管理ツール(apt,yum,portsなど)でインストールしておいても可。 あるいはvirtualenvを使っても可です。
インストール出来ていれば easy_install コマンドが使えるように なっているはずです。
次に plugins.zip を展開します:
plugins/
+-- README.txt
+---p1/
| +-- foo_plugin.py
| +-- setup.py
|
+---p2/
| +-- bar_plugin.py
| +-- setup.py
|
+---server/
+-- server.py
pluginの無い状態での実行¶
'server' フォルダで以下のように実行します。
pluginが無い状態のため、プラグイン呼び出し終了のメッセージのみ表示 されてプログラムが終了します。
pluginを追加¶
p1というフォルダに入っているpluginを環境に追加します。
今回は実験目的のため python setup.py develop でインストールして、あとで アンインストールしやすいようにしていますが python setup.py install としても同じように動作します。
serverを再実行¶
'server' フォルダに移動してもう一度以下のように実行します。
pluginをもう一つ追加して再実行¶
plugin2つめを追加。
serverを実行。
pluginの仕組み¶
p1/setup.py のコードはsetuptoolsで拡張されたdistutilsのsetup関数です。
setup(
name="foo_plugin",
py_modules=['foo_plugin'],
entry_points="""
[plugin_example]
plugin_name1 = foo_plugin:func
""",
)
ここでentry_pointsに記載している 'plugin_example' というのがポイントで、 このように書いておくと別のプログラムから以下のようにして関数を取り出す 事ができるようになります。
import pkg_resources
for plugin in pkg_resources.iter_entry_points('plugin_example'):
...
後始末¶
今回実験用にインストールしたプラグインパッケージをアンインストール しておきましょう。
まとめ¶
ここで説明した方法ではpluginを使えるようにするためには python setup.py install 等する必要があります。これはpluginをどこか(PyPI等)に公開しておけば easy_install コマンド一発でpluginを使えるようになる、ということになります。
しかし、場合によってはpluginフォルダにファイルを置くだけで動作するようにしたい と考えるかも知れません。その方法は次のエントリで書きたいと思います。
- 参考文献:
- [Python] setuptools - SumiTomohikoの日記
