Question

我正在使用argparse并为我的程序设置了子命令。我创建了子解析器来定义这些子命令。我有一些管理命令，不应该在帮助屏幕中显示给用户。我知道我们可以隐藏子命令的参数，但我不知道如何隐藏在命令列表中显示的一些子命令。

这是我的代码段，

parser = argparse.ArgumentParser(prog='myProg',
                                    description=desc,
                                   formatter_class=argparse.RawDescriptionHelpFormatter)

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


myProg_query.add_subparser(subparsers)
myProg_update.add_subparser(subparsers)
myProg_configure.add_subparser(subparsers)
myProg_result.add_subparser(subparsers)

当我运行帮助命令时，我得到了这个

%> myProg --help
usage: myProg [-h] 

positional arguments:
{query,update,configure,result}
query               query information
update              Update 
configure           Configure system
result              tabulate the result

从帮助输出中，我希望只向用户显示“查询”和“结果”。我试图在add_subparser方法中使用argparse.SUPPRESS，但它会隐藏所有子命令。无论我搜索什么，只谈到隐藏每个子命令的个别参数，而不是隐藏子命令。我可能必须创建一个自定义格式化程序方法，但想检查是否有任何其他方法来实现此目的。

Answer 1

metavar可能会解决问题：

import argparse
parser = argparse.ArgumentParser()
sp = parser.add_subparsers(metavar='{cmd1,cmd2}')
sp1 = sp.add_parser('cmd1')
sp2 = sp.add_parser('cmd2')
sp3 = sp.add_parser('cmd3')
parser.parse_args()

这个cmd3没有出现在用法或帮助中。但它确实出现在错误消息

中

错误：参数{cmd1，cmd2}：无效选择：'cmd'（从'cmd1'，'cmd2'，'cmd3'中选择）

您可能已经发现help=SUPPRESS的这种用法。但它需要自定义用法（以及可能的描述）参数：

import argparse
parser = argparse.ArgumentParser(usage='%(prog)s [-h] {cmd1,cmd2}')
sp = parser.add_subparsers(help=argparse.SUPPRESS)
sp1 = sp.add_parser('cmd1')
sp2 = sp.add_parser('cmd2')
sp3 = sp.add_parser('cmd3')
parser.parse_args()

对于主解析器，subparsers看起来像位置参数的choices。我可以说，没有办法选择性地压制choices。

有了这个级别的问题，检查argparse.py代码本身可能比文档更有帮助。在这种情况下，我查看了class _SubParsersAction(Action)的代码。如果你想自定义格式化程序，这是双重的。现有的替代格式化程序只修改了深埋在类中的一两种方法。

此问题已作为错误问题引发，http://bugs.python.org/issue22848。

有一个补丁可以根据help=SUPPRESS修改各个子分析器的选项显示。但我推荐metavar解决方案，至少目前是这样。还有其他建议的补丁用于处理choices。

Answer 2

看起来我找到了这个问题的解决方案，没有任何argparse补丁。修改'metavar'就足够了，不要为某个subparser设置'help'。

import argparse

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(title='commands', metavar='{command}')

command = subparsers.add_parser("command",
                                help='command help.',
                                description='command description.')
suppress_command = subparsers.add_parser("suppress_command",
                                         help=argparse.SUPPRESS,
                                         description='suppress command.')
hidden_command = subparsers.add_parser("hidden_command",
                                       description='Hidden command.')

这导致

[root@localhost ~]# parser -h
usage: parser [-h] {command} ...

optional arguments:
-h, --help        print help message and exit

commands:
{command}
    command           command help.
    suppress_command  ==SUPPRESS==

[root@localhost ~]# parser hidden_command -h
usage: parser hidden_command [-h]

Hidden command.

optional arguments:
-h, --help  show this help message and exit

使用argparse隐藏选定的子命令

2 个答案: