Я конвертирую утилиту установки оболочки Bash в Python 2.7, и мне нужно реализовать сложный интерфейс командной строки, чтобы я мог анализировать десятки параметров (потенциально до ~ 150). Это имена переменных класса Puppet в дополнение к дюжине общих параметров развертывания, которые доступны в версии оболочки.
Однако после того, как я начал добавлять больше переменных, я столкнулся с несколькими проблемами: 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», а остальные параметры не отображаются в справке.
Я попытался использовать пример, выбранный в качестве ответа но я не смог использовать обе команды одновременно.
## 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 в результирующем dict (это плохо для hieradata YAML) - Чего мне не хватает во втором примере, чтобы разрешить использование нескольких подкоманд? Или это невозможно с argparse?
- Любое другое предложение по группировке переменных командной строки? Я посмотрел на Click, но не нашел никаких преимуществ перед стандартным argparse для своей задачи.
Примечание. Я системный администратор, а не программист, поэтому будьте осторожны со мной за кодирование в необъектном стиле. :)
Спасибо
РЕШЕНО Группировка аргументов решена с помощью ответа, предложенного 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)
Это дает мне желаемый результат для проблемы №1. пока у меня не будет нескольких параметров с одинаковым именем. Решение может выглядеть некрасиво, но, по крайней мере, оно работает так, как ожидалось.
python argtest4.py --test22 aa --test11 yy11 --test21 aaa21
Parsed arguments
{ 'group1': { 'test11': 'yy11', 'test12': None},
'group2': { 'test21': 'aaa21', 'test22': 'aa'}}
