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

Question

我正在尝试编写一个接受多个输入源并对每个输入源执行某些操作的脚本。像这样的东西

./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"]]

Answer 1

这是一个解析器，它处理重复的 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 错误/问题编写了一个补丁）。

使用nargs=3和metavar=('url','name','other')的单独参数定义怎么样？

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

Answer 2

这很简单;只需添加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']]

Answer 3

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

Answer 4

在此

线程中添加其他。

如果在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"
]