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

TL; DR

使用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=list情况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它将确切知道期望该选项有多少个值。
• 不要在命令行¹上使用引号
• 不要使用type=list，因为它会返回列表列表
  • 发生这种情况的原因是，在后台argparse使用的值type来强制您选择的每个给定给定参数type，而不是所有参数的总和。
  • 您可以使用type=int（或其他任何方式）获取一个整数列表（或其他任何方式）

¹：我的意思不是一般。.我的意思不是用引号将列表传递给argparse您。

我更喜欢传递一个定界字符串，稍后在脚本中对其进行解析。原因是：该列表可以是任何类型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]

会很好的工作。分隔符也可以是空格，尽管会像问题中的示例一样在参数值周围加引号。

除之外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')

在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上的type参数更改为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='list',     # store in 'list'.
    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(list=[123, 234, 345, 456])
Namespace(list=[456])  # Attention!

如果您多次指定相同的参数，则默认操作（'store'）将替换现有数据。

替代方法是使用append操作：

a = argparse.ArgumentParser()
a.add_argument(
    '-l', '--list',  # either of this switches
    type=int,        # /parameters/ are ints
    dest='list',     # store in 'list'.
    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(list=[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]]

那么您可以使用@ 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]])

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

有用的链接=> 如何将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函数传递给“类型”，如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']