optparse を使う最初の一歩は OptionParser インスタンスを作ることです。
parser = OptionParser(...)
OptionParser のコンストラクタの引数はどれも必須ではありませんが、いくつ ものキーワード引数がオプションとして使えます。これらはキーワード引数と して渡さなければなりません。すなわち、引数が宣言されている順番に頼っては いけません。
usage (デフォルト: "%prog [options]")%prog を
os.path.basename(sys.argv[0]) (または
prog キーワード引数が指定されていればその値) に展開します。
使用法メッセージを抑制するためには特別な
optparse.SUPPRESS_USAGE という値を指定します。
option_list (デフォルト: [])option_list の
中のオプションは standard_option_list (OptionParser の
サブクラスでセットされる可能性のあるクラス属性) の後に追加されますが、バージョンや
ヘルプのオプションよりは前になります。
このオプションの使用は推奨されません。パーザを作成した後で、add_option()
を使って追加してください。
option_class (デフォルト: optparse.Option)version (デフォルト: None)version に真の値を与えると、optparse は自動的に
単独のオプション文字列 "-version" とともにバージョンオプションを
追加します。部分文字列 "%prog" は usage と同様に
展開されます。
conflict_handler (デフォルト: "error")description (デフォルト: None)usage の後、オプションリストの前に表示されます)。
formatter (デフォルト: 新しい IndentedHelpFormatter)add_help_option (デフォルト: True)"-h" と "-help" とともに)
追加します。
progusage や version の中の "%prog" を展開するときに
os.path.basename(sys.argv[0]) の代わりに使われる文字列です。
ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。