Question

我想构建一个parser.add_argument(...)来映射给定的参数，并在我的代码中定义常量。

假设我有以下

import argparse

# Both are the same type
CONST_A = <something>
CONST_B = <otherthing>

parser = argparse.ArgumentParser()
parser.add_argument(...)

# I'd like the following to be true:
parser.parse_args("--foo A".split()).foo == CONST_A
parser.parse_args("--foo B".split()).foo == CONST_B

我可以用什么代替...？

const能做的最好的事情是：

import argparse

# Both are the same type
CONST_A = 10
CONST_B = 20

parser = argparse.ArgumentParser()
status_group = parser.add_mutually_exclusive_group(required=True)
status_group.add_argument("-a", const=CONST_A, action='store_const')
status_group.add_argument("-b", const=CONST_B, action='store_const')

# I'd like the following to be true:
print parser.parse_args("-a".split()).a == CONST_A # True
print parser.parse_args("-b".split()).b == CONST_B # True

请注意，常量被保存为两个不同的属性a和b，不适合我:(

Answer 1

最简单的方法是利用type=中的add_argument选项，例如@hpaulj，虽然可以使用工厂函数进行推广：

def argconv(**convs):
    def parse_argument(arg):
        if arg in convs:
            return convs[arg]
        else:
            msg = "invalid choice: {!r} (choose from {})"
            choices = ", ".join(sorted(repr(choice) for choice in convs.keys()))
            raise argparse.ArgumentTypeError(msg.format(arg,choices))
    return parse_argument

然后代替...使用type=argconv(A=CONST_A, B=CONST_B)：

parser.add_argument("--foo", type=argconv(A=CONST_A, B=CONST_B))

然后一切都会按照你想要的那样在你的例子中运作。

以下是我发布的第一个答案，它仍然有效，但并不像上述解决方案那么简单。

另一种方法是创建一个继承自argparse.ArgumentParser并覆盖parse_args的类，以便在生成结果时修改结果：

import argparse

class MappedParser(argparse.ArgumentParser):
    mapping = {} #backup if you don't use def_mapping

    def def_mapping(self,**options):
        self.mapping = options

    def parse_args(self,args=None,namespace=None):
        result = argparse.ArgumentParser.parse_args(self,args,namespace)
        for name,options in self.mapping.items(): #by default this is is empty so the loop is skipped
            if name in result:
                key = getattr(result,name)
                if key in options:
                    replace_with = options[key]
                    setattr(result,name,replace_with)
                else:
                    self.error("option {name!r} got invalid value: {key!r}\n must be one of {valid}".format(name=name,key=key,valid=tuple(options.keys())))
                    return #error should exit program but I'll leave this just to be safe.
        return result

这样你的（示例）程序的其余部分将如下所示：

# There is nothing restricting their type.
CONST_A = "<something>"
CONST_B = ["other value", "type is irrelevent"]

parser = MappedParser() #constructor is same

parser.def_mapping(foo={"A":CONST_A, "B":CONST_B})

parser.add_argument("--foo") # and this is unchanged

# the following is now true:
print(parser.parse_args("--foo A".split()).foo is CONST_A)
print(parser.parse_args("--foo B".split()).foo is CONST_B)
#note that 'is' operator works so it is even the same reference

#this gives decent error message
parser.parse_args("--foo INVALID".split())

print("when parser.error() is called the program ends so this never is printed")

添加这样的额外选项：

parser.def_mapping(foo={"A":CONST_A, "B":CONST_B,"C":"third option"})

或像这样的额外参数：

parser.def_mapping(foo={"A":CONST_A, "B":CONST_B},
                   conv={"int":int,"float":float})

以及def_mapping中未指定的任何添加的参数都是独立的，因此很容易实现。

Answer 2

这是一个有趣的问题。据我所知，argparse并不直接支持这一点。

如果您经常发现此模式，您可以编写一个小型实用程序类，通过transforming args into a dictionary via vars为您执行此操作：

class Switcher(object):
    def __init__(self, d):
        self._d = d

    def __call__(self, args):
        args_ = vars(args)

        for k, v in self._d.items():
            if args_[k]:
                return v

您可以按如下方式使用它。假设您的解析器由以下人员定义：

import argparse

parser = argparse.ArgumentParser()
g = parser.add_mutually_exclusive_group()
g.add_argument('-a', action='store_true', default=False)
g.add_argument('-b', action='store_true', default=False)

然后您可以通过以下方式定义Switcher：

s = Switcher({'a': 10, 'b': 20})

并像这样使用它：

>>> print s(parser.parse_args(['-a']))
10 

>>> print s(parser.parse_args(['-b']))
20

Answer 3

这对于自定义type参数来说是个好例子：

CONST_A='<A>'
CONST_B='<B>'
def footype(astring):
    dd = {'A':CONST_A, 'B':CONST_B}
    try:
        return dd[astring]
    except KeyError:
        raise argparse.ArgumentTypeError('enter A or B')

parser = argparse.ArgumentParser()
parser.add_argument('--foo', type=footype)

它将生成类似

的命名空间

Namespace(foo='<A>')

和错误消息（如果给出--foo C），如：

usage: stack35648071.py [-h] [--foo FOO]
stack35648071.py: error: argument --foo: enter A or B

我尝试添加choices，但帮助信息不对。使用metavar和help来指导您的用户。

Answer 4

我不会创建新的操作或对象：只需使用dict来存储常量，使用--foo限制choices的值并使用parsed_args.foo索引dict：

import argparse

CONST = {'A': 'something',
         'B': 'otherthing'}

parser = argparse.ArgumentParser()
parser.add_argument('--foo', choices=('A', 'B'))

assert CONST[parser.parse_args("--foo A".split()).foo] == 'something'
assert CONST[parser.parse_args("--foo B".split()).foo] == 'otherthing'

choices与dict密钥的组合实质上修复了foo的结果。

<小时/> 如果您希望使事情更清晰或更容易，则在解析参数后，可以将foo重新分配给dict值：

args = parser.parse_args("--foo A".split())
args.foo = CONST[args.foo]

现在args.foo直接等同于'something'。

Answer 5

根据docs：

action关键字参数指定应如何处理命令行参数。您还可以通过传递Action子类或实现相同接口的其他对象来指定任意操作。

@Model.CategoryList.result

argparse：将用户输入映射到已定义的常量

5 个答案: