14.3.2.6 ヘルプの生成

optparse にはヘルプと使い方の説明 (usage text) を生成する機能があり、 ユーザに優しいコマンドラインインタフェースを作成する上で役立ちます。 やらなければならないのは、各オプションに対するhelp の値と、 必要ならプログラム全体の使用法を説明する短いメッセージを与えることだけです。

ユーザフレンドリな (ドキュメント付きの) オプションを追加した OptionParser を以下に示します:

usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=True,
                  help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose", 
                  help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
                  metavar="FILE", help="write output to FILE"),
parser.add_option("-m", "--mode",
                  default="intermediate",
                  help="interaction mode: novice, intermediate, "
                       "or expert [default: %default]")

optparse がコマンドライン上で"-h""-help" を 見つけた場合やユーザがparser.print_help() を呼び出した場合、 このOptionParser は以下のようなメッセージを標準出力に出力します:

usage: <yourscript> [options] arg1 arg2

options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

(help オプションでヘルプを出力した場合、optparse は出力後に プログラムを終了します。)

optparse ができるだけうまくメッセージを生成するよう手助けするには、 他にもまだまだやるべきことがあります:

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。