关于python：argparse选项，用于传递列表作为选项


argparse option for passing a list as option

我正试图将列表作为参数传递给命令行程序。是否有一个argparse选项作为选项传递列表？

1
2
3
4
5
parser.add_argument('-l', '--list',
                      type=list, action='store',
                      dest='list',
                      help='<Required> Set flag',
                      required=True)

脚本调用如下

1
python test.py -l"265340 268738 270774 270817"

号

DR

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

纳尔格斯

1
2
3
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='*'取0个或多个参数。

追加

1
2
3
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一起使用。曾经。

让我们更详细地了解一下人们可能尝试的一些不同的方法，以及最终的结果。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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)

以下是您可以预期的输出：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
$ 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或其他方法来获取一个int(或其他方法)列表。

1：我不是说一般的……我的意思是用引号把清单传给argparse并不是你想要的。

相关讨论

我更喜欢传递一个分隔字符串，稍后在脚本中分析它。原因是：列表可以是任何类型的int或str，有时使用nargs，如果有多个可选参数和位置参数，我会遇到问题。

1
2
3
4
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(',')]

然后，

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

或者，

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

会很好的。分隔符也可以是一个空格，尽管它会在参数值周围强制使用引号，如问题中的示例中所示。

相关讨论

除nargs外，如果事先知道清单，您可能还想使用choices：

1
2
3
4
5
6
7
8
>>> 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')

在add_argument()中，type只是一个可调用对象，它接收字符串并返回选项值。

1
2
3
4
5
6
7
8
9
10
11
12
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")

这将允许：

1
$ ./tool --list"[1,2,3,4]"
相关讨论

如果要使单个开关接受多个参数，则使用nargs='+'。如果您的示例"-l"实际采用整数：

1
2
3
4
5
6
7
8
9
10
11
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(' '))

生产

1
2
Namespace(list=[123, 234, 345, 456])
Namespace(list=[456])  # Attention!

如果多次指定同一个参数，则默认操作('store'将替换现有数据。

另一种方法是使用append动作：

1
2
3
4
5
6
7
8
9
10
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(' '))

产生

1
Namespace(list=[123, 234, 345, 456])

或者您可以编写一个自定义的处理程序/操作来解析逗号分隔的值，这样您就可以

1
-l 123,234,345 -l 456

也许是最简单的答案

1
2
3
4
5
6
7
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-l","--tolist", help="input to list", action="store_true")
parser.add_argument("newlist", type=str, help="generate a list")
args = parser.parse_args()
if args.tolist:
    print(args.newlist.split(""))
相关讨论

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

我将nargs='用作add_参数。如果不传递任何显式参数，我特别使用nargs=''来选择默认值。

例如，包括一个代码段：

示例：temp_args1.py

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

1
2
3
4
5
6
7
8
9
10
11
12
    #!/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上的类型参数。将参数添加到int

执行结果：

1
2
3
4
5
6
7
8
    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']
相关讨论