首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >使用以破折号开头的可选位置参数的‘'argparse’

问使用以破折号开头的可选位置参数的‘'argparse’
EN

Stack Overflow用户
提问于 2017-11-09 15:21:33
回答 2查看 4.5K关注 0票数 8

我们正在尝试在我们正在使用的命令行工具上构建一个包装脚本。我们希望根据包装脚本中的选项设置一些工具参数。我们还希望能够在命令行中直接将本地参数传递给命令行工具。

以下是我们得出的结论:

代码语言:javascript
复制
import argparse

parser = argparse.ArgumentParser()

parser.add_argument('positional')
parser.add_argument('-f', '--foo', action='store_true')
parser.add_argument('-b', '--bar', action='store_true')

parser.add_argument('native_arg', nargs='*')

args = parser.parse_args()
print (args)

positional是强制性的。根据选项-f和-b,我们将在工具调用中添加一些额外的选项。之后留下的任何内容(如果有的话)都应该作为本机工具参数来处理,并直接交给工具。使用-h调用我们的脚本会产生以下用法:

代码语言:javascript
复制
usage: test.py [-h] [-f] [-b] positional [native_arg [native_arg ...]]

诀窍是,这些本机参数本身就是工具的选项,包含前导破折号,例如-native0和-native1。我们已经知道了用双破折号来阻止more解析寻找更多选项的技巧。以下呼吁:

代码语言:javascript
复制
./test.py pos -- -native0 -native1

生成预期的解析参数:

代码语言:javascript
复制
Namespace(bar=False, foo=False, native_arg=['-native0', '-native1'], positional='pos')

但是,尝试在第一个位置参数之后添加一个选项是行不通的。更具体地说,以下呼吁:

代码语言:javascript
复制
./test.py pos --foo -- -native0 -native1

产生以下输出:

代码语言:javascript
复制
usage: [...shortened...]
test.py: error: unrecognized arguments: -- -native0 -native1

将可选论点放在立场前面:

代码语言:javascript
复制
./test.py --foo pos -- -native0 -native1

如下所示,似乎是可行的:

代码语言:javascript
复制
Namespace(bar=False, foo=True, native_arg=['-native0', '-native1'], positional='pos')

更奇怪的是,将nargs用于native_arg的值更改为'+'在所有上述情况下都有效(当然,至少需要一个native_arg )。

我们是在Python代码中做错了什么,还是这是某种Are解析错误?

EN

回答 2

Stack Overflow用户

发布于 2017-11-09 15:38:27

当您将非必需的位置参数与可选参数混合时,argparse确实遇到了困难(请参阅https://stackoverflow.com/a/47208725/1399279以获取bug报告中的详细信息)。我不是提出解决这个问题的办法,而是提出另一种办法。

您应该检查parse_known_args方法,该方法是为您描述的情况创建的(即将选项传递给包装工具)。

代码语言:javascript
复制
In [1]: import argparse

In [2]: parser = argparse.ArgumentParser()

In [3]: parser.add_argument('positional')

In [4]: parser.add_argument('-f', '--foo', action='store_true')

In [5]: parser.add_argument('-b', '--bar', action='store_true')

In [6]: parser.parse_known_args(['pos', '--foo', '-native0', '-native1'])
Out[6]: (Namespace(bar=False, foo=True, positional='pos'), ['-native0', '-native1'])

与parse_args不同,parse_known_args的输出是一个双元素元组.第一个元素是您希望从Namespace获得的parse_args实例,它包含调用add_argument所定义的所有属性。第二个元素是解析器不知道的所有参数的列表。

我个人更喜欢这种方法,因为用户不需要记住关于如何调用程序或哪个选项顺序不会导致错误的任何技巧。

票数 7
EN

Stack Overflow用户

发布于 2017-11-09 18:04:55

这是一个已知的问题(https://bugs.python.org/issue15112,a解析: nargs='*‘位置参数如果前面有选项和另一个位置,则不接受任何项)

语法分析交替处理位置和选项。在处理位置时,它会尝试处理输入字符串所需的数量。但是?或*位置满足于[],这是一个空字符串列表。另一方面,+至少需要一个字符串

代码语言:javascript
复制
./test.py pos --foo -- -native0 -native1

解析器向positional提供'pos‘,向native-arg提供[]。然后它把'--foo‘交给它的可选对象。positionals已经没有剩下的字符串了,所以它会引发错误。

输入字符串的分配是使用样式化的regex字符串匹配形式完成的。想象一下,匹配一个看起来像AA?的模式。

要纠正这一点,解析器必须向前看,并延迟处理native-arg。我们建议了补丁,但它们不在生产中。

@SethMMorton关于使用parse_known_args的建议是一个不错的建议。

早期的解析器(例如Opt解译)处理所有标记的参数,但返回其余的位置,作为一个未区分的列表。应该由用户来拆分这个列表。argparse增加了命名和解析positionals的能力,但是该算法在固定的nargs中工作得最好,并且由于变量nargs太多而变得脆弱。

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/47205477

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档