我怎么能传递一个列表作为一个命令行参数与Argparse?

我正在尝试将列表作为参数传递给命令行程序。是否有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"
559516 次浏览

简短的回答

使用nargs选项或action选项的'append'设置(取决于您希望用户交互界面的行为方式)。

nargs

parser.add_argument('-l','--list', nargs='+', help='<Required> Set flag', required=True)
# Use like:
# python arg.py -l 1234 2345 3456 4567

nargs='+'需要1个或多个参数,nargs='*'需要零个或多个参数。

追加

parser.add_argument('-l','--list', action='append', help='<Required> Set flag', required=True)
# Use like:
# python arg.py -l 1234 -l 2345 -l 3456 -l 4567

使用append,您可以多次提供选项来构建列表。

不要使用type=list!!!-可能没有您想将type=listargparse一起使用的情况。永远不会。


很长的答案

让我们更详细地看一下人们可能尝试这样做的一些不同方式,以及最终结果。

import argparse


parser = argparse.ArgumentParser()


# By default it will fail with multiple arguments.
parser.add_argument('--default')


# Telling the type to be a list will also fail for multiple arguments,
# but give incorrect results for a single argument.
parser.add_argument('--list-type', type=list)


# This will allow you to provide multiple arguments, but you will get
# a list of lists which is not desired.
parser.add_argument('--list-type-nargs', type=list, nargs='+')


# This is the correct way to handle accepting multiple arguments.
# '+' == 1 or more.
# '*' == 0 or more.
# '?' == 0 or 1.
# An int is an explicit number of arguments to accept.
parser.add_argument('--nargs', nargs='+')


# To make the input integers
parser.add_argument('--nargs-int-type', nargs='+', type=int)


# An alternate way to accept multiple inputs, but you must
# provide the flag once per input. Of course, you can use
# type=int here if you want.
parser.add_argument('--append-action', action='append')


# To show the results of the given option to screen.
for _, value in parser.parse_args()._get_kwargs():
if value is not None:
print(value)

以下是您可以期待的输出:

$ python arg.py --default 1234 2345 3456 4567
...
arg.py: error: unrecognized arguments: 2345 3456 4567


$ python arg.py --list-type 1234 2345 3456 4567
...
arg.py: error: unrecognized arguments: 2345 3456 4567


$ # Quotes won't help here...
$ python arg.py --list-type "1234 2345 3456 4567"
['1', '2', '3', '4', ' ', '2', '3', '4', '5', ' ', '3', '4', '5', '6', ' ', '4', '5', '6', '7']


$ python arg.py --list-type-nargs 1234 2345 3456 4567
[['1', '2', '3', '4'], ['2', '3', '4', '5'], ['3', '4', '5', '6'], ['4', '5', '6', '7']]


$ python arg.py --nargs 1234 2345 3456 4567
['1234', '2345', '3456', '4567']


$ python arg.py --nargs-int-type 1234 2345 3456 4567
[1234, 2345, 3456, 4567]


$ # Negative numbers are handled perfectly fine out of the box.
$ python arg.py --nargs-int-type -1234 2345 -3456 4567
[-1234, 2345, -3456, 4567]


$ python arg.py --append-action 1234 --append-action 2345 --append-action 3456 --append-action 4567
['1234', '2345', '3456', '4567']

外卖

  • 使用nargsaction='append'
    • 从用户的角度来看,nargs可以更直接,但如果有位置参数,它可能是不直观的,因为argparse无法分辨什么应该是位置参数,什么属于nargs;如果你有位置参数,那么action='append'可能最终是一个更好的选择。
    • 以上仅适用于给定nargs'*''+''?'的情况。如果您提供一个整数(例如4),那么将选项与nargs和位置参数混合将没有问题,因为argparse将确切知道该选项的期望值。
  • 不要在命令行上使用引号1
  • 不要使用type=list,因为它会返回一个列表
    • 发生这种情况是因为在引擎盖下argparse使用type的值来强制每个给定的参数你选择type,而不是所有参数的聚合。
    • 您可以使用type=int(或其他)来获取整数列表(或其他)

1:我不是一般的意思…我的意思是使用引号来将列表传递给argparse不是你想要的。

除了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')

我更喜欢传递一个分隔的字符串,稍后在脚本中解析。原因是;列表可以是任何类型intstr,有时使用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]

或,

python test.py -l 265340,268738,270774,270817 [other arguments]

将正常工作。分隔符也可以是空格,它将在参数值周围强制引号,就像问题中的示例一样。

或者你可以使用一个lambda类型,正如Chepner在评论中建议的那样:

parser.add_argument('-l', '--list', help='delimited list input',
type=lambda s: [int(item) for item in s.split(',')])

在Argparse的add_argument方法中使用nargs参数

我使用nargs='*'作为add_argument参数。如果我没有传递任何显式参数,我特别使用nargs='*'来选择默认值

包括一个代码片段作为示例:

示例:temp_args1.py

请注意:下面的示例代码是用python3编写的。通过改变print语句格式,可以在python2中运行

#!/usr/local/bin/python3.6


from argparse import ArgumentParser


description = 'testing for passing multiple arguments and to get list of args'
parser = ArgumentParser(description=description)
parser.add_argument('-i', '--item', action='store', dest='alist',
type=str, nargs='*', default=['item1', 'item2', 'item3'],
help="Examples: -i item1 item2, -i item3")
opts = parser.parse_args()


print("List of items: {}".format(opts.alist))

注意:我正在收集存储在列表中的多个字符串参数-opts.alist 如果您想要整数列表,请将parser.add_argument上的类型参数更改为int

执行结果:

python3.6 temp_agrs1.py -i item5 item6 item7
List of items: ['item5', 'item6', 'item7']


python3.6 temp_agrs1.py -i item10
List of items: ['item10']


python3.6 temp_agrs1.py
List of items: ['item1', 'item2', 'item3']

如果您打算让单个开关接受多个参数,那么您可以使用nargs='+'。如果您的示例'-l'实际上采用整数:

a = argparse.ArgumentParser()
a.add_argument(
'-l', '--list',  # either of this switches
nargs='+',       # one or more parameters to this switch
type=int,        # /parameters/ are ints
dest='lst',      # store in 'lst'.
default=[],      # since we're not specifying required.
)


print a.parse_args("-l 123 234 345 456".split(' '))
print a.parse_args("-l 123 -l=234 -l345 --list 456".split(' '))

产生

Namespace(lst=[123, 234, 345, 456])
Namespace(lst=[456])  # Attention!

如果多次指定同一参数,则默认操作('store')将替换存量数据。

另一种方法是使用append操作:

a = argparse.ArgumentParser()
a.add_argument(
'-l', '--list',  # either of this switches
type=int,        # /parameters/ are ints
dest='lst',      # store in 'lst'.
default=[],      # since we're not specifying required.
action='append', # add to the list instead of replacing it
)


print a.parse_args("-l 123 -l=234 -l345 --list 456".split(' '))

它产生

Namespace(lst=[123, 234, 345, 456])

或者,您可以编写自定义处理程序/操作来解析逗号分隔的值,以便您可以执行

-l 123,234,345 -l 456

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

如果您有一个嵌套列表,其中内部列表具有不同的类型和长度,并且您希望保留该类型,例如:

[[1, 2], ["foo", "bar"], [3.14, "baz", 20]]

然后您可以使用@陈志立@陈志立这个问题提出的解决方案,如下所示:

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

我想处理传递多个列表、整数值和字符串。

有用的链接=>如何将Bash变量传递给Python?

def main(args):
my_args = []
for arg in args:
if arg.startswith("[") and arg.endswith("]"):
arg = arg.replace("[", "").replace("]", "")
my_args.append(arg.split(","))
else:
my_args.append(arg)


print(my_args)




if __name__ == "__main__":
import sys
main(sys.argv[1:])

顺序并不重要。如果你想传递一个列表,只需在"[""]之间做,并使用逗号将它们分开。

然后,

python test.py my_string 3 "[1,2]" "[3,4,5]"

输出=>['my_string', '3', ['1', '2'], ['3', '4', '5']]my_args变量按顺序包含参数。

我认为最优雅的解决方案是将lambda函数传递给“type”,正如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']

您可以将列表解析为字符串并使用eval内置函数将其读取为列表。在这种情况下,您必须将单引号放入双引号(或绕过)以确保成功的字符串解析。

# declare the list arg as a string
parser.add_argument('-l', '--list', type=str)


# parse
args = parser.parse()


# turn the 'list' string argument into a list object
args.list = eval(args.list)
print(list)
print(type(list))

测试:

python list_arg.py --list "[1, 2, 3]"


[1, 2, 3]
<class 'list'>

编辑:合并了Katu建议的改进以删除单独的解析步骤。

JSON列表解决方案

通过命令行处理传递列表(也包括dicts)的一个好方法是使用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]

请注意,如果您将action='append'default参数一起传递,Argparse将尝试附加到提供的默认值,而不是替换默认值,这可能是您期望的,也可能不是。

这里有一个action='appendArgparse文档中给出的示例。 在这种情况下,事情会按预期进行:

>> import argparse
>> parser = argparse.ArgumentParser()
>> parser.add_argument('--foo', action='append')
>> parser.parse_args('--foo 1 --foo 2'.split())


Out[2]: Namespace(foo=['1', '2'])

但是,如果您选择提供默认值,Argparse的“append”操作将尝试追加到提供的默认值,而不是替换默认值:

import argparse
REASONABLE_DEFAULTS = ['3', '4']
parser = argparse.ArgumentParser()
parser.add_argument('--foo', default=REASONABLE_DEFAULTS,action='append')
parser.parse_args('--foo 1 --foo 2'.split())


Out[6]: Namespace(foo=['3', '4', '1', '2'])

如果您是期待 Argparse到取代的默认值-例如将元组作为默认值传递,而不是列表-这可能会导致一些令人困惑的错误:

import argparse
REASONABLE_DEFAULTS = ('3', '4')
parser = argparse.ArgumentParser()
parser.add_argument('--foo', default=REASONABLE_DEFAULTS,action='append')
parser.parse_args('--foo 1 --foo 2'.split())


AttributeError: 'tuple' object has no attribute 'append'

有一个bug追踪这种意想不到的行为,但由于它可以追溯到2012年,因此不太可能得到解决。

将chepner的评论应用于Lunguini的答案:

import argparse, json
parser = argparse.ArgumentParser()
parser.add_argument('-l', '--list', type=lambda a: json.loads(a), default="[]",
help="String formatted as list wrapped in []")
args = parser.parse_args()
print(args.list)

用法:

$ python parse_list.py -l "[265340, 268738, 270774, 270817]"
[265340, 268738, 270774, 270817]