def parse(parser, argv=None, settings_key='settings', no_args_func=None):
"""
parser cliez app
:param argparse.ArgumentParser parser: an instance
of argparse.ArgumentParser
:param argv: argument list,default is `sys.argv`
:type argv: list or tuple
:param str settings: settings option name,
default is settings.
:param object no_args_func: a callable object.if no sub-parser matched,
parser will call it.
:return: an instance of `cliez.component.Component` or its subclass
"""
argv = argv or sys.argv
commands = command_list()
if type(argv) not in [list, tuple]:
raise TypeError("argv only can be list or tuple")
# match sub-parser
if len(argv) >= 2 and argv[1] in commands:
sub_parsers = parser.add_subparsers()
class_name = argv[1].capitalize() + 'Component'
from cliez.conf import (COMPONENT_ROOT, LOGGING_CONFIG, EPILOG,
GENERAL_ARGUMENTS)
sys.path.insert(0, os.path.dirname(COMPONENT_ROOT))
mod = importlib.import_module('{}.components.{}'.format(
os.path.basename(COMPONENT_ROOT), argv[1]))
# dynamic load component
klass = getattr(mod, class_name)
sub_parser = append_arguments(klass, sub_parsers, EPILOG,
GENERAL_ARGUMENTS)
options = parser.parse_args(argv[1:])
settings = Settings.bind(getattr(
options, settings_key)) if settings_key and hasattr(
options, settings_key) else None
obj = klass(parser, sub_parser, options, settings)
# init logger
logger_level = logging.CRITICAL
if hasattr(options, 'verbose'):
if options.verbose == 1:
logger_level = logging.ERROR
elif options.verbose == 2:
logger_level = logging.WARNING
elif options.verbose == 3:
logger_level = logging.INFO
obj.logger.setLevel(logging.INFO)
pass
if hasattr(options, 'debug') and options.debug:
logger_level = logging.DEBUG
# http lib use a strange way to logging
try:
import http.client as http_client
http_client.HTTPConnection.debuglevel = 1
except Exception:
# do nothing
pass
pass
loggers = LOGGING_CONFIG['loggers']
for k, v in loggers.items():
v.setdefault('level', logger_level)
if logger_level in [logging.INFO, logging.DEBUG]:
v['handlers'] = ['stdout']
pass
logging_config.dictConfig(LOGGING_CONFIG)
# this may not necessary
# obj.logger.setLevel(logger_level)
obj.run(options)
# return object to make unit test easy
return obj
# print all sub commands when user set.
if not parser.description and len(commands):
sub_parsers = parser.add_subparsers()
[sub_parsers.add_parser(v) for v in commands]
pass
pass
options = parser.parse_args(argv[1:])
if no_args_func and callable(no_args_func):
return no_args_func(options)
else:
parser._print_message("nothing to do...\n")
pass
def parse(parser, argv=None, settings_module=None, no_args_func=None):
"""
parser cliez app
:param parser: an instance of argparse.ArgumentParser
:type parser: `argparse.ArgumentParser`
:param argv: argument list,default is `sys.argv`
:type argv: `list` or `tuple`
:param settings_module: settings class name, default is `cliez.conf.Settings`
:type settings_module: `str`
:param function no_args_func: execute when no argument apply.
:return: `Component`
"""
argv = argv or sys.argv
commands = command_list()
settings = None if not settings_module else Settings.bind(settings_module)
assert type(argv) in [list, tuple], TypeError("argv only can be list or tuple")
# match sub-parser
if len(argv) >= 2 and argv[1] in commands:
sub_parsers = parser.add_subparsers()
class_name = argv[1].capitalize() + 'Component'
from cliez.conf import COMPONENT_ROOT
sys.path.insert(0, os.path.dirname(COMPONENT_ROOT))
mod = importlib.import_module('{}.components.{}'.format(os.path.basename(COMPONENT_ROOT), argv[1]))
klass = getattr(mod, class_name)
klass.append_arguments(sub_parsers)
options = parser.parse_args(argv[1:])
logging.basicConfig(format='[%(levelname)s]:%(message)s', level=logging.ERROR)
if hasattr(options, 'debug') and options.debug:
logging.basicConfig(format='[%(levelname)s]:%(message)s', level=logging.DEBUG)
pass
if hasattr(options, 'verbose'):
if options.verbose == 1:
logging.basicConfig(format='[%(levelname)s]:%(message)s', level=logging.CRITICAL)
elif options.verbose == 2:
logging.basicConfig(format='[%(levelname)s]:%(message)s', level=logging.WARNING)
elif options.verbose == 3:
logging.basicConfig(format='[%(levelname)s]:%(message)s', level=logging.INFO)
pass
obj = klass(parser, options=options, settings=settings)
obj.run(options)
# easier to create unittest case
return obj
if not parser.description and len(commands):
sub_parsers = parser.add_subparsers()
[sub_parsers.add_parser(v) for v in commands]
pass
pass
options = parser.parse_args(argv[1:])
if no_args_func:
return no_args_func(options)
else:
parser._print_message("nothing to do...\n")
pass
def setUp(self):
Settings.bind('cliez.conf')
pass
def parse(parser, argv=None, settings_module=None, no_args_func=None):
"""
parser cliez app
:param parser: an instance of argparse.ArgumentParser
:type parser: `argparse.ArgumentParser`
:param argv: argument list,default is `sys.argv`
:type argv: `list` or `tuple`
:param settings_module: settings class name, default is `cliez.conf.Settings`
:type settings_module: `str`
:param function no_args_func: execute when no argument apply.
:return: `Component`
"""
argv = argv or sys.argv
commands = command_list()
settings = None if not settings_module else Settings.bind(settings_module)
assert type(argv) in [list,
tuple], TypeError("argv only can be list or tuple")
# match sub-parser
if len(argv) >= 2 and argv[1] in commands:
sub_parsers = parser.add_subparsers()
class_name = argv[1].capitalize() + 'Component'
from cliez.conf import COMPONENT_ROOT
sys.path.insert(0, os.path.dirname(COMPONENT_ROOT))
mod = importlib.import_module('{}.components.{}'.format(
os.path.basename(COMPONENT_ROOT), argv[1]))
klass = getattr(mod, class_name)
klass.append_arguments(sub_parsers)
options = parser.parse_args(argv[1:])
logging.basicConfig(format='[%(levelname)s]:%(message)s',
level=logging.ERROR)
if hasattr(options, 'debug') and options.debug:
logging.basicConfig(format='[%(levelname)s]:%(message)s',
level=logging.DEBUG)
pass
if hasattr(options, 'verbose'):
if options.verbose == 1:
logging.basicConfig(format='[%(levelname)s]:%(message)s',
level=logging.CRITICAL)
elif options.verbose == 2:
logging.basicConfig(format='[%(levelname)s]:%(message)s',
level=logging.WARNING)
elif options.verbose == 3:
logging.basicConfig(format='[%(levelname)s]:%(message)s',
level=logging.INFO)
pass
obj = klass(parser, options=options, settings=settings)
obj.run(options)
# easier to create unittest case
return obj
if not parser.description and len(commands):
sub_parsers = parser.add_subparsers()
[sub_parsers.add_parser(v) for v in commands]
pass
pass
options = parser.parse_args(argv[1:])
if no_args_func:
return no_args_func(options)
else:
parser._print_message("nothing to do...\n")
pass