25.1. pydoc —ドキュメントジェネレータとオンラインヘルプシステム—Pythonドキュメント

25.1。 pydoc —ドキュメントジェネレータとオンラインヘルプシステム

バージョン2.1の新機能。

ソースコード： ：source： `Lib / pydoc.py`

---

pydoc モジュールは、Pythonモジュールからドキュメントを自動的に生成します。 ドキュメントは、コンソールにテキストのページとして表示したり、Webブラウザーに提供したり、HTMLファイルに保存したりできます。

モジュール、クラス、関数、およびメソッドの場合、表示されるドキュメントはdocstringから派生しています（つまり、 オブジェクトの__doc__属性）、およびその文書化可能なメンバーの再帰的。 docstringがない場合、 pydoc は、ソースファイルのクラス、関数、またはメソッドの定義のすぐ上、またはモジュールの上部にあるコメント行のブロックから説明を取得しようとします（[を参照] X215X] inspect.getcomments（））。

組み込み関数 help（）は、インタラクティブインタプリタでオンラインヘルプシステムを呼び出します。このシステムは、 pydoc を使用して、ドキュメントをテキストとしてコンソールに生成します。 オペレーティングシステムのコマンドプロンプトで pydoc をスクリプトとして実行することにより、Pythonインタープリターの外部から同じテキストドキュメントを表示することもできます。 たとえば、実行中

pydoc sys

シェルプロンプトで、 sys モジュールに関するドキュメントが、Unix man コマンドで表示されるマニュアルページと同様のスタイルで表示されます。 pydoc の引数は、関数、モジュール、またはパッケージの名前、またはモジュールまたはパッケージ内のモジュール内のクラス、メソッド、または関数への点線の参照にすることができます。 pydoc への引数がパスのように見え（つまり、Unixのスラッシュなど、オペレーティングシステムのパス区切り文字が含まれている）、既存のPythonソースファイルを参照している場合、ドキュメントが作成されます。そのファイルのために。

ノート

オブジェクトとそのドキュメントを見つけるために、 pydoc はドキュメント化するモジュールをインポートします。 したがって、モジュールレベルのコードはその際に実行されます。 if __name__ == '__main__':ガードを使用して、ファイルがインポートされただけでなく、スクリプトとして呼び出された場合にのみコードを実行します。

pydoc は、出力をコンソールに出力するときに、読みやすくするために出力をページ分割しようとします。 PAGER環境変数が設定されている場合、 pydoc はその値をページ付けプログラムとして使用します。

引数の前に-wフラグを指定すると、コンソールにテキストを表示する代わりに、HTMLドキュメントが現在のディレクトリ内のファイルに書き出されます。

引数の前に-kフラグを指定すると、Unix man コマンドと同様の方法で、使用可能なすべてのモジュールの概要行で引数として指定されたキーワードが検索されます。 モジュールの概要行は、そのドキュメント文字列の最初の行です。

pydoc を使用して、Webブラウザにアクセスするためのドキュメントを提供するローカルマシンでHTTPサーバーを起動することもできます。 pydoc -p 1234 は、ポート1234でHTTPサーバーを起動し、お好みのWebブラウザーのhttp://localhost:1234/でドキュメントを参照できるようにします。 pydoc -g はサーバーを起動し、さらにドキュメントページの検索に役立つ小さな Tkinter ベースのグラフィカルインターフェイスを表示します。

pydoc がドキュメントを生成するとき、現在の環境とパスを使用してモジュールを見つけます。 したがって、 pydoc spam を呼び出すと、Pythonインタープリターを起動してimport spamと入力した場合に取得するモジュールのバージョンが正確に文書化されます。

コアモジュールのモジュールドキュメントは、 https://docs.python.org/library/にあると想定されています。 これは、 PYTHONDOCS環境変数を別のURLに設定するか、ライブラリリファレンスマニュアルページを含むローカルディレクトリに設定することで上書きできます。