Python argh/argparse：如何将列表作为命令行参数传递？

Question

我正在尝试使用argh库将参数列表传递给Python脚本。希望能够接受以下类型的输入：

./my_script.py my-func --argA blah --argB 1 2 3 4
./my_script.py my-func --argA blah --argB 1
./my_script.py my-func --argA blah --argB 

我的内部代码看起来像这样：

import argh

@argh.arg('--argA', default="bleh", help='My first arg')
@argh.arg('--argB', default=[], help='A list-type arg--except it\'s not!')
def my_func(args):
    "A function that does something"

    print args.argA
    print args.argB

    for b in args.argB:
        print int(b)*int(b)  #Print the square of each number in the list
    print sum([int(b) for b in args.argB])  #Print the sum of the list

p = argh.ArghParser()
p.add_commands([my_func])
p.dispatch()

以下是它的表现：

$ python temp.py my-func --argA blooh --argB 1
blooh
['1']
1
1

$ python temp.py my-func --argA blooh --argB 10
blooh
['1', '0']
1
0
1

$ python temp.py my-func --argA blooh --argB 1 2 3
usage: temp.py [-h] {my-func} ...
temp.py: error: unrecognized arguments: 2 3

问题似乎很简单：argh只接受第一个参数，并将其视为字符串。我该如何使它“期望”整数列表？

我看到在optparse中如何实现，但是对于（未弃用的）argparse呢？或者使用argh更好的装饰语法？这些似乎更符合Python风格。

- Abe

Answer 1

使用argparse，只需要使用type=int。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-a', '--arg', nargs='+', type=int)
print parser.parse_args()

示例输出：

$ python test.py -a 1 2 3
Namespace(arg=[1, 2, 3])

编辑：我不熟悉argh，但它似乎只是argparse的一个包装器，这对我有用：

import argh

@argh.arg('-a', '--arg', nargs='+', type=int)
def main(args):
    print args

parser = argh.ArghParser()
parser.add_commands([main])
parser.dispatch()

输出示例：

$ python test.py main -a 1 2 3
Namespace(arg=[1, 2, 3], function=<function main at 0x.......>)

- jcollado

---

太棒了！我调整了代码，包括以下行：@argh.arg('--argB', default=[], help='A list-type arg--except it's not!', nargs='+', type=int)，而且 argh 很喜欢。感谢您的帮助！ - Abe

是的，这是正确的方式。最近版本的Argh还支持“自然”的、更符合Python风格的表示法：func(argA, *argB)（尽管*args映射到nargs='*'而不是nargs='+'）。 - Andy Mikhaylenko

@jcollado：我发现当我使用nargs=时，不能这样使用“-a = 1 2 3”。我的意思是在参数metavar之后使用“=”。有没有办法让我对每个参数使用=。例如，在你的例子中，我想这样做，python test.py main -a=1 2 3。 - script_kiddie

@Andy Mikhaylenko 上述问题。 - script_kiddie

@AndyMikhaylenko 我不知道有什么简单的方法可以做到这一点。一个替代方案可能是：parser.add_argument('-a', '--arg', type=lambda s: [int(n) for n in s.split()]) 并使用引号调用脚本：python test.py --arg="1 2 3"。 - jcollado

@script_kiddie @jcollado 问题在于=字符。-a 1 2的意思是“a = [1, 2]”，而-a=1 2的意思是“a = 1; some-positional-argument = 2”。 - Andy Mikhaylenko

Answer 2

为了访问每个参数的值，以下代码可能会有所帮助。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('-a', '--arg', nargs='+', type=int)
args = vars(parser.parse_args())

print "first parameter:" + str(args["arg"][0])
print "second parameter:" + str(args["arg"][1])
print "third parameter:" + str(args["arg"][2])

- Luis Jose