用于传递列表作为选项的argparse选项

时间:2013-04-01 23:34:59

标签: python 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"

12 个答案:

答案 0 :(得分:606)

<强> TL; DR

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

<强> 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无法分辨出什么应该是位置参数,什么属于{{1} 1}};如果你有位置参数,那么nargs可能最终成为更好的选择。
    • 以上情况仅在action='append' nargs'*''+'时才会生效。如果您提供整数(例如'?'),那么将选项与4和位置参数混合将没有问题,因为nargs将准确知道该选项需要多少个值。
  • 不要在命令行 1
  • 上使用引号
  • 不要使用argparse,因为它会返回列表列表
    • 发生这种情况是因为幕后type=list使用argparse的值来强制每个给定的参数您所选择的type,而不是所有type的汇总参数。
    • 您可以使用type=int(或其他)获取整数列表(或其他)

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

答案 1 :(得分:54)

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

会正常工作。分隔符也可以是一个空格,虽然可以在参数值周围强制引用,如问题中的示例所示。

答案 2 :(得分:15)

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

答案 3 :(得分:4)

在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上的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']

答案 4 :(得分:4)

如果您打算使用多个参数进行单个切换,则使用nargs='+'。如果你的例子是&#39; -l&#39;实际上是整数:

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

答案 5 :(得分:4)

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

答案 6 :(得分:2)

也许是最简单的答案

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(" "))

答案 7 :(得分:1)

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

答案 8 :(得分:0)

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

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

然后,您可以使用@sam-masonthis question提出的解决方案,如下所示:

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

答案 9 :(得分:0)

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

有用的链接=> How to pass a Bash variable to 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]"

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

答案 10 :(得分:0)

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

答案 11 :(得分:0)

JSON 列表解决方案

通过命令行处理传递列表(也就是字典)的一个好方法是使用 json。这简化了 argparse 解析,代价是需要一个单独的步骤来解析 json。

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

示例用法

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