Python ArgParse Subparsers и ссылки на правильную функцию
Я создаю небольшой скрипт Python для управления различными классами серверов (FTP, HTTP, SSH и т. д.)
на каждом типе сервера мы можем выполнять различные типы действий (развертывание, настройка, проверка и т. д.)
у меня есть основания Server
класс, затем отдельный класс для каждого типа сервера, который наследует от этого:
class Server:
...
def check():
...
class HTTPServer(Server):
def check():
super(HTTPServer, self).check()
...
class FTPServer(Server):
def check():
super(FTPServer, self).check()
...
пример командной строки может быть:
my_program deploy http
из командной строки Мне нужны два обязательных аргумента являются:
- операция
- тип сервера для создания/управления
ранее я использовал argparse
и store
операция и использование dict
для соответствия опции командной строки фактическому имени класса и функции. Например:
types_of_servers = {
'http': 'HTTPServer',
'ftp': 'FTPServer',
...
}
valid_operations = {
'check': 'check',
'build': 'build',
'deploy': 'deploy',
'configure': 'configure',
'verify': 'verify',
}
(в моем фактическом коде valid_operations не было довольно наивным отображением 1:1.)
а затем, используя довольно ужасный код, чтобы создать правильный тип объекта, и вызов правильный класс.
тогда я решил использовать argparse это subparsers
функция, чтобы сделать это вместо этого. Поэтому я сделал каждую операцию (проверка, сборка, развертывание и т. д.) a subparser.
обычно я могу связать каждую подкоманду с определенной функцией и вызвать ее. Однако я не хочу просто называть generic check()
функция-мне нужно создать правильный тип объекта первый, а затем вызовите соответствующую функцию внутри этого объект.
есть ли хороший, или питонический способ сделать это? Предпочтительно тот, который не включает в себя много жесткого кодирования или плохо спроектированных циклов if/else?
3 ответов
Если вы настроены на использование subparser для каждой команды, я бы сделал что-то вроде этого. Используйте поддержку типов argparse для вызова функции, которая ищет класс, который вы хотите создать, и возвращает его.
затем вызовите метод на этом экземпляре динамически с помощью getattr ()
import argparse
class Server:
def check(self):
return self.__class__.__name__
class FooServer(Server):
pass
class BarServer(Server):
pass
def get_server(server):
try:
klass = globals()[server.capitalize()+'Server']
if not issubclass(klass, Server):
raise KeyError
return klass()
except KeyError:
raise argparse.ArgumentTypeError("%s is not a valid server." % server)
if __name__ == '__main__':
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest='command')
check = subparsers.add_parser('check')
check.add_argument('server', type=get_server)
args = parser.parse_args()
print getattr(args.server, args.command)()
вывод выглядит примерно так:
$ python ./a.py check foo
FooServer
$ python ./a.py check bar
BarServer
$ python ./a.py check baz
usage: a.py check [-h] server
a.py check: error: argument server: baz is not a valid server.
вы можете просто использовать сами объекты в dict.
#!/usr/bin/python
class Server:
def __init__(self):
pass
def identify(self):
print self.__class__.__name__
def check(self):
raise SomeErrorBecauseThisIsAbstract
class HttpServer(Server):
def check(self, args):
if self.verify_http_things():
return True
else:
raise SomeErrorBecauseTheCheckFailed
pass
class FtpServer(Server):
def check(self, args):
if self.verify_ftp_things():
return True
else:
raise SomeErrorBecauseTheCheckFailed
pass
if __name__ == '__main__':
# Hopefully this edit will make my intent clear:
import argparse
parser = argparse.ArgumentParser(description='Process some server commands')
parser.add_argument('-c', dest='command')
parser.add_argument('-t', dest='server_type')
args = parser.parse_args()
servers = {
'http': HttpServer,
'ftp': FtpServer
}
try:
o = servers[args.server_type]()
o.__call__(args.command)
except Exception, e:
print e
Это должно работать (но ручное отображение было бы более прямым, на мой взгляд):
import argparse
class Proxy:
def __getattr__(thing):
def caller (type):
if type:
server_object = # get instance of server with right type
return getattr(server_object, thing)()
return caller
parser = argparse.ArgumentParser()
entry_parser.add_argument('--server_type', dest='server_type', required=True,choices=['http', 'ftp', 'ssh'],)
subparser = parser.add_subparsers(dest='operation')
for operation in ['check', 'build', 'deploy', 'configure', 'verify']:
entry_parser = subparser.add_parser(operation)
entry_parser.set_defaults(func=getattr(Proxy, command))
options = parser.parse_args()
# this will call proxy function caller with type argument
options.func(options.server_type)