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

Posted 2023-03-07

【中文标题】python argh/argparse：如何将列表作为命令行参数传递？

【英文标题】：python argh/argparse: How can I pass a list as a command-line argument?

【发布时间】：2012-03-12 23:22:19

【问题描述】：

我正在尝试使用 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 只接受第一个参数，并将其视为字符串。如何让它“期望”一个整数列表？

我看到how this is done in optparse，但是（未弃用的）argparse 呢？或者使用 argh 更好的修饰语法？这些看起来更像蟒蛇。

【参考方案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.......>)

【讨论】：

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

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

@jcollado ：我看到当我使用 nargs= 时，我不能做 -a=1 2 3 。我的意思是在参数 metavar 之后使用 '='。任何让我对每个 arg 使用 = 的解决方案。对于你的例子中我想做的例子，python test.py main -a=1 2 3

@Andy Mikhaylenko 以上问题。

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

【参考方案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])