18.7 `pyclbr` -- Python クラスブラウザーサポート

このpyclbrはモジュールで定義されたクラス、メソッド、およびトップレベルの関数について、限られた量の情報を定義するのに使われます。このクラスによって提供される情報は、伝統的な 3 ペイン形式のクラスブラウザーを実装するのに十分なだけの量になります。情報はモジュールのインポートによらず、ソースコードから抽出します。このため、このモジュールは信用できないソースコードに対して利用しても安全です。この制限から、多くの標準モジュールやオプションの拡張モジュールを含む、Python で実装されていないモジュールに対して利用することはできません。

readmodule( module[, path]): モジュールを読み込み、辞書マッピングクラスを返し、クラス記述オブジェクトに名前をつけます。パラメタmoduleはモジュール名を表す文字列でなくてはなりません; パッケージ内のモジュール名でもかまいません。 path パラメタはシーケンス型でなくてはならず、モジュールのソースコードがある場所を特定する際に sys.path の値に補完する形で使われます。

readmodule_ex( module[, path]): readmodule() に似ていますが、返される辞書は、クラス名からクラス記述オブジェクトへの対応付けに加えて、トップレベル関数から関数記述オブジェクトへの対応付けも行っています。さらに、読み出し対象のモジュールがパッケージの場合、返される辞書はキー '__path__' を持ち、その値はパッケージの検索パスが入ったリストになります。

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