为 Subparser 子命令正确使用 Argparse

Question

如何让 argparse 子解析器只解析它自己的参数？似乎在子解析器上调用parse_known_args 会解析所有父级的参数。

鉴于此简化版本，以及输入 foo bar：

main_parser = argparse.ArgumentParser()
main_parser.add_argument("command")
args, subc_args = main_parser.parse_known_args()
print("main parser = {}".format(args))

sub_parser = main_parser.add_subparsers()
sub_command_parser = sub_parser.add_parser("sub_command")
sub_command_parser.add_argument("hostname")

sub_args = sub_command_parser.parse_known_args()
print("sub parser = {}".format(sub_args))

第一次打印返回我所期望的：

main parser = Namespace(command='foo')

而倒数第二行返回相同的内容，只是将额外的参数作为“未知”列表的一部分：

sub parser = (Namespace(hostname='foo'), ['bar'])

我怎样才能得到像sub_command_parser.parse_known_args() 这样的东西来忽略它之前给出的参数？我需要sub_args 只包含那些用sub_command_parser.add_argument() 添加的参数。我可以像这样直接打电话给他们； sub_args[1]，但这似乎很老套且不可靠。

背景：我将一个包拆分为一个主文件作为处理顶级参数的入口点，以及执行实际工作的模块。我想在主文件中添加顶级“主解析器”，并在模块中添加子解析器。

Answer 1

这有帮助，谢谢@hpaulj。看起来没有一个很好的方法来处理带有 argparse 的子命令。遇到此问题的人的完整工作示例是：

# Main file
#
main_parser = argparse.ArgumentParser()
main_parser.add_argument("command")
args, subc_args = main_parser.parse_known_args()
print("main parser = {}".format(args.command))

# Subcommand file
#
sub_parser = main_parser.add_subparsers()
sub_command_parser = sub_parser.add_parser("sub_command")
sub_command_parser.add_argument("hostname")

sub_args, unknown_args = sub_command_parser.parse_known_args(subc_args)
print("sub parser = {}".format(sub_args.hostname))

请注意，在调用类时（或者您已经在子命令文件中实现了子解析器创建），您还需要提供 subc_args 作为可选参数。

编辑：在主解析器中指定 add_help=False 可以解决这个问题 :)

Answer 2

普通子命令用法，都在一个文件中：

main_parser = argparse.ArgumentParser()
sub_parser = main_parser.add_subparsers(dest='command')
sub_command_parser = sub_parser.add_parser("sub_command")
sub_command_parser.add_argument("hostname")

args = main_parser.parse_args()
print(args)
args.command   # name of the subcommand
args.hostname   # value from subcommand argument

这会自动将剩余的字符串传递给子解析器，在command 中命名。这种用法应该在 Python 文档中明确。

如果您要在文件之间拆分解析器，并分别调用它们，请跳过add_subparsers 位。它对你没有任何作用。

# Main file
#
parser = argparse.ArgumentParser()
parser.add_argument("command")
args, subc_args = parser.parse_known_args()
print("main parser = {}".format(args.command))

# Subcommand file
#
parser = argparse.ArgumentParser()
parser.add_argument("hostname")
sub_args, unknown_args = parser.parse_known_args(subc_args)
print("sub parser = {}".format(sub_args.hostname))