Python：optparseで必要なオプションを作成する方法は？
私はこれを読みました http://docs.python.org/release/2.6.2/library/optparse.html
しかし、私はoptparseで必要とされるオプションをどのように作るのかそれほど明確ではありませんか？
「required = 1」を設定しようとしましたが、エラーが発生しました。
無効なキーワード引数：必須
ユーザーが入力するスクリプトに--fileオプションを要求するようにします。 --fileのaction="store_true"に値を指定しないと、actionキーワードがエラーを与えることを知っています。
必要なオプションを簡単に実装できます。
parser = OptionParser(usage='usage: %prog [options] arguments')
parser.add_option('-f', '--file',
dest='filename',
help='foo help')
(options, args) = parser.parse_args()
if not options.filename: # if filename is not given
parser.error('Filename not given')
必要な変数Imのヘルプメッセージで、最初に '[必須]'文字列を作成し、後で解析するためにタグ付けするために、この関数を使用してラップすることができます。
def checkRequiredArguments(opts, parser):
missing_options = []
for option in parser.option_list:
if re.match(r'^\[REQUIRED\]', option.help) and eval('opts.' + option.dest) == None:
missing_options.extend(option._long_opts)
if len(missing_options) > 0:
parser.error('Missing REQUIRED parameters: ' + str(missing_options))
parser = OptionParser()
parser.add_option("-s", "--start-date", help="[REQUIRED] Start date")
parser.add_option("-e", "--end-date", dest="endDate", help="[REQUIRED] End date")
(opts, args) = parser.parse_args(['-s', 'some-date'])
checkRequiredArguments(opts, parser)
if not xは、いくつかの（負、ゼロ）パラメーターでは機能しません。
そして、多くのifテストを防ぐために、私はこのようなものを好む：
required="Host username password".split()
parser = OptionParser()
parser.add_option("-H", '--Host', dest='Host')
parser.add_option("-U", '--user', dest='username')
parser.add_option("-P", '--pass', dest='password')
parser.add_option("-s", '--ssl', dest='ssl',help="optional usage of ssl")
(options, args) = parser.parse_args()
for r in required:
if options.__dict__[r] is None:
parser.error("parameter %s required"%r)
たとえば、引数が整数または浮動小数点数で、ゼロが有効な入力である場合、現在の 投票数が最も多い回答 は機能しません。これらの場合、エラーがあると言えます。別の方法（ここで他のいくつかに追加する）は、たとえば.
parser = OptionParser(usage='usage: %prog [options] arguments')
parser.add_option('-f', '--file', dest='filename')
(options, args) = parser.parse_args()
if 'filename' not in options.__dict__:
parser.error('Filename not given')
私はソリューションにpython 2.6を使用せざるを得ないので、optparseモジュールにこだわります。必要なオプションの2回目のリストを指定せずに機能する必要なオプションを確認するソリューションを次に示します。したがって、新しいオプションを追加するときに、チェックするオプションのリストにその名前を追加する必要はありません。
必須オプションの私の基準-オプション値はNoneではなく、このオプションにはデフォルトがありません（ユーザーはadd_option（default = "..."、...）を指定しませんでした）。
def parse_cli():
"""parse and check command line options, shows help message
@return: dict - options key/value
"""
import __main__
parser = OptionParser(description=__main__.__doc__)
parser.add_option("-d", "--days", dest="days",
help="Number of days to process")
parser.add_option("-p", "--period", dest="period_length",default="2",
help="number or hours per iteration, default value=%default hours")
(options, args) = parser.parse_args()
"""get dictionary of options' default values.
in this example: { 'period_length': '2','days': None}"""
defaults = vars(parser.get_default_values())
optionsdict = vars(options)
all_none = False
for k,v in optionsdict.items():
if v is None and defaults.get(k) is None:
all_none = True
if all_none:
parser.print_help()
sys.exit()
return optionsdict
optparseで必須オプションを実装するには、少なくとも2つの方法があります。 ドキュメントページ で述べたように、optparseは必要なオプションの実装を妨げませんが、多くを与えませんそれで助けてください。ソースとともに配布されたファイルにある例を以下に示します。
optparse module はバージョン2.7以降廃止され、今後開発されないことに注意してください。代わりに argparse module を使用する必要があります。
バージョン1：引数を解析した後にアプリケーションが呼び出す必要があるOptionParserにメソッドを追加します。
import optparse
class OptionParser (optparse.OptionParser):
def check_required (self, opt):
option = self.get_option(opt)
# Assumes the option's 'default' is set to None!
if getattr(self.values, option.dest) is None:
self.error("%s option not supplied" % option)
parser = OptionParser()
parser.add_option("-v", action="count", dest="verbose")
parser.add_option("-f", "--file", default=None)
(options, args) = parser.parse_args()
print "verbose:", options.verbose
print "file:", options.file
parser.check_required("-f")
バージョン2：オプションを拡張し、必須属性を追加します。 OptionParserを拡張して、解析後に必要なオプションが存在することを確認します。
import optparse
class Option (optparse.Option):
ATTRS = optparse.Option.ATTRS + ['required']
def _check_required (self):
if self.required and not self.takes_value():
raise OptionError(
"required flag set for option that doesn't take a value",
self)
# Make sure _check_required() is called from the constructor!
CHECK_METHODS = optparse.Option.CHECK_METHODS + [_check_required]
def process (self, opt, value, values, parser):
optparse.Option.process(self, opt, value, values, parser)
parser.option_seen[self] = 1
class OptionParser (optparse.OptionParser):
def _init_parsing_state (self):
optparse.OptionParser._init_parsing_state(self)
self.option_seen = {}
def check_values (self, values, args):
for option in self.option_list:
if (isinstance(option, Option) and
option.required and
not self.option_seen.has_key(option)):
self.error("%s not supplied" % option)
return (values, args)
parser = OptionParser(option_list=[
Option("-v", action="count", dest="verbose"),
Option("-f", "--file", required=1)])
(options, args) = parser.parse_args()
print "verbose:", options.verbose
print "file:", options.file
Optparseモジュールはバージョン2.7から非推奨になっているため、おそらく最新のサンプルがここにあります： Dead simple argparse example wanted：1 argument、3 results
私もpython 2.6（python2.7とargparseにピン留めします。これは必要な引数を持っているだけでなく、セットの1つを指定する必要があることを指定できます））; 2回目のパスですが、バッチモードで実行していない限り、欠落している引数のプロンプトを表示できます。
# from myscript
import helpers
import globalconfig
parser = optparse.OptionParser(usage=myheader,epilog=myfooter)
parser.add_option("-L","--last",
action="store",dest="last_name",default="",
help="User's last (family) name; prompted for if not supplied"
)
parser.add_option("-y","--yes",
action="store_true",dest="batch_flag",default=False,
help="don't Prompt to confirm actions (batch mode)"
)
[...]
(options, args) = parser.parse_args()
globalconfig.batchmode = options.batch_flag
[...]
last = Prompt_if_empty(options.last_name,
"Last name (can supply with \"-L\" or \"--last\" option):")
# from helpers.py
def Prompt_if_empty(variable,promptstring):
if not variable:
if globalconfig.batchmode:
raise Exception('Required variable missing.')
print "%s" %promptstring
variable = raw_input(globalconfig.Prompt)
return variable
（グローバル構成の一般的なオプションが組み込まれた独自のパーサークラスを作成することを考えています。）
この質問に対する別の答えはparser.errorを引用しました。私はコードを書いたときは不慣れでしたが、より良い選択だったかもしれません。