如何让optparse的OptionParser忽略无效选项？

Question

在python中__CODE__,我如何指示它忽略提供给方法的未定义选项__CODE__？

例如,
我只__CODE__为我的__CODE__实例定义了选项,但我__CODE__用list 调用了
__CODE__

编辑:
我不在乎它是否将它们从原始列表中过滤掉.我只想忽略未定义的选项.

我这样做的原因是因为我使用SCons的AddOption接口来添加自定义构建选项.但是,其中一些选项指导了目标的声明.因此,我需要在脚本中的不同点解析sys.argv,而无需访问所有选项.最后,顶级Scons OptionParser将捕获命令行中的所有未定义选项.

Answer 1

这是使用简单子类将未知参数添加到结果args中的一种方法OptionParser.parse_args.

from optparse import (OptionParser,BadOptionError,AmbiguousOptionError)

class PassThroughOptionParser(OptionParser):
    """
    An unknown option pass-through implementation of OptionParser.

    When unknown arguments are encountered, bundle with largs and try again,
    until rargs is depleted.  

    sys.exit(status) will still be called if a known argument is passed
    incorrectly (e.g. missing arguments or bad argument types, etc.)        
    """
    def _process_args(self, largs, rargs, values):
        while rargs:
            try:
                OptionParser._process_args(self,largs,rargs,values)
            except (BadOptionError,AmbiguousOptionError), e:
                largs.append(e.opt_str)

这是一个片段,表明它的工作原理:

# Show that the pass-through option parser works.
if __name__ == "__main__": #pragma: no cover
    parser = PassThroughOptionParser()
    parser.add_option('-k', '--known-arg',dest='known_arg',nargs=1, type='int')
    (options,args) = parser.parse_args(['--shazbot','--known-arg=1'])    
    assert args[0] == '--shazbot'
    assert options.known_arg == 1

    (options,args) = parser.parse_args(['--k','4','--batman-and-robin'])
    assert args[0] == '--batman-and-robin'
    assert options.known_arg == 4

Answer 2

默认情况下,无法修改在error()传递未定义选项时引发的调用行为.从有关optparse如何处理错误的部分底部的文档:

如果optparse的默认错误处理行为不符合您的需求,您需要继承OptionParser并覆盖其exit()和/或error()方法.

最简单的例子是:

class MyOptionParser(OptionParser):
    def error(self, msg):
        pass

这只会使所有调用error()无所事事.当然这并不理想,但我相信这说明了你需要做的事情.请记住来自的文档字符串error(),您应该继续前进:

打印包含'msg'的用法消息到stderr并退出.如果你在子类中重写它,它不应该返回 - 它应该退出或引发异常.

Answer 3

Python 2.7(当问到这个问题时不存在)现在提供了argparse模块.您可以使用它ArgumentParser.parse_known_args()来完成此问题的目标.

Answer 4

根据不同答案评论中 synack 的请求，我发布了一个解决方案的 hack，该解决方案在将输入传递给父级之前对其进行清理OptionParser：

import optparse
import re
import copy
import SCons

class NoErrOptionParser(optparse.OptionParser):
    def __init__(self,*args,**kwargs):
        self.valid_args_cre_list = []
        optparse.OptionParser.__init__(self, *args, **kwargs)

    def error(self,msg):
        pass

    def add_option(self,*args,**kwargs):
        self.valid_args_cre_list.append(re.compile('^'+args[0]+'='))
        optparse.OptionParser.add_option(self, *args, **kwargs)

    def parse_args(self,*args,**kwargs):
        # filter out invalid options
        args_to_parse = args[0]
        new_args_to_parse = []
        for a in args_to_parse:
            for cre in self.valid_args_cre_list:
                if cre.match(a):
                    new_args_to_parse.append(a)


        # nuke old values and insert the new
        while len(args_to_parse) > 0:
            args_to_parse.pop()
        for a in new_args_to_parse:
            args_to_parse.append(a)

        return optparse.OptionParser.parse_args(self,*args,**kwargs)


def AddOption_and_get_NoErrOptionParser( *args, **kwargs):
    apply( SCons.Script.AddOption, args, kwargs)
    no_err_optparser = NoErrOptionParser(optparse.SUPPRESS_USAGE)
    apply(no_err_optparser.add_option, args, kwargs)

    return no_err_optpars