PythonのHELP

pythonにはヘルプを見るためのいくつかの方法が提供されています。

ここでは help関数を使う方法と、pydoc.py というちょっと面白いツールの使い方を紹介します。

help関数を使う方法

help関数は、通常 python のインタープリターの中でヘルプを見るのに使います。

インタープリターのプロンプト >>> で

>>> help(<<キーワード>>)

とすればキーワードに関するヘルプを見ることができます。但し、見たいキーワードを含んでいるモジュールを import で読み込んでいないとヘルプを見ることができません。

例えば tkinter のヘルプを表示するには

>>> import tkinter

として

>>> help(tkinter）

や

>>> help(tkinter.Wm）

などと表示します。

help関数はモジュールのソースの docstring を表示するようです。tkinter のようにライブラリリファレンスにまともに情報が載っていないモジュールでは貴重な情報源と言えます。

もし今あなたがコマンドプロンプトやシェルのパスに <<pythonをインストールしたフォルダ/Lib>> を含めていないなら是非含めておきましょう。ここにはいろいろ面白い python のプログラムが入っています。

pydoc.py もその一つで、最も簡単な使い方は help関数と同じです。コマンドプロンプトで

pydoc.py <<キーワード>>

とすれば、具体的には

 pydoc.py tkinter

と打てば、tkinterモジュールのヘルプが表示されます。

ここまでは平凡ですが、面白いのはここからです。

pydoc.py -w tkinter

と打てば、カレントディレクトリの tkinter モジュールの HTML で書かれたヘルプ tkinter.html が作られます。ただのテキストファイルよりだいぶ読みやすいです。

さらにもっと面白いのは

pydoc.py -b

です。コンソールには

Server ready at http://localhost:59321/
Server commands: [b]rowser, [q]uit
server>

と表示されて httpサーバーが起動し、自動的にブラウザが起動して、全モジュールのヘルプが表示されます。

英語に問題がない方であれば、これで pythonのモジュールをブラウザしてみるのも面白いでしょう。