如何使用 argparse 将列表作为命令行参数传递？
Posted
技术标签:
【中文标题】如何使用 argparse 将列表作为命令行参数传递？【英文标题】：How can I pass a list as a command-line argument with argparse? 【发布时间】：2021-10-10 04:05:11 【问题描述】：我正在尝试将列表作为参数传递给命令行程序。是否有 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"
【问题讨论】：
【参考方案1】：简短回答
使用nargs 选项或action 选项的'append' 设置（取决于您希望用户界面的行为方式）。
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不是你想要的。
【讨论】：
字符串列表怎么样？这会将多个字符串参数（“wassup”、“something”和“else”）转换为如下所示的列表列表：[['w', 'a', 's', 's', 'u' , 'p'], ['s', 'o', 'm', 'e', 't', 'h', 'i', 'n', 'g'], ['e', ' l', 's', 'e']] @rd108 我明白了，我敢打赌你正在使用type=list 选项。不要用那个。这会将一个字符串变成一个列表，从而变成列表的列表。
@Dror 所有输入都假定为字符串，除非您将type 参数设置为其他对象。默认情况下，此方法返回一个字符串列表。
-- 可以拆分选项与位置参数。 prog --opt1 par1 ... -- posp1 posp2 ...
如果有位置参数可能不直观，因为 argparse 无法分辨什么应该是位置参数以及什么属于 nargs。 -- 有助于解决这个问题，如我之前评论中的示例所示。 IOW 用户提供 -- 后跟所有位置参数。【参考方案2】：
除了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')
【讨论】：
如何使用带有选项的 nargs？你能展示一个组合的例子吗？ 说我想让用户做出1个或多个选择，比如game.py --move=rock,paper?【参考方案3】：
我更喜欢传递我稍后在脚本中解析的分隔字符串。其原因是；该列表可以是任何类型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]
会正常工作。分隔符也可以是一个空格，但它会像问题中的示例一样在参数值周围强制使用引号。
或者您可以使用 Chepner 在 cmets 中建议的 lambda 类型：
parser.add_argument('-l', '--list', help='delimited list input',
type=lambda s: [int(item) for item in s.split(',')])
【讨论】：
您可以将type 参数设置为lambda s: [int(time) for item in s.split(',')]，而不是后处理args.list。
@chepner，是的，你说得完全正确，而且它会更 Pythonic - 只是一个小错字：int(time) 应该是 int(item)。我的示例是我通常所做的简化版本，我在其中检查许多其他事情，而不是简单的处理。但是为了简单地回答这个问题，我也觉得你的方式更优雅..
这个答案看起来是最pythonic的
@chepner 的评论是一些严肃的忍者技能 +1
lambda items: list(csv.reader([items]))[0] 和标准 csv 库是来自 @chepner 的评论的修改版本，适用于任何担心任意 CSV 输入的人（参考：answer 来自 @adamk）。跨度>
【参考方案4】：
在argparse的add_argument方法中使用nargs参数
我使用nargs='*' 作为 add_argument 参数。如果我没有传递任何显式参数，我专门使用nargs='*' 来选择默认值
包括一个代码sn-p作为例子：
示例：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 上的类型参数更改为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']
【讨论】：
@Py_minion 有没有办法使用列表作为参数，并将输出也作为列表？temp_args1.py -i [item5 ,item6, item7] 并以列表形式输出（而不是嵌套列表）
@Moondra 是的。很高兴你问。 ``` parser.add_argument('-o', '--options', action='store', dest='opt_list', type=str, nargs='*', default=sample_list, help="数据库字符串由空格分隔。示例：\ -o option1 option2, -o option3") ``` 这里的 'sample_list' 是具有默认选项的列表类型。例如：sample_list = [option4, option5]
@Py_minion 谢谢。今天晚些时候将对其进行测试。
我用过这个，这对于从参数传递创建列表非常有用。【参考方案5】：
如果您打算让单个开关采用多个参数，则使用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='lst', # store in 'lst'.
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(lst=[123, 234, 345, 456])
Namespace(lst=[456]) # Attention!
如果您多次指定相同的参数，默认操作 ('store') 会替换现有数据。
替代方法是使用append 操作：
a = argparse.ArgumentParser()
a.add_argument(
'-l', '--list', # either of this switches
type=int, # /parameters/ are ints
dest='lst', # store in 'lst'.
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(lst=[123, 234, 345, 456])
或者您可以编写自定义处理程序/操作来解析逗号分隔的值，以便您可以这样做
-l 123,234,345 -l 456
【讨论】：
【参考方案6】：在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]"
【讨论】：
请注意，如果需要传递字符串，此方法将要求他们在命令行中适当地引用它们。用户可能会发现这出乎意料。如果只解析整数就可以了。【参考方案7】：如果您有一个嵌套列表，其中内部列表具有不同的类型和长度，并且您希望保留该类型，例如，
[[1, 2], ["foo", "bar"], [3.14, "baz", 20]]
那么你可以使用@sam-mason到this 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]])
【讨论】：
【参考方案8】：我想处理传递多个列表、整数值和字符串。
有用的链接 => 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]"
输出 => ['my_string', '3', ['1', '2'], ['3', '4', '5']], my_args 变量按顺序包含参数。
【讨论】：
【参考方案9】：我认为最优雅的解决方案是将 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']
【讨论】：
您的意思是-l 在示例调用中吗？ -n 哪里来的？
另外，该解决方案在 Python 3.8.2 中对我不起作用。这是代码：parser.add_argument('-l', '--list', type = lambda s: re.split('[ ,;]', s))。这是输入：script.py -l abc xyz, abc\nxyz。最后，结果如下：script.py: error: unrecognized arguments: xyz, abcnxyz
根据 cmets 修复解决方案！【参考方案10】：
您可以将列表解析为字符串并使用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】：JSON 列表解决方案
使用 json 是通过命令行处理传递列表（也称为 dicts）的好方法。这简化了 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]
【讨论】：
【参考方案12】：请注意，如果您将 action='append' 与 default 参数一起传递，Argparse 将尝试附加到提供的默认值而不是替换默认值，您可能会也可能不会想到。
这是一个action='append example given in the Argparse Docs。
在这种情况下，一切都会按预期进行：
>> import argparse
>> parser = argparse.ArgumentParser()
>> parser.add_argument('--foo', action='append')
>> parser.parse_args('--foo 1 --foo 2'.split())
Out[2]: Namespace(foo=['1', '2'])
但是，如果您选择提供默认值，Argparse 的“附加”操作将尝试附加到提供的默认值，而不是替换默认值：
import argparse
REASONABLE_DEFAULTS = ['3', '4']
parser = argparse.ArgumentParser()
parser.add_argument('--foo', default=REASONABLE_DEFAULTS,action='append')
parser.parse_args('--foo 1 --foo 2'.split())
Out[6]: Namespace(foo=['3', '4', '1', '2'])
如果您期望使用 Argparse 来替换默认值——例如传入一个元组作为默认值，而不是一个列表——这可能会导致一些令人困惑的错误：
import argparse
REASONABLE_DEFAULTS = ('3', '4')
parser = argparse.ArgumentParser()
parser.add_argument('--foo', default=REASONABLE_DEFAULTS,action='append')
parser.parse_args('--foo 1 --foo 2'.split())
AttributeError: 'tuple' object has no attribute 'append'
有一个bug tracking this unexpected behavior，但由于它是从 2012 年开始的，因此不太可能得到解决。
【讨论】：
以上是关于如何使用 argparse 将列表作为命令行参数传递？的主要内容，如果未能解决你的问题，请参考以下文章
使用 argparser 将参数传递给入口点 python 脚本