diff --git a/README.md b/README.md index f93d2ff..55d37ff 100644 --- a/README.md +++ b/README.md @@ -2,59 +2,139 @@ Python3 parser for command-line options and arguments using Tiramisu engine. -# simple example +# example +Let us start with a simple example ```python #!/usr/bin/env python3 from tiramisu_cmdline_parser import TiramisuCmdlineParser -from tiramisu import StrOption, BoolOption, SymLinkOption, OptionDescription, \ - Config -parser = TiramisuCmdlineParser() +from tiramisu import IntOption, StrOption, BoolOption, ChoiceOption, \ + SymLinkOption, OptionDescription, Config +# build a Config with: +# * a choice for select a sub argument (str, list, int) +choiceoption = ChoiceOption('cmd', + 'choice the sub argument', + ('str', 'list', 'int'), + properties=('mandatory', + 'positional')) +# * a boolean to pass script in verbosity mode with argument -v --verbosity booloption = BoolOption('verbosity', 'increase output verbosity', default=False) -config = Config(OptionDescription('root', 'root', [StrOption('var', - 'a string option', - properties=('mandatory', - 'positional')), - booloption, - SymLinkOption('v', booloption)])) +short_booloption = SymLinkOption('v', booloption) +# * a string option if cmd is 'str' +str_ = StrOption('str', + 'string option', + properties=('mandatory',), + requires=[{'option': choiceoption, + 'expected': 'str', + 'action': 'disabled', + 'inverse': True}]) +# * a list of strings option if cmd is 'list' +list_ = StrOption('list', + 'list string option', + multi=True, + properties=('mandatory',), + requires=[{'option': choiceoption, + 'expected': 'list', + 'action': 'disabled', + 'inverse': True}]) +# * an integer option if cmd is 'int' +int_ = IntOption('int', + 'int option', + properties=('mandatory',), + requires=[{'option': choiceoption, + 'expected': 'int', + 'action': 'disabled', + 'inverse': True}]) +config = Config(OptionDescription('root', + 'root', + [choiceoption, + booloption, + short_booloption, + str_, + list_, + int_ + ])) +# initialise the parser +parser = TiramisuCmdlineParser() +# add the config to parser parser.add_arguments(config) +# parse arguments of current script parser.parse_args() -print('result:', config.value.dict()) +# now, print the result +print('result:') +config.property.read_only() +for key, value in config.value.dict().items(): + print('- {} ({}): {}'.format(key, + config.option(key).option.doc(), + value)) ``` +Let's print help: + ```bash -[gnunux@localhost tiramisu-parser]$ ./prog.py -h -usage: prog.py [-h] [-v] var +[gnunux@localhost tiramisu-parser]$ python3 prog.py str -h +usage: prog.py [-h] [-v] --str STR --list LIST [LIST ...] --int INT + {str,list,int} positional arguments: - var a string option + {str,list,int} choice the sub argument optional arguments: - -h, --help show this help message and exit - -v, --verbosity increase output verbosity + -h, --help show this help message and exit + -v, --verbosity increase output verbosity + --str STR string option + --list LIST [LIST ...] + list string option + --int INT int option +``` + +The positional argument 'cmd' is mandatory: + +```bash +[gnunux@localhost tiramisu-parser]$ python3 prog.py +usage: prog.py [-h] [-v] --str STR --list LIST [LIST ...] --int INT + {str,list,int} +prog.py: error: the following arguments are required: cmd +``` + +If 'cmd' is 'str', --str become mandatory: + +```bash +[gnunux@localhost tiramisu-parser]$ python3 prog.py str +usage: prog.py [-h] [-v] --str STR --list LIST [LIST ...] --int INT + {str,list,int} +prog.py: error: the following arguments are required: --str +``` + +With all mandatories arguments: + +```bash +[gnunux@localhost tiramisu-parser]$ python3 prog.py str --str value +result: +- cmd (choice the sub argument): str +- verbosity (increase output verbosity): False +- v (increase output verbosity): False +- str (string option): value ``` ```bash -[gnunux@localhost tiramisu-parser]$ ./prog.py -v -usage: prog.py [-h] [-v] var -prog.py: error: the following arguments are required: var +[gnunux@localhost tiramisu-parser]$ python3 prog.py int --int 3 +result: +- cmd (choice the sub argument): int +- verbosity (increase output verbosity): False +- v (increase output verbosity): False +- int (int option): 3 ``` ```bash -[gnunux@localhost tiramisu-parser]$ ./prog.py test -result: {'var': 'test', 'verbosity': False, 'v': False} -``` - -```bash -[gnunux@localhost tiramisu-parser]$ ./prog.py -v test -result: {'var': 'test', 'verbosity': True, 'v': True} -``` - -```bash -[gnunux@localhost tiramisu-parser]$ ./prog.py --verbosity test -result: {'var': 'test', 'verbosity': True, 'v': True} +[gnunux@localhost tiramisu-parser]$ python3 prog.py list --list a b c +result: +- cmd (choice the sub argument): list +- verbosity (increase output verbosity): False +- v (increase output verbosity): False +- list (list string option): ['a', 'b', 'c'] ``` diff --git a/test/test_simple.py b/test/test_simple.py index 8e35473..87a544b 100644 --- a/test/test_simple.py +++ b/test/test_simple.py @@ -22,7 +22,7 @@ for test in listdir(DATA_DIR): TEST_DIRS.sort() # TEST_DIRS.remove('test/data/compare/10_positional_list') -# TEST_DIRS = ['test/data/compare/50_conditional_disable'] +# TEST_DIRS = ['test/data/compare/10_positional_list'] @fixture(scope="module", params=TEST_DIRS) @@ -76,6 +76,15 @@ def test_files(test_list): ['bar', '--verbosity'], ['--verbosity', 'bar'], ] for arg in args: + # FIXME unknown argument is check before mandatory + if test_list == 'test/data/compare/10_positional_list': + check = False + for subarg in arg: + if not subarg.startswith('-'): + check = True + break + if not check: + continue tiramparser = TiramisuCmdlineParser('prog.py') tiramparser_dict, tiramparser_system_err, tiramparser_error, tiramparser_help = import_subfile_and_test(test_list + '/tiramisu.py', tiramparser, arg) @@ -83,15 +92,16 @@ def test_files(test_list): argparser = ArgumentParser('prog.py') argparser_dict, argparser_system_err, argparser_error, argparser_help = import_subfile_and_test(test_list + '/argparse.py', argparser, arg) - #print(tiramparser_dict) - #print(tiramparser_system_err) - #print(tiramparser_error) - #print(tiramparser_help) - #print('-----') - #print(argparser_dict) - #print(argparser_system_err) - #print(argparser_error) - #print(argparser_help) + # print('===>', test_list, arg) + # print(tiramparser_dict) + # print(tiramparser_system_err) + # print(tiramparser_error) + # print(tiramparser_help) + # print('-----') + # print(argparser_dict) + # print(argparser_system_err) + # print(argparser_error) + # print(argparser_help) assert tiramparser_dict == argparser_dict assert tiramparser_error == argparser_error assert tiramparser_help == argparser_help diff --git a/tiramisu_cmdline_parser.py b/tiramisu_cmdline_parser.py index c7e7809..9ee7c26 100644 --- a/tiramisu_cmdline_parser.py +++ b/tiramisu_cmdline_parser.py @@ -23,12 +23,14 @@ from tiramisu.error import PropertiesOptionError class TiramisuNamespace(Namespace): def _populate(self): + self._config.property.read_only() for tiramisu_key, tiramisu_value in self._config.value.dict().items(): option = self._config.option(tiramisu_key) if not isinstance(option.option.get(), SymLinkOption): if tiramisu_value == [] and option.option.ismulti() and option.owner.isdefault(): tiramisu_value = None super().__setattr__(tiramisu_key, tiramisu_value) + self._config.property.read_write() def __init__(self, config): self._config = config @@ -46,9 +48,7 @@ class TiramisuNamespace(Namespace): def __getattribute__(self, key): if key == '__dict__' and hasattr(self, '_config'): - self._config.property.read_only() self._populate() - self._config.property.read_write() return super().__getattribute__(key) @@ -77,16 +77,13 @@ class TiramisuCmdlineParser(ArgumentParser): else: raise NotImplementedError('do not use add_argument') - def add_arguments(self, tiramisu: Union[Config, Option, List[Option], OptionDescription]) -> None: - if not isinstance(tiramisu, Config): - if not isinstance(tiramisu, OptionDescription): - if isinstance(tiramisu, Option): - tiramisu = [tiramisu] - tiramisu = OptionDescription('root', 'root', tiramisu) - tiramisu = Config(tiramisu) - self.config = tiramisu + def add_subparsers(self, *args, **kwargs): + raise NotImplementedError('do not use add_subparsers') + + def _config_to_argparser(self, + _forhelp: bool): actions = {} - for obj in tiramisu.unrestraint.option.list(): + for obj in self.config.unrestraint.option.list(): if obj.option.properties(only_raises=True) or 'frozen' in obj.option.properties(): continue option = obj.option @@ -108,7 +105,7 @@ class TiramisuCmdlineParser(ArgumentParser): args = [self.prefix_chars + name] else: args = [self.prefix_chars * 2 + name] - if 'mandatory' in properties: + if _forhelp and 'mandatory' in properties: kwargs['required'] = True if isinstance(tiramisu_option, BoolOption): if 'mandatory' in properties: @@ -126,7 +123,7 @@ class TiramisuCmdlineParser(ArgumentParser): #kwargs['action'] = 'store_const' kwargs['nargs'] = '?' if option.ismulti(): - if 'mandatory' in properties: + if _forhelp and 'mandatory' in properties: kwargs['nargs'] = '+' else: kwargs['nargs'] = '*' @@ -147,19 +144,50 @@ class TiramisuCmdlineParser(ArgumentParser): for args, kwargs in actions.values(): super().add_argument(*args, **kwargs) + def add_arguments(self, + tiramisu: Union[Config, Option, List[Option], OptionDescription], + _forhelp: bool=False) -> None: + if not isinstance(tiramisu, Config): + if not isinstance(tiramisu, OptionDescription): + if isinstance(tiramisu, Option): + tiramisu = [tiramisu] + tiramisu = OptionDescription('root', 'root', tiramisu) + tiramisu = Config(tiramisu) + self.config = tiramisu + self._config_to_argparser(_forhelp) + def parse_args(self, *args, **kwargs): kwargs['namespace'] = TiramisuNamespace(self.config) + namespaces = super().parse_args(*args, **kwargs) try: - namespaces = super().parse_args(*args, **kwargs) + del namespaces.__dict__['_config'] except PropertiesOptionError as err: - # import traceback - # traceback.print_exc() - if err.proptype == ('mandatory',): - self.error('the following arguments are required: {}'.format(err._option_bag.option.impl_getname())) + if err.proptype == ['mandatory']: + name = err._option_bag.option.impl_getname() + properties = self.config.option(name).property.get() + if 'positional' not in properties: + if len(name) == 1 and 'longargument' not in properties: + name = self.prefix_chars + name + else: + name = self.prefix_chars * 2 + name + self.error('the following arguments are required: {}'.format(name)) else: self.error('unexpected error: {}'.format(err)) - del namespaces.__dict__['_config'] return namespaces + def format_usage(self, *args, _forhelp=False, **kwargs): + if _forhelp: + return super().format_usage(*args, **kwargs) + help_formatter = TiramisuCmdlineParser(self.prog) + help_formatter.add_arguments(self.config, _forhelp=True) + return help_formatter.format_usage(*args, **kwargs, _forhelp=True) + + def format_help(self, *args, _forhelp=False, **kwargs): + if _forhelp: + return super().format_help(*args, **kwargs) + help_formatter = TiramisuCmdlineParser(self.prog) + help_formatter.add_arguments(self.config, _forhelp=True) + return help_formatter.format_help(*args, **kwargs, _forhelp=True) + def get_config(self): return self.config