46 新しいDistutilsコマンドの作成

このセクションではDistutilsの新しいコマンドを作成する手順の概要をしめします。

新しいコマンドは distutils.command パッケージ中のモジュールに作られます。command_template というディレクトリにサンプルのテンプレートがあります。このファイルを実装しようとしているコマンドと同名の新しいモジュールにコピーしてください。このモジュールはモジュール(とコマンド)と同じ名前のクラスを実装する必要があります。そのため、peel_bananaコマンド(ユーザは "setup.py peel_banana"と実行できます)を実装する際には、 command_templateを distutils/command/peel_banana.pyにコピーし、distutils.cmd.Commandのサブクラス peel_banana クラスを実装するように編集してください。

Commandのサブクラスは以下のメソッドを実装する必要があります。

initialize_options( ): このコマンドがサポートする全てのオプションのデフォルト値を設定します。これらのデフォルトは他のコマンドやセットアップスクリプト、設定ファイル、コマンドラインによって上書きされるかもしれません。そのためオプション間の依存関係を記述するには適切な場所ではありません。一般的にinitialize_options()は単に"self.foo = None" のような定義だけを行います。

finalize_options( ): このコマンドがサポートする全てのオプションの最終的な値を設定します。これは可能な限り遅く呼び出されます。つまりコマンドラインや他のコマンドによるオプションの代入のあとに呼び出されます。そのため、オプション間の依存関係を記述するのに適した場所です。もし foo が bar に依存しており、かつまだfooが initialize_options()で定義された値のままなら、 foo をbarから代入しても安全です。

run( ): コマンドの本体です。実行するべきアクションを実装しています。 initialize_options() で初期化され、他のコマンドされ、セットアップスクリプト、コマンドライン、設定ファイルでカスタマイズされ、finalize_options()で設定されたオプションがアクションを制御します。端末への出力とファイルシステムとのやりとりは全てrun()が行います。

sub_commandsはコマンドの``ファミリー''を定式化したものです。たとえば install はサブコマンド install_lib、install_headersなどの親です。コマンドファミリーの親は sub_commandsをクラス属性として持ちます。 2要素のタプル"(command_name, predicate)"のリストで、 command_nameには文字列、predicateには親コマンドのメソッドで、現在の状況がコマンド実行にふさわしいかどうか判断するものを指定します。 (例えば install_headers はインストールするべき Cヘッダファイルがある時だけ有効です。) もし predicate が None なら、そのコマンドは常に有効になります。

sub_commands は通常クラスの最後で定義されます。これはpredicate は boundされていないメソッドになるので、全て先に定義されている必要があるためです。

標準的な例はinstall コマンドです。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。