将元组作为命令行参数传递

Posted 2023-03-07

【中文标题】将元组作为命令行参数传递

【英文标题】：Passing a tuple as command line argument

【发布时间】：2016-02-07 10:47:42

【问题描述】：

我的要求是传递一个元组作为命令行参数，如

--data (1,2,3,4)

我尝试使用argparse 模块，但如果我这样通过，它会接收为字符串'(1,2,3,4)'。我尝试将type=tuple 提供给argparse.add_argument，但在这里没有用。

我是否必须添加一个新的类型类并将其传递给add_argument 的类型参数？

更新

我根据答案尝试了ast.literal_eval。感谢那。但它在结果中给出了空格，如下所示。

(1,2,3,4)
<type 'str'>
(1, 2, 3, 4)
<type 'tuple'>

【问题讨论】：

每个重复项，ast.literal_eval 将是一个合适的 type 参数

根据argparse 文档，type 必须是一个函数 (callable)，它接受一个简单的字符串并将其转换为所需的对象。 tuple('(1,2)') 接受一个字符串，但拆分为字符，例如('(', '1', ',', '2', ')')。还要小心你的用户给你--data (1, 2, 3,4)。外壳在空白处分裂。

重复链接与解析'(1,2)' 之类的字符串有关，但没有解决问题的argparse 方面。

***.com/a/18003926/901925 建议使用json.loads 来解析看起来像字典和列表（但不是元组）的字符串。

为什么不将参数存储为字符串并将其传递给eval() 以将其转换为元组。

【参考方案1】：

将data参数的nargs设置为nargs="+"（意思是一个或多个）并键入int，然后你可以在命令行中设置这样的参数：

--data 1 2 3 4

args.data 现在将是[1, 2, 3, 4] 的列表。

如果你必须有一个元组，你可以这样做：

my_tuple = tuple(args.data)

把它们放在一起：

parser = argparse.ArgumentParser()
parser.add_argument('--data', nargs='+', type=int)
args = parser.parse_args()
my_tuple = tuple(args.data)

【讨论】：

对不起，这不是我的要求。请看我的问题一次。我知道这种方法。

然后更改您的要求 ;) 用户不希望必须以特定方式格式化他们的参数。但是，使用多个参数是正常的。

阿拉斯泰尔，你是对的。最后我改变了我的要求:-)。

最重要的是，就我而言，您可以使用 nargs="+" 或 nargs= 结合 action="append" 指定列表列表，从而允许多次出现--data 在参数列表中。甜！

【参考方案2】：

如果你想扩展它，而不是处理语法树，并在参数中提供元组转换，你需要一个自定义的 argparse 类型。 （我需要这个，因为我的解析器在一个包中，我不想要求我的用户都写my_tuple = tuple(args.data)。使用参数类型，您还可以像原始问题一样接收带括号的字符串。另外，我不会包含nargs，因为这会将您的自定义类型输出包装到一个列表中，这基本上违背了您的自定义类型的目的。我映射了一个浮点数，因为我的输入类似于“0.9, 0.99”，但你的 int 有效一样的：

def tuple_type(strings):
    strings = strings.replace("(", "").replace(")", "")
    mapped_int = map(int, strings.split(","))
    return tuple(mapped_int)

parser = argparse.ArgumentParser()
parser.add_argument('--data', type=tuple_type)
args = parser.parse_args()

这样你可以发送--data "(1,2,3,4)"或--data "1,2,3,4"

【参考方案3】：

我也有同样的要求。在标准包中找不到。所以，滚动这个。蟒蛇 3 倍。放入简单的 argv 解析器，一次调用一个 arg：

var

默认传递，类型正确。

argval

是找到命令行字符串。逗号分隔，没有空格。即 1、2、3 或一、二、三。

适用于 bash shell，可能需要引号，其他 shell 的其他调整，操作系统。 同样的技术适用于非列表类型。此版本基于 var[0] 创建同构列表或元组。

示例：

./foo.py   --mytuple 1,2,3,4,5

代码：

def chk_arg( var, argstr, dbg=False): 
    ### loop on sys.argv here .....
    # if list/tuple type, use list comprehension
    # converts csv list to list or tuple 'type(var)' of 'type(var[0])' items. 
    if type(var) is list or type(var) is tuple:  
        val = type(var)([type(var[0])(i) for i in argval.split(',')])