作为选项传递列表的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 （取决于您希望用户界面的行为）选项。

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=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将准确知道该选项有多少值。
  • 不要在命令行中使用引号1
  • 不要使用type=list ，因为它会返回一个列表列表
  • 发生这种情况是因为在引用之下， argparse使用type的值来强制每个给定的参数为您选择的type ，而不是所有参数的聚合。
  • 您可以使用type=int （或其他）来获取整数列表（或其他）

    • 1：我的意思不是一般的..我的意思是使用引号将一个列表传递给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')
    链接地址: http://www.djcxy.com/p/61967.html

    上一篇: argparse option for passing a list as option

    下一篇: Conditional command line arguments in Python using argparse