pythonモジュールのオンラインヘルプを表示する pydoc
トップページ> "> 開発 "> Python

pythonモジュールのオンラインヘルプを表示する pydoc

 Pythonには、pydocというunixでいうところの「man」みたいな、オンラインヘルプを表示するモジュールが組み込まれているらしい。

 スマートな使い方は、未だよくわかっていないので、「とりあえず」の方法を覚書きしてみたい。

とりあえず使う方法(Windowsで確認)

 pydoc.pyは、<pythonインストールディレクトリ>\Lib\ にある。

 コマンドプロンプトから、以下を実行

> cd C:\Python25\Lib

pydoc.py sys

Help on built-in module sys:

NAME
    sys

FILE
    (built-in)

MODULE DOCS
    http://www.python.org/doc/current/lib/module-sys.html

DESCRIPTION
    This module provides access to some objects used or maintained by the...

※sysのオンラインヘルプが表示される。

 cdでいちいちディレクトリ移動するのが面倒な場合は、Windowsのシステムのプロパティ→詳細設定→環境変数で、pathに<pythonインストールディレクトリ>\Lib\を追加すればいいんだと思う。

キーワードで検索

C:\Python25\Lib>pydoc.py -k Simple

cStringIO - A simple fast partial StringIO replacement.
SimpleHTTPServer - Simple HTTP Server.
SimpleXMLRPCServer - Simple XML-RPC Server.
bsddb - Support for BerkeleyDB 3.3 through 4.4 with a simple interface.
chunk - Simple class to read IFF chunks.
ctypes.test.test_simplesubclasses
distutils.log - A simple log mechanism styled after PEP 282.
dumbdbm - A dumb and slow but simple dbm clone.
idlelib.textView - Simple text browser for IDLE
shlex - A lexical analyzer class for simple shell-like syntaxes.
test.test_cmath - Simple test script for cmathmodule.c...

キーワード「Simple」にヒットしたモジュールが表示される

どのモジュールimportすればいいのかな?ってときに使えるのかも。

ドキュメントを閲覧可能なwebサーバをローカルに立ち上げる

 な、なんだその機能。すごくないか。

C:\Python25\Lib>pydoc.py -p 5000
pydoc server ready at http://localhost:5000/

 5000はポート番号指定で、一般的には1000より大きい他のサービスで使っていない数字を適当に指定すればいい。

 ウェブブラウザでURLに http://localhost:5000 と指定すると、なんとマニュアルが表示される。


▲いまいち色気がないが、確かにブラウザでマニュアルが!

 わー便利。

 またひとつ、pythonの常識を覚えたところで、今回の覚書を終わる。

  はてなブックマーク - pythonモジュールのオンラインヘルプを表示する pydoc  この記事にTwitterでつぶやく このページをはてなブックマーク


nenshu.png
予測年収600万円以下なら会社にしがみつけ?だと?


次のpythonの未知のメソッド引数を調べるへ
トップページ> "> 開発 "> Python もくじ