Question

我已阅读此http://docs.python.org/release/2.6.2/library/optparse.html

但是我不太清楚如何在optparse中选择一个选项？

我试过设置“required = 1”但是我收到了错误：

无效的关键字参数：必需

我想让用户输入我的脚本需要--file选项。我知道当action为--file提供价值时，action="store_true"关键字会出错。

Answer 1

您可以轻松实施所需选项。

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')

Answer 2

在每个必需变量的帮助消息上在开头写一个'[REQUIRED]'字符串，标记它以便稍后解析，然后我可以简单地使用这个函数来包装它：

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)

Answer 3

由于if not x不起作用对于某些（负，零）参数，

并且为了防止大量的测试，我更喜欢这样的事情：

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)

Answer 4

我被迫使用python 2.6作为我们的解决方案，所以我坚持使用optparse模块。这是我找到的解决方案，检查所需的选项，但不指定所需选项的第二时间列表。因此，当您添加新选项时，您不必将其名称添加到要检查的选项列表中。

我对必需选项的标准 - 选项值应该不是None，而且这个选项没有默认值（用户没有指定add_option（默认=“......”，...）。

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

Answer 5

例如，当参数为整数或浮点数时，当前answer with the most votes将不起作用，其中零是有效输入。在这些情况下，它会说有错误。另一种选择（在这里添加其他几个）就是这样做。

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')

Answer 6

至少有两种方法可以使用optparse实现所需的选项。正如docs page中所述， optparse 并不会阻止您实施所需的选项，但也不会为您提供太多帮助。在下面找到与源一起分发的文件中的示例。

虽然请注意{2.7}自版本2.7以来已弃用，但不会进一步开发。您应该使用optparse 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")

来源：argparse module

版本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

来源：docs/lib/required_1.txt

Answer 7

我还坚持使用python 2.6（python2.7和argparse，它不仅需要参数，还允许我指定必须提供一个集合）;我的方法需要第二次传递，但是让我提示缺少参数，除非以批处理模式运行：

# 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，我在编写代码时对此并不熟悉，但可能是更好的选择。

Answer 8

我会使用嵌入了此功能的argparse库：

PARSER.add_argument("-n", "--namespace", dest="namespace", required=True,
              help="The path within the repo to the data base")

argparse reference

Python：如何在optparse中提供选项？

8 个答案: