「PythonのHELP」の版間の差分

2018年12月2日 (日) 14:37時点における版

pythonにはライブラリの docstring から生成されるヘルプを見るためのいくつかの方法が提供されています。

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

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

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

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

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

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

>>> import tkinter

として

>>> help(tkinter）

とします。tkinter の Wmクラスを表示するには

>>> help(tkinter.Wm）

で ok です。

tkinter のようにライブラリリファレンスにまともに情報が載っていないモジュールでは docstring の情報は貴重です。

pythonには標準で pydoc というモジュールが含まれています。

これの最も簡単な使い方は help関数と同じです。コマンドプロンプトで

python -m pydoc.py <<キーワード>>

とすれば、具体的には

python -m pydoc.py tkinter

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

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

python -m pydoc.py -w tkinter

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

さらにもっと面白いのは

python -m pydoc.py -b

です(Windowsでは py でも可)。コンソールには

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

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

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

@@ 36行: / 36行: @@
 ==pydoc.py を使う方法==
-もし今あなたが コマンドプロンプトやシェルのパスに <<pythonをインストールしたフォルダ/Lib>> を含めていないなら是非含めておきましょう。
+pythonには標準で pydoc というモジュールが含まれています。
-ここにはいろいろ面白い python のプログラムが入っています。
-pydoc.py もその一つで、最も簡単な使い方は help関数と同じです。コマンドプロンプトで
+これの最も簡単な使い方は help関数と同じです。コマンドプロンプトで
-  pydoc.py <<キーワード>>
+  python -m pydoc.py <<キーワード>>
 とすれば、具体的には
-  pydoc.py tkinter
+ python -m pydoc.py tkinter
 と打てば、tkinterモジュールのヘルプが表示されます。
@@ 52行: / 51行: @@
-  pydoc.py -w tkinter
+  python -m pydoc.py -w tkinter
 と打てば、カレントディレクトリに tkinter モジュールの HTML で書かれたヘルプ tkinter.html が作られます。
@@ 59行: / 58行: @@
 さらにもっと面白いのは
-  pydoc.py -b
+  python -m pydoc.py -b
-です。コンソールには
+です(Windowsでは py でも可)。コンソールには
   Server ready at http://localhost:59321/