我正在将 Bash shell 安装程序实用程序转换为 Python 2.7,并且需要实现复杂的 CLI,以便能够解析数十个参数(可能最多约 150 个)。这些是 Puppet 类变量的名称以及十几个通用部署选项(在 shell 版本中可用)。
然而,在我开始添加更多变量后,我面临着几个挑战:
1. 我需要将参数分组到单独的字典中,以便部署选项与 Puppet 变量分开。如果它们被扔到同一个桶中,那么我将不得不编写一些逻辑来对它们进行排序,可能会重命名参数,然后字典合并将不再是微不足道的。
2. 可能存在名称相同但属于不同 Puppet 类的变量,因此我认为子命令可以让我过滤内容并避免名称冲突。
目前我已经通过简单地添加多个解析器来实现参数解析:
parser = argparse.ArgumentParser(description='deployment parameters.')
env_select = parser.add_argument_group(None, 'Environment selection')
env_select.add_argument('-c', '--client_id', help='Client name to use.')
env_select.add_argument('-e', '--environment', help='Environment name to use.')
setup_type = parser.add_argument_group(None, 'What kind of setup should be done:')
setup_type.add_argument('-i', '--install', choices=ANSWERS, metavar='', action=StoreBool, help='Yy/Nn Do normal install and configuration')
# MORE setup options
...
args, unk = parser.parse_known_args()
config['deploy_cfg'].update(args.__dict__)
pup_class1_parser = argparse.ArgumentParser(description=None)
pup_class1 = pup_class1_parser.add_argument_group(None, 'Puppet variables')
pup_class1.add_argument('--ad_domain', help='AD/LDAP domain name.')
pup_class1.add_argument('--ad_host', help='AD/LDAP server name.')
# Rest of the parameters
args, unk = pup_class1_parser.parse_known_args()
config['pup_class1'] = dict({})
config['pup_class1'].update(args.__dict__)
# Same for class2, class3 and so on.
这种方法的问题是它不能解决问题 2。此外,第一个解析器使用“-h”选项,其余参数不会显示在帮助中。
我尝试过使用选择作为答案的示例 https://stackoverflow.com/questions/10448200/how-to-parse-multiple-sub-commands-using-python-argparse但我无法同时使用这两个命令。
## This function takes the 'extra' attribute from global namespace and re-parses it to create separate namespaces for all other chained commands.
def parse_extra (parser, namespace):
namespaces = []
extra = namespace.extra
while extra:
n = parser.parse_args(extra)
extra = n.extra
namespaces.append(n)
return namespaces
pp = pprint.PrettyPrinter(indent=4)
argparser=argparse.ArgumentParser()
subparsers = argparser.add_subparsers(help='sub-command help', dest='subparser_name')
parser_a = subparsers.add_parser('command_a', help = "command_a help")
## Setup options for parser_a
parser_a.add_argument('--opt_a1', help='option a1')
parser_a.add_argument('--opt_a2', help='option a2')
parser_b = subparsers.add_parser('command_b', help = "command_b help")
## Setup options for parser_a
parser_b.add_argument('--opt_b1', help='option b1')
parser_b.add_argument('--opt_b2', help='option b2')
## Add nargs="*" for zero or more other commands
argparser.add_argument('extra', nargs = "*", help = 'Other commands')
namespace = argparser.parse_args()
pp.pprint(namespace)
extra_namespaces = parse_extra( argparser, namespace )
pp.pprint(extra_namespaces)
结果我:
$ python argtest.py command_b --opt_b1 b1 --opt_b2 b2 command_a --opt_a1 a1
usage: argtest.py [-h] {command_a,command_b} ... [extra [extra ...]]
argtest.py: error: unrecognized arguments: command_a --opt_a1 a1
当我尝试用两个子解析器定义父解析器时,结果相同。
问题
- 我可以以某种方式使用 parser.add_argument_group 进行参数解析,还是仅用于帮助打印中的分组?它将解决问题 1,而不会丢失帮助副作用。将其传递为
parse_known_args(namespace=argument_group)
(如果我正确地回忆起我的实验)获取所有变量(没关系),但也获取结果字典中的所有 Python 对象内容(这对 hieradata YAML 不利)
- 我在第二个示例中缺少什么以允许使用多个子命令?或者 argparse 不可能做到这一点?
- 对命令行变量进行分组还有其他建议吗?我查看过 Click,但没有发现对于我的任务来说比标准 argparse 有任何优势。
注意:我是系统管理员,不是程序员,所以请温柔地对待我的非对象风格编码。 :)
谢谢
RESOLVED参数分组通过建议的答案解决hpaulj https://stackoverflow.com/users/901925/hpaulj.
import argparse
import pprint
parser = argparse.ArgumentParser()
group_list = ['group1', 'group2']
group1 = parser.add_argument_group('group1')
group1.add_argument('--test11', help="test11")
group1.add_argument('--test12', help="test12")
group2 = parser.add_argument_group('group2')
group2.add_argument('--test21', help="test21")
group2.add_argument('--test22', help="test22")
args = parser.parse_args()
pp = pprint.PrettyPrinter(indent=4)
d = dict({})
for group in parser._action_groups:
if group.title in group_list:
d[group.title]={a.dest:getattr(args,a.dest,None) for a in group._group_actions}
print "Parsed arguments"
pp.pprint(d)
这得到了我对第一个问题的期望结果。直到我有多个同名参数。解决方案可能看起来很难看,但至少它按预期工作。
python argtest4.py --test22 aa --test11 yy11 --test21 aaa21
Parsed arguments
{ 'group1': { 'test11': 'yy11', 'test12': None},
'group2': { 'test21': 'aaa21', 'test22': 'aa'}}