我正在尝试将列表作为参数传递给命令行程序。有没有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"

最佳答案

简短回答

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

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

关于python - 如何使用 argparse 将列表作为命令行参数传递？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/15753701/