带有可选子命令的 argparse 未按预期工作

Question

使用python 3.9.5版本我遇到了以下代码sn-p的问题：

import argparse


parser = argparse.ArgumentParser()

subparsers = parser.add_subparsers(required=False)
sub_parser = subparsers.add_parser("sub")

parser.add_argument("global-argument")

args = parser.parse_args()

运行不带参数的 python 示例，会导致以下错误消息：

$ python3 main.py
usage: main.py [-h] {sub} ... global-argument
main.py: error: the following arguments are required: global-argument

错误信息显示只有全局参数是必需的，子命令是可选的。

但是使用 global 参数运行 python 示例，会导致以下错误消息：

$ python3 main.py global
usage: main.py [-h] {sub} ... global-argument
main.py: error: invalid choice: 'global' (choose from 'sub')

所以如果没有子命令（应该是可选的）就不可能提供全局参数？

Answer 1

致parser。 subparsers 是 positional 参数，global-argument 也是。 positionals 按照定义的顺序进行解析。但是由于解析是在遇到时传递给子解析器，而不是传回主解析器，所以在任何情况下都可以处理“全局参数”。

optional 可以在之后为 parser 定义，但这是因为 optionals 的处理顺序是为了让用户提供它们。

致parser。 subparsers 只是positional 的一种特殊类型，它将解析任务传递给另一个解析器。 sub_parser 在被调用时处理剩余的字符串，并返回一个namespace，它被合并到主namespace 中。 parser 不会继续解析。

所以主解析器的参数都应该首先定义，并首先在命令行中使用。 subparser(s) 和参数在此之后定义和使用。

最初subparsers 不是可选的，这对于positionals 来说是正常的（没有特殊的nargs）。但是，作为更改“必需”参数的测试和标记方式的意外副作用，subparsers 默认情况下变为不需要的。一段时间以来，我们一直在处理由此带来的后果。

我投票最多的答案与此有关； Argparse with required subparser

包含dest 也是一个好主意，既可以更好地识别使用了哪个子解析器，又可以防止错误消息中出现问题。

subparsers = parser.add_subparsers(dest='cmd')