如何使用 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"

解决方案 1：

简短回答

使用该nargs选项或选项'append'的设置action（取决于您希望用户界面如何运行）。

纳尔格斯

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=listwith 的情况argparse。

详细答案

让我们更详细地了解一下可以尝试实现此目的的一些不同方法以及最终结果。

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

要点：

• 使用nargs或action='append'

  • nargs从用户的角度来看可能更直接，但如果有位置参数，它可能不直观，因为argparse无法分辨什么应该是位置参数以及什么属于nargs；如果您有位置参数，那么action='append'可能最终是一个更好的选择。

  • 上述内容仅在nargs给定'*'、'+'或 时才成立'?'。如果您提供一个整数（例如），那么将选项与和 位置参数4混合在一起不会有问题，因为将确切知道选项的预期值数量。nargs`argparse`

• 不要在命令行上使用引号1

• 不要使用type=list，因为它将返回列表列表

  • 发生这种情况的原因是，在底层argparse使用的值type来强制选择每个单独的给定参数type，而不是所有参数的总和。

  • 您可以使用type=int（或其他）来获取整数列表（或其他）

1：我不是指一般意义上的..我的意思是使用引号来传递列表argparse并不是你想要的。

解决方案 2：

我更喜欢传递一个分隔字符串，稍后在脚本中解析它。这样做的原因是：列表可以是任何类型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]

或者，

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(',')])

解决方案 3：

除此以外，如果你提前知道列表的话，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')

解决方案 4：

JSON 列表解决方案

通过命令行传递列表（和字典）的一个好方法是使用json。

只需指定type=json.loads：

# parse_list.py

import argparse
import json

parser = argparse.ArgumentParser()
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]

编辑：采纳Katu建议的改进措施，删除单独的解析步骤。

可以单独处理 json 解析以避免误用type参数：

# parse_list.py
import argparse
import json

parser = argparse.ArgumentParser()
parser.add_argument('-l', '--list', type=str)
args = parser.parse_args()
# parse string json input to python list
parsed_list = json.loads(args.list)
print(parsed_list)

解决方案 5：

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

我将其用作nargs='*'add_argument 参数。nargs='*'如果我没有传递任何显式参数，我专门使用该选项来选择默认值

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

例如：temp_args1.py

请注意：以下示例代码是用python3编写的。通过更改打印语句格式，可以在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']

解决方案 6：

如果你打算让单个开关接受多个参数，那么你可以使用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

解决方案 7：

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

解决方案 8：

我认为最优雅的解决方案是将 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']

解决方案 9：

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

以下是action='append Argparse Docs 中给出的一个示例。在这种情况下，事情将按预期进行：

>> 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 的“附加”操作将尝试附加到提供的默认值，而不是替换默认值：

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'

有一个错误跟踪这种意外行为，但由于它出现于 2012 年，所以不太可能得到解决。

解决方案 10：

如果你有一个嵌套列表，其中内部列表具有不同的类型和长度，并且你想保留类型，例如，

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

解决方案 11：

您可以将列表解析为字符串，并使用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'>

解决方案 12：

将 chepner 的评论应用于Lunguini 的回答：

import argparse, json                                                                                            
parser = argparse.ArgumentParser()                                                                               
parser.add_argument('-l', '--list', type=lambda a: json.loads('['+a.replace(" ",",")+']'), default="", help="List of values")                                              
args = parser.parse_args()                                                                                       
print(args.list)                                                                                                 

用法：

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

解决方案 13：

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

有用的链接 =>如何将 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变量按顺序包含参数。