29.4 `modulefinder` -- スクリプト中で使われているモジュールを検索する

バージョン 2.3 で新たに追加された仕様です。

このモジュールでは、スクリプト中で import されているモジュールセットを調べるために使える ModuleFinder クラスを提供しています。 modulefinder.py はまた、Python スクリプトのファイル名を引数に指定してスクリプトとして実行し、 import されているモジュールのレポートを出力させることもできます。

AddPackagePath( pkg_name, path): pkg_name という名前のパッケージの在り処がpath であることを記録します。

ReplacePackage( oldname, newname): 実際にはパッケージ内でoldname という名前になっているモジュールを newname という名前で指定できるようにします。この関数の主な用途は、_xmlplus パッケージが xml パッケージに置き換わっている場合の処理でしょう。

クラス ModuleFinder( [path=None, debug=0, excludes=[], replace_paths=[]]): このクラスではrun_script() およびreport() メソッドを提供しています。これらのメソッドは何らかのスクリプト中で import されているモジュールの集合を調べます。 path はモジュールを検索する先のディレクトリ名からなるリストです。 path を指定しない場合、sys.path を使います。 debug にはデバッグレベルを設定します; 値を大きくすると、実行している内容を表すデバッグメッセージを出力します。 excludes は検索から除外するモジュール名です。 replace_paths には、モジュールパス内で置き換えられるパスをタプル(oldpath, newpath) からなるリストで指定します。

report( ): スクリプトで import しているモジュールと、そのパスからなるリストを列挙したレポートを標準出力に出力します。モジュールを見つけられなかったり、モジュールがないように見える場合にも報告します。

run_script( pathname): pathname に指定したファイルの内容を解析します。ファイルには Python コードが入っていなければなりません。

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