在 Python 的 argparse 中多次使用相同的选项

我正在尝试编写一个脚本,它接受多个输入源,并对每个输入源执行一些操作

./my_script.py \
-i input1_url input1_name input1_other_var \
-i input2_url input2_name input2_other_var \
-i input3_url input3_name
# notice inputX_other_var is optional

但是我不知道如何使用 argparse实现这一点。它的设置似乎使得每个选项标志只能使用一次。我知道如何将多个参数与单个选项(nargs='*'nargs='+')关联,但这仍然不能让我多次使用 -i标志。我该怎么做呢?

先说清楚,我最后想要的是一个字符串列表

[["input1_url", "input1_name", "input1_other"],
["input2_url", "input2_name", "input2_other"],
["input3_url", "input3_name"]]
87339 次浏览

应该将 -i配置为接受3个参数并使用 append操作。

>>> p = argparse.ArgumentParser()
>>> p.add_argument("-i", nargs=3, action='append')
_AppendAction(...)
>>> p.parse_args("-i a b c -i d e f -i g h i".split())
Namespace(i=[['a', 'b', 'c'], ['d', 'e', 'f'], ['g', 'h', 'i']])

若要处理可选值,可以尝试使用简单的自定义类型。在本例中,-i的参数是一个逗号分隔的字符串,拆分次数限制为2。您需要对这些值进行后处理,以确保至少指定了两个值。

>>> p.add_argument("-i", type=lambda x: x.split(",", 2), action='append')
>>> print p.parse_args("-i a,b,c -i d,e -i g,h,i,j".split())
Namespace(i=[['a', 'b', 'c'], ['d', 'e'], ['g', 'h', 'i,j']])

要获得更多控制,请定义自定义操作。这个函数扩展了内置的 _AppendAction(由 action='append'使用) ,但只是对给 -i的参数数量进行一些范围检查。

class TwoOrThree(argparse._AppendAction):
def __call__(self, parser, namespace, values, option_string=None):
if not (2 <= len(values) <= 3):
raise argparse.ArgumentError(self, "%s takes 2 or 3 values, %d given" % (option_string, len(values)))
super(TwoOrThree, self).__call__(parser, namespace, values, option_string)


p.add_argument("-i", nargs='+', action=TwoOrThree)

下面是一个解析器,它可以处理可选的重复2个参数——名称在 metavar中定义:

parser=argparse.ArgumentParser()
parser.add_argument('-i','--input',action='append',nargs=2,
metavar=('url','name'),help='help:')


In [295]: parser.print_help()
usage: ipython2.7 [-h] [-i url name]


optional arguments:
-h, --help            show this help message and exit
-i url name, --input url name
help:


In [296]: parser.parse_args('-i one two -i three four'.split())
Out[296]: Namespace(input=[['one', 'two'], ['three', 'four']])

这不能处理 2 or 3 argument的情况(尽管我前段时间为 Python bug/问题编写了一个补丁,可以处理这样一个范围)。

nargs=3metavar=('url','name','other')单独定义一个参数怎么样?

元组 metavar也可以与 nargs='+'nargs='*'一起使用; 这两个字符串用作 [-u A [B ...]][-u [A [B ...]]]

这很简单,只需要同时添加 action='append'nargs='*'(或 '+')。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('-i', action='append', nargs='+')
args = parser.parse_args()

当你运行它的时候,你会得到

In [32]: run test.py -i input1_url input1_name input1_other_var -i input2_url i
...: nput2_name input2_other_var -i input3_url input3_name


In [33]: args.i
Out[33]:
[['input1_url', 'input1_name', 'input1_other_var'],
['input2_url', 'input2_name', 'input2_other_var'],
['input3_url', 'input3_name']]

在此线程中添加 Other。

如果在 add_argument()中使用 action='append',那么每次添加该选项时,都会在列表中获得一个(多个)列表中的参数。

如你所愿:

[["input1_url", "input1_name", "input1_other"],
["input2_url", "input2_name", "input2_other"],
["input3_url", "input3_name"]]

但是如果有人想在相同的 list[]中使用这些参数,那么在代码中使用 action='extend'而不是 action='append'。这将在一个列表中给出这些参数。

["input1_url", "input1_name", "input1_other", "input2_url", "input2_name", "input2_other", "input3_url", "input3_name"]