我试图将一个列表作为参数传递给命令行程序。是否有argparse选项传递一个列表作为选项?
parser.add_argument('-l', '--list',
type=list, action='store',
dest='list',
help='<Required> Set flag',
required=True)
脚本如下所示
python test.py -l "265340 268738 270774 270817"
编辑:结合了Katu建议的改进,删除了单独的解析步骤。
JSON列表解决方案
通过命令行处理传递列表(也包括字典)的一个好方法是使用json。
# parse_list.py
import argparse
import json
parser = argparse.ArgumentParser()
# note type arg, used to load json string
parser.add_argument('-l', '--list', type=json.loads)
args = parser.parse_args()
print(args.list)
示例使用
$ python parse_list.py -l "[265340, 268738, 270774, 270817]"
[265340, 268738, 270774, 270817]
如果你有一个嵌套列表,其中内部列表有不同的类型和长度,你想要保留类型,例如:
[[1,2], ["foo", "bar"], [3.14, "baz", 20]]]
然后你可以使用@sam-mason提出的解决方案来解决这个问题,如下所示:
from argparse import ArgumentParser
import json
parser = ArgumentParser()
parser.add_argument('-l', type=json.loads)
parser.parse_args(['-l', '[[1,2],["foo","bar"],[3.14,"baz",20]]'])
这使:
Namespace(l=[[1, 2], ['foo', 'bar'], [3.14, 'baz', 20]])
我更喜欢传递一个带分隔符的字符串,稍后在脚本中解析。原因是;列表可以是任何类型的int或str,有时使用nargs,如果有多个可选参数和位置参数,我会遇到问题。
parser = ArgumentParser()
parser.add_argument('-l', '--list', help='delimited list input', type=str)
args = parser.parse_args()
my_list = [int(item) for item in args.list.split(',')]
然后,
python test.py -l "265340,268738,270774,270817" [other arguments]
or,
python test.py -l 265340,268738,270774,270817 [other arguments]
会很好。分隔符也可以是空格,这将强制在参数值周围加上引号,就像问题中的示例一样。
或者你也可以使用Chepner评论中建议的lambda类型:
parser.add_argument('-l', '--list', help='delimited list input',
type=lambda s: [int(item) for item in s.split(',')])
在add_argument()中,type只是一个可调用的对象,它接收字符串并返回选项值。
import ast
def arg_as_list(s):
v = ast.literal_eval(s)
if type(v) is not list:
raise argparse.ArgumentTypeError("Argument \"%s\" is not a list" % (s))
return v
def foo():
parser.add_argument("--list", type=arg_as_list, default=[],
help="List of values")
这将允许:
$ ./tool --list "[1,2,3,4]"
我认为最优雅的解决方案是传递一个lambda函数给“类型”,正如Chepner所提到的。除此之外,如果你事先不知道列表的分隔符是什么,你也可以传递多个分隔符给re.split:
# python3 test.py -l "abc xyz, 123"
import re
import argparse
parser = argparse.ArgumentParser(description='Process a list.')
parser.add_argument('-l', '--list',
type=lambda s: re.split(' |, ', s),
required=True,
help='comma or space delimited list of characters')
args = parser.parse_args()
print(args.list)
# Output: ['abc', 'xyz', '123']
除了nargs,如果你事先知道列表,你可能会想要使用choices:
>>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
>>> parser.parse_args(['rock'])
Namespace(move='rock')
>>> parser.parse_args(['fire'])
usage: game.py [-h] {rock,paper,scissors}
game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',
'paper', 'scissors')