pydoc – Python モジュールのオンラインヘルプ¶
| 目的: | コードから Python モジュールやクラスのヘルプを生成する |
|---|---|
| 利用できるバージョン: | 2.1 以上 |
pydoc モジュールは Python モジュールをインポートし、実行時にヘルプを生成してそのコンテンツを利用します。任意のオブジェクトの docstrings 出力とモジュールの全ドキュメントコンテンツが記述されます。
HTML ヘルプ¶
さらに pydoc は HTML 出力も生成できます。ローカルディレクトリの静的ファイルへ書き込むか、オンラインドキュメントをブラウズするために web サーバを起動するかを選べます。
$ pydoc -w atexit
カレントディレクトリに atexit.html を作成します。
$ pydoc -p 5000
http://localhost:5000/ で web サーバを起動します。このサーバは利用可能なモジュールをブラウズできるようにドキュメントを生成します。
インタラクティブヘルプ¶
さらに pydoc は __builtins__ に help() 関数を追加するので、Python インタープリタプロンプトから同じ情報にアクセスできます。
$ python
Python 2.6.2 (r262:71600, Apr 16 2009, 09:17:39)
[GCC 4.0.1 (Apple Computer, Inc. build 5250)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> help('atexit')
Help on module atexit:
NAME
atexit
FILE
/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/atexit.py
...
See also
- pydoc
- 本モジュールの標準ライブラリドキュメント
- motw-cli
- コマンドラインから PyMOTW の記事へアクセスする
- motw-interactive
- Python インタラクティブインタープリタから PyMOTW の記事へアクセスする
