"modulefinder" --- Find modules used by a script
************************************************

**ソースコード:** Lib/modulefinder.py

======================================================================

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

modulefinder.AddPackagePath(pkg_name, path)

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

modulefinder.ReplacePackage(oldname, newname)

   実際にはパッケージ内で *oldname* という名前になっているモジュールを
   *newname* という名前で指定できるようにします。

class modulefinder.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 コードが入っていなければなりません。

   modules

      モジュール名をモジュールに結びつける辞書。 ModuleFinder の使用例
      を参照して下さい。


"ModuleFinder" の使用例
=======================

解析対象のスクリプトはこれ (bacon.py) です:

   import re, itertools

   try:
       import baconhameggs
   except ImportError:
       pass

   try:
       import guido.python.ham
   except ImportError:
       pass

bacon.py のレポートを出力するスクリプトです:

   from modulefinder import ModuleFinder

   finder = ModuleFinder()
   finder.run_script('bacon.py')

   print('Loaded modules:')
   for name, mod in finder.modules.items():
       print('%s: ' % name, end='')
       print(','.join(list(mod.globalnames.keys())[:3]))

   print('-'*50)
   print('Modules not imported:')
   print('\n'.join(finder.badmodules.keys()))

出力例です (アーキテクチャに依って違ってくるかもしれません):

   Loaded modules:
   _types:
   copyreg:  _inverted_registry,_slotnames,__all__
   re._compiler:  isstring,_sre,_optimize_unicode
   _sre:
   re._constants:  REPEAT_ONE,makedict,AT_END_LINE
   sys:
   re:  __module__,finditer,_expand
   itertools:
   __main__:  re,itertools,baconhameggs
   re._parser:  _PATTERNENDERS,SRE_FLAG_UNICODE
   array:
   types:  __module__,IntType,TypeType
   ---------------------------------------------------
   Modules not imported:
   guido.python.ham
   baconhameggs
