以下のオプション属性は parser.add_option()
へのキーワード引数として
渡すことができます。特定のオプションに無関係なオプション属性を渡した場合、
または必須のオプションを渡しそこなった場合、optparse は OptionError
を送出します。
"store"
)
このオプションがコマンドラインにあった場合に optparse に何をさせるかを決めます。 取りうるオプションについては既に説明しました。
"string"
)
このオプションに与えられる引数の型 (たとえば "string"
や
"int"
) です。取りうるオプションの型については既に説明しました。
このオプションのアクションがある値をどこかに書いたり書き換えたりを意味する場合、
これは optparse にその書く場所を教えます。詳しく言えば
dest には optparse がコマンドラインを解析しながら
組み立てる options
オブジェクトの属性の名前を指定します。
default
(非推奨)
コマンドラインに指定がなかったときにこのオプションの対象に使われる値です。
使用は推奨されません。代わりに parser.set_defaults()
を使ってください。
nargs
(デフォルト: 1)
このオプションがあったときに幾つの type 型の引数が消費されるべきかを 指定します。もし > 1 ならば、optparse は dest に値のタプルを格納します。
const
定数を格納する動作のための、その定数です。
choices
"choice"
型オプションに対してユーザがその中から選べる文字列のリストです。
callback
アクションが "callback"
であるオプションに対し、このオプションがあったときに
呼ばれる呼び出し可能オブジェクトです。callable
に渡す引数の詳細については、
14.3.4 節「オプション処理コールバック」を参照してください。
callback_args
, callback_kwargs
callback
に渡される標準的な4つのコールバック引数の後ろに追加する
位置による引数またはキーワード引数です。
ユーザが help オプション("-help"
のような)を指定したときに
表示される使用可能な全オプションのリストの中のこのオプションに関する説明文です。
説明文を提供しておかなければ、オプションは説明文なしで表示されます。
オプションを隠すには特殊な値 SUPPRESS_HELP
を使います。
metavar
(デフォルト: オプション文字列から)
説明文を表示する際にオプションの引数の身代わりになるものです。 例は 14.3.2 節のチュートリアルを参照してください。
ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。