python – 使用argparse隐藏选定的子命令

发布时间：2020-12-16 23:44:10 所属栏目：Python 来源：网络整理

导读：我正在使用argparse并为我的程序设置了子命令.我创建了子解析器来定义这些子命令.我有一些管理命令,不应该在帮助屏幕中显示给用户.我知道我们可以隐藏子命令的参数,但我不知道如何隐藏在命令列表中显示的一些子命令. 这是我的代码片段, parser = argparse.Ar

我正在使用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)

当我运行help命令时,我得到了这个

%> 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,但它会隐藏所有子命令.无论我搜索什么,只谈到隐藏每个子命令的各个参数,而不是隐藏子命令.我可能必须创建一个自定义格式化程序方法,但想检查是否有任何其他方法来实现此目的.

解决方法

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不会出现在用法或帮助中.但它确实出现在错误消息中

error: argument {cmd1,cmd2}: invalid choice: ‘cmd’ (choose from ‘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看起来像位置参数的选择.我可以说,最好不要选择性地抑制选择.

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

此问题已作为错误问题提出,http://bugs.python.org/issue22848.

有一个补丁可以修改基于help = SUPPRESS的选项显示单个子分析器.但我推荐metavar解决方案,至少目前是这样.还有其他提议的补丁来处理选择.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!