stove/tiramisu-cmdline-parser
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Compare commits

base: stove:5e7c0572c9d8eda3c3a8db3b6b36f6b51db568bf
Branches Tags
stove:main
stove:develop
stove:1.0.0
stove:1.0.0rc0
stove:0.7.0a7
stove:0.7.0a6
stove:0.7.0a5
stove:0.7.0a4
stove:0.7.0a3
stove:0.7.0a2
stove:0.7.0a1
stove:0.7.0a0
stove:0.6.2rc2
stove:0.6.2rc1
stove:0.6.2rc0
stove:0.6.1
stove:0.6.1rc0
stove:0.6.0
stove:0.6.0rc0
stove:release/0.4
stove:release/0.3
stove:release/0.2
stove:release/0.1
stove:v0.0.1-dev
..
compare: stove:9851d246bffb606d8b981e79be8a27c4560fc528
Branches Tags
stove:develop
stove:main
stove:1.0.0
stove:1.0.0rc0
stove:0.7.0a7
stove:0.7.0a6
stove:0.7.0a5
stove:0.7.0a4
stove:0.7.0a3
stove:0.7.0a2
stove:0.7.0a1
stove:0.7.0a0
stove:0.6.2rc2
stove:0.6.2rc1
stove:0.6.2rc0
stove:0.6.1
stove:0.6.1rc0
stove:0.6.0
stove:0.6.0rc0
stove:release/0.4
stove:release/0.3
stove:release/0.2
stove:release/0.1
stove:v0.0.1-dev

1 commit
5e7c0572c9 ... 9851d246bf

Author SHA1 Message Date
Emmanuel Garette
9851d246bf feat: portage to tiramisu 5.0 2024-07-30 12:03:00 +02:00
11 changed files with 313 additions and 672 deletions
Show stats Expand all files Collapse all files

22
CHANGELOG.md
View file

@ -1,22 +0,0 @@
## 0.6.1rc0 (2024-11-06)
### Fix
- update tiramisu dependency
## 0.6.0 (2024-11-01)
### Fix
- black
## 0.6.0rc0 (2024-10-31)
### Feat
- pyproject.toml
- portage to tiramisu 5.0
### Fix
- only first value

41
pyproject.toml
View file

@ -1,41 +0,0 @@
[build-system]
build-backend = "flit_core.buildapi"
requires = ["flit_core >=3.8.0,<4"]
[project]
name = "tiramisu_cmdline_parser"
version = "0.6.1"
authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
readme = "README.md"
description = "command-line parser using Tiramisu"
requires-python = ">=3.8"
license = {file = "LICENSE"}
classifiers = [
"License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
"Programming Language :: Python",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3",
"Operating System :: OS Independent",
"Natural Language :: English",
"Natural Language :: French",
]
dependencies = [
"tiramisu >= 5.0,<6",
]
[project.urls]
Home = "https://forge.cloud.silique.fr/stove/tiramisu-cmdline-parser"
[tool.commitizen]
name = "cz_conventional_commits"
tag_format = "$version"
version_scheme = "pep440"
version_provider = "pep621"
#update_changelog_on_bump = true
changelog_merge_prerelease = true

34
setup.py Normal file
View file

@ -0,0 +1,34 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
from setuptools import setup, find_packages
import os
from tiramisu_cmdline_parser import __version__
PACKAGE_NAME = os.environ.get('PACKAGE_DST', 'tiramisu_cmdline_parser')
setup(
version=__version__,
author="Tiramisu's team",
author_email='gnunux@gnunux.info',
name=PACKAGE_NAME,
description="command-line parser using Tiramisu.",
url='https://framagit.org/tiramisu/tiramisu-cmdline-parser',
license='GNU Library or Lesser General Public License (LGPL)',
install_requires=["tiramisu>=5.0"],
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
"Operating System :: OS Independent",
"Natural Language :: English",
"Natural Language :: French",
],
long_description="""\
tiramisu-cmdline-parser
---------------------------------
Python3 parser for command-line options and arguments using Tiramisu engine.
""",
include_package_data=True,
packages=find_packages(include=['tiramisu_cmdline_parser'])
)

2
tests/test_choice.py
View file

@ -26,7 +26,7 @@ def get_config(json):
properties=('positional', 'mandatory'))
str_ = ChoiceOption('str',
'choice the sub argument',
('str1', 'str2', 'str3', None))
('str1', 'str2', 'str3'))
int_ = ChoiceOption('int',
'choice the sub argument',
(1, 2, 3))

107
tests/test_default.py
View file

@ -1,107 +0,0 @@
from io import StringIO
from contextlib import redirect_stdout, redirect_stderr
import pytest
from tiramisu_cmdline_parser import TiramisuCmdlineParser
from tiramisu import IntOption, StrOption, BoolOption, ChoiceOption, \
OptionDescription, Config
try:
from tiramisu_api import Config as JsonConfig
#params = ['tiramisu', 'tiramisu-json']
params = ['tiramisu']
except:
params = ['tiramisu']
from .utils import TestHelpFormatter, to_dict
def get_config(json, has_tree=False, default_verbosity=False, add_long=False, add_store_false=False):
choiceoption = ChoiceOption('cmd',
'choice the sub argument',
('str', 'list', 'int', 'none'),
properties=('mandatory',))
booloption = BoolOption('verbosity',
'increase output verbosity',
default=default_verbosity,
)
str_ = StrOption('str',
'string option',
default='default'
)
list_ = StrOption('list',
'list string option',
multi=True,
default=['default'],
)
int_ = IntOption('int',
'int option',
default=10,
)
root = OptionDescription('root',
'root',
[choiceoption,
booloption,
str_,
list_,
int_
])
if has_tree:
root = OptionDescription('root',
'root',
[root])
config = Config(root)
config.property.read_write()
if add_store_false:
config.option('verbosity').property.add('storefalse')
if add_long:
config.option('verbosity').property.add('longargument')
if json == 'tiramisu':
return config
jconfig = JsonConfig(config.option.dict())
return jconfig
@pytest.fixture(params=params)
def json(request):
return request.param
def test_readme_help(json):
output = """usage: prog.py [-h] --cmd {str,list,int,none} [--verbosity] [--no-verbosity] [--str [STR]] [--list [LIST ...]] [--int [INT]]
options:
-h, --help show this help message and exit
--cmd {str,list,int,none}
choice the sub argument
--verbosity increase output verbosity (default: False)
--no-verbosity
--str [STR] string option (default: default)
--list [LIST ...] list string option (default: default)
--int [INT] int option (default: 10)
"""
parser = TiramisuCmdlineParser(get_config(json), 'prog.py', formatter_class=TestHelpFormatter)
f = StringIO()
with redirect_stdout(f):
parser.print_help()
assert f.getvalue() == output
def test_readme_help2(json):
output = """usage: prog.py [-h] --cmd {str,list,int,none} [--verbosity] [--no-verbosity] [--str [STR]] [--list [LIST ...]] [--int [INT]]
options:
-h, --help show this help message and exit
--cmd {str,list,int,none}
choice the sub argument
--verbosity increase output verbosity (default: True)
--no-verbosity
--str [STR] string option (default: default)
--list [LIST ...] list string option (default: default)
--int [INT] int option (default: 10)
"""
parser = TiramisuCmdlineParser(get_config(json, default_verbosity=True), 'prog.py', formatter_class=TestHelpFormatter)
f = StringIO()
with redirect_stdout(f):
parser.print_help()
assert f.getvalue() == output

92
tests/test_leadership.py
View file

@ -5,7 +5,7 @@ import pytest
from tiramisu_cmdline_parser import TiramisuCmdlineParser
from tiramisu import IntOption, StrOption, BoolOption, ChoiceOption, \
OptionDescription, Leadership, SymLinkOption, Config, submulti
OptionDescription, Leadership, Config, submulti
try:
from tiramisu_api import Config as JsonConfig
# params = ['tiramisu', 'tiramisu-json']
@ -16,14 +16,8 @@ except:
from .utils import TestHelpFormatter, to_dict
def get_config(json, with_mandatory=False, with_symlink=False, with_default_value=True):
if with_default_value:
default = ['192.168.0.1']
else:
default = []
leader = StrOption('leader', "Leader var", default, multi=True)
if with_symlink:
link_leader = SymLinkOption('l', leader)
def get_config(json, with_mandatory=False):
leader = StrOption('leader', "Leader var", ['192.168.0.1'], multi=True)
follower = StrOption('follower', "Follower", multi=True)
if with_mandatory:
properties = ('mandatory',)
@ -31,14 +25,9 @@ def get_config(json, with_mandatory=False, with_symlink=False, with_default_valu
properties = None
follower_submulti = StrOption('follower_submulti', "Follower submulti", multi=submulti, properties=properties)
follower_integer = IntOption('follower_integer', "Follower integer", multi=True)
if with_symlink:
link_follower = SymLinkOption('i', follower_integer)
follower_boolean = BoolOption('follower_boolean', "Follower boolean", multi=True)
follower_choice = ChoiceOption('follower_choice', "Follower choice", ('opt1', 'opt2'), multi=True)
opt_list = [leader, follower, follower_submulti, follower_integer, follower_boolean, follower_choice]
if with_symlink:
opt_list.append(link_leader)
opt_list.append(link_follower)
if with_mandatory:
opt_list.append(StrOption('follower_mandatory', "Follower mandatory", multi=True, properties=('mandatory',)))
leadership = Leadership('leader', 'leader', opt_list)
@ -85,81 +74,6 @@ leader:
assert f.getvalue() == output
def test_leadership_help_no_pop(json):
output = """usage: prog.py [-h] [--leader.leader [LEADER ...]] [--leader.follower INDEX [FOLLOWER]] --leader.follower_submulti INDEX [FOLLOWER_SUBMULTI ...] [--leader.follower_integer INDEX [FOLLOWER_INTEGER]] [--leader.follower_boolean INDEX] [--leader.follower_choice INDEX [{opt1,opt2}]] --leader.follower_mandatory INDEX FOLLOWER_MANDATORY
options:
-h, --help show this help message and exit
leader:
--leader.leader [LEADER ...]
Leader var
--leader.follower INDEX [FOLLOWER]
Follower
--leader.follower_submulti INDEX [FOLLOWER_SUBMULTI ...]
Follower submulti
--leader.follower_integer INDEX [FOLLOWER_INTEGER]
Follower integer
--leader.follower_boolean INDEX
Follower boolean
--leader.follower_choice INDEX [{opt1,opt2}]
Follower choice
--leader.follower_mandatory INDEX FOLLOWER_MANDATORY
Follower mandatory
"""
parser = TiramisuCmdlineParser(get_config(json, with_mandatory=True), 'prog.py', add_extra_options=False, formatter_class=TestHelpFormatter)
f = StringIO()
with redirect_stdout(f):
parser.print_help()
assert f.getvalue() == output
def test_leadership_help_short_no_default(json):
output = """usage: prog.py [-h] [-l [LEADER ...]]
options:
-h, --help show this help message and exit
leader:
-l [LEADER ...], --leader.leader [LEADER ...]
Leader var
"""
parser = TiramisuCmdlineParser(get_config(json, with_mandatory=True, with_symlink=True, with_default_value=False), 'prog.py', add_extra_options=False, formatter_class=TestHelpFormatter)
f = StringIO()
with redirect_stdout(f):
parser.print_help()
assert f.getvalue() == output
def test_leadership_help_short(json):
output = """usage: prog.py [-h] [-l [LEADER ...]] [--leader.follower INDEX [FOLLOWER]] --leader.follower_submulti INDEX [FOLLOWER_SUBMULTI ...] [-i INDEX [FOLLOWER_INTEGER]] [--leader.follower_boolean INDEX] [--leader.follower_choice INDEX [{opt1,opt2}]] --leader.follower_mandatory INDEX FOLLOWER_MANDATORY
options:
-h, --help show this help message and exit
leader:
-l [LEADER ...], --leader.leader [LEADER ...]
Leader var
--leader.follower INDEX [FOLLOWER]
Follower
--leader.follower_submulti INDEX [FOLLOWER_SUBMULTI ...]
Follower submulti
-i INDEX [FOLLOWER_INTEGER], --leader.follower_integer INDEX [FOLLOWER_INTEGER]
Follower integer
--leader.follower_boolean INDEX
Follower boolean
--leader.follower_choice INDEX [{opt1,opt2}]
Follower choice
--leader.follower_mandatory INDEX FOLLOWER_MANDATORY
Follower mandatory
"""
parser = TiramisuCmdlineParser(get_config(json, with_mandatory=True, with_symlink=True), 'prog.py', add_extra_options=False, formatter_class=TestHelpFormatter)
f = StringIO()
with redirect_stdout(f):
parser.print_help()
assert f.getvalue() == output
def test_leadership_modif_leader(json):
output = {'leader.leader': ['192.168.1.1'],
'leader.follower': [None],

6
tests/test_optiondescription.py
View file

@ -84,7 +84,7 @@ od1.od0:
{str,list,int,none} choice the sub argument
-v, --od1.od0.verbosity
increase output verbosity (default: False)
increase output verbosity
-nv, --od1.od0.no-verbosity
od2:
@ -115,7 +115,7 @@ od1.od0:
{str,list,int,none} choice the sub argument
-v, --od1.od0.verbosity
increase output verbosity (default: False)
increase output verbosity
-nv, --od1.od0.no-verbosity
od2:
@ -146,7 +146,7 @@ od1.od0:
{str,list,int,none} choice the sub argument
-v, --od1.od0.verbosity
increase output verbosity (default: False)
increase output verbosity
-nv, --od1.od0.no-verbosity
od2:

22
tests/test_readme.py
View file

@ -96,7 +96,7 @@ positional arguments:
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
"""
parser = TiramisuCmdlineParser(get_config(json), 'prog.py', formatter_class=TestHelpFormatter)
@ -114,7 +114,7 @@ options:
root:
{str,list,int,none} choice the sub argument
-v, --root.verbosity increase output verbosity (default: False)
-v, --root.verbosity increase output verbosity
-nv, --root.no-verbosity
"""
parser = TiramisuCmdlineParser(get_config(json, True), 'prog.py', formatter_class=TestHelpFormatter)
@ -132,7 +132,7 @@ options:
root:
{str,list,int,none} choice the sub argument
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
"""
parser = TiramisuCmdlineParser(get_config(json, True), 'prog.py', fullpath=False, formatter_class=TestHelpFormatter)
@ -150,7 +150,7 @@ positional arguments:
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
--str STR string option
"""
@ -171,7 +171,7 @@ def test_readme_help_modif_positional_remove(json):
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
--str STR string option
"""
@ -195,7 +195,7 @@ positional arguments:
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
--str STR string option
"""
@ -216,7 +216,7 @@ def test_readme_help_modif_remove(json):
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
"""
parser = TiramisuCmdlineParser(get_config(json), 'prog.py', display_modified_value=False, formatter_class=TestHelpFormatter)
@ -239,7 +239,7 @@ positional arguments:
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
--str STR string option
"""
@ -261,7 +261,7 @@ def test_readme_help_modif_short_remove(json):
options:
-h, --help show this help message and exit
-nv, --no-verbosity increase output verbosity (default: False)
-nv, --no-verbosity increase output verbosity
--str STR string option
"""
parser = TiramisuCmdlineParser(get_config(json), 'prog.py', display_modified_value=False, formatter_class=TestHelpFormatter)
@ -284,7 +284,7 @@ positional arguments:
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
-nv, --no-verbosity
--str STR string option
"""
@ -305,7 +305,7 @@ def test_readme_help_modif_short_no_remove(json):
options:
-h, --help show this help message and exit
-v, --verbosity increase output verbosity (default: False)
-v, --verbosity increase output verbosity
--str STR string option
"""
parser = TiramisuCmdlineParser(get_config(json), 'prog.py', display_modified_value=False, formatter_class=TestHelpFormatter)

4
tests/utils.py
View file

@ -1,4 +1,4 @@
from argparse import ArgumentDefaultsHelpFormatter
from argparse import HelpFormatter
from tiramisu_cmdline_parser.api import TiramisuHelpFormatter
@ -27,7 +27,7 @@ def to_dict(dico):
return ret
class TestHelpFormatter(TiramisuHelpFormatter, ArgumentDefaultsHelpFormatter):
class TestHelpFormatter(TiramisuHelpFormatter, HelpFormatter):
def __init__(self,
*args,
**kwargs,

19
tiramisu_cmdline_parser/__init__.py
View file

@ -1,26 +1,9 @@
# Copyright (C) 2018-2019 Team tiramisu (see AUTHORS for all contributors)
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from typing import Union, List, Dict, Tuple, Optional, Any
try:
from .api import TiramisuCmdlineParser
except ImportError as err:
import warnings
warnings.warn("cannot not import TiramisuCmdlineParser {err}", ImportWarning)
TiramisuCmdlineParser = None
__version__ = "0.5"
__all__ = ("TiramisuCmdlineParser",)
__all__ = ('TiramisuCmdlineParser',)

636
tiramisu_cmdline_parser/api.py
View file

@ -13,28 +13,19 @@
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from typing import Union, List, Dict, Tuple, Optional, Any
from argparse import (
ArgumentParser,
Namespace,
SUPPRESS,
_HelpAction,
HelpFormatter,
ArgumentDefaultsHelpFormatter,
)
from argparse import ArgumentParser, Namespace, SUPPRESS, _HelpAction, HelpFormatter
from copy import copy
from gettext import gettext as _
# try:
#try:
from tiramisu import Config
from tiramisu.error import PropertiesOptionError, LeadershipError, ConfigError
# except ImportError:
from tiramisu.error import PropertiesOptionError, LeadershipError
#except ImportError:
# Config = None
# from tiramisu_api.error import PropertiesOptionError
# LeadershipError = ValueError
try:
from tiramisu_api import Config as ConfigJson
if Config is None:
Config = ConfigJson
except ImportError:
@ -46,26 +37,25 @@ def get_choice_list(config, properties, display):
if isinstance(choice, int):
return str(choice)
return choice
choices = [
convert(choice)
for choice in config.value.list()
if choice != "" and choice is not None
]
choices = [convert(choice) for choice in config.value.list()]
if choices and choices[0] == '':
del choices[0]
if display:
choices = "{{{}}}".format(",".join(choices))
if "mandatory" not in properties:
choices = "[{}]".format(choices)
choices = '{{{}}}'.format(','.join(choices))
if 'mandatory' not in properties:
choices = '[{}]'.format(choices)
return choices
class TiramisuNamespace(Namespace):
def __init__(self, config: Config, root: Optional[str]) -> None:
super().__setattr__("_config", config)
super().__setattr__("_root", root)
super().__setattr__("list_force_no", {})
super().__setattr__("list_force_del", {})
super().__setattr__("arguments", {})
def __init__(self,
config: Config,
root: Optional[str]) -> None:
super().__setattr__('_config', config)
super().__setattr__('_root', root)
super().__setattr__('list_force_no', {})
super().__setattr__('list_force_del', {})
super().__setattr__('arguments', {})
self._populate()
super().__init__()
@ -85,11 +75,10 @@ class TiramisuNamespace(Namespace):
value = None
super().__setattr__(option.path(), value)
def __setattr__(
self,
key: str,
value: Any,
) -> None:
def __setattr__(self,
key: str,
value: Any,
) -> None:
if key in self.list_force_no:
true_key = self.list_force_no[key]
elif key in self.list_force_del:
@ -100,14 +89,14 @@ class TiramisuNamespace(Namespace):
if option.isfollower():
_setattr = self._setattr_follower
if not value[0].isdecimal():
raise ValueError("index must be a number, not {}".format(value[0]))
raise ValueError('index must be a number, not {}'.format(value[0]))
index = int(value[0])
option = self._config.option(true_key, index)
true_value = ",".join(value[1:])
true_value = ','.join(value[1:])
else:
_setattr = self._setattr
true_value = value
if option.type() == "choice":
if option.type() == 'choice':
# HACK if integer in choice
values = option.value.list()
if isinstance(value, list):
@ -129,9 +118,9 @@ class TiramisuNamespace(Namespace):
else:
_setattr(option, true_key, key, value)
except ValueError as err:
if option.type() == "choice":
if option.type() == 'choice':
values = option.value.list()
display_value = ""
display_value = ''
if isinstance(true_value, list):
for val in value:
if val not in values:
@ -140,31 +129,31 @@ class TiramisuNamespace(Namespace):
else:
display_value = true_value
choices = get_choice_list(option, option.property.get(), False)
raise ValueError(
"argument {}: invalid choice: '{}' (choose from {})".format(
self.arguments[key],
display_value,
", ".join([f"'{val}'" for val in choices]),
)
)
raise ValueError("argument {}: invalid choice: '{}' (choose from {})".format(self.arguments[key], display_value, ', '.join([f"'{val}'" for val in choices])))
else:
raise err
def _setattr(self, option: "Option", true_key: str, key: str, value: Any) -> None:
if option.ismulti() and value is not None and not isinstance(value, list):
def _setattr(self,
option: 'Option',
true_key: str,
key: str,
value: Any) -> None:
if option.ismulti() and \
value is not None and \
not isinstance(value, list):
value = [value]
try:
option.value.set(value)
except PropertiesOptionError:
raise AttributeError(
"unrecognized arguments: {}".format(self.arguments[key])
)
raise AttributeError('unrecognized arguments: {}'.format(self.arguments[key]))
def _setattr_follower(
self, option: "Option", true_key: str, key: str, value: Any
) -> None:
def _setattr_follower(self,
option: 'Option',
true_key: str,
key: str,
value: Any) -> None:
index = int(value[0])
if option.type() == "boolean":
if option.type() == 'boolean':
value = key not in self.list_force_no
elif option.issubmulti():
value = value[1:]
@ -174,27 +163,25 @@ class TiramisuNamespace(Namespace):
class TiramisuHelpFormatter:
def _get_default_metavar_for_optional(self, action):
def _get_default_metavar_for_optional(self,
action):
ret = super()._get_default_metavar_for_optional(action)
if "." in ret:
ret = ret.rsplit(".", 1)[1]
if '.' in ret:
ret = ret.rsplit('.', 1)[1]
return ret
class _Section(HelpFormatter._Section):
def format_help(self):
# Remove empty OD
if (
self.formatter.remove_empty_od
and len(self.items) == 1
and self.items[0][0].__name__ == "_format_text"
):
return ""
if self.formatter.remove_empty_od and \
len(self.items) == 1 and \
self.items[0][0].__name__ == '_format_text':
return ''
return super().format_help()
class _TiramisuHelpAction(_HelpAction):
needs = False
def __call__(self, *args, **kwargs):
_TiramisuHelpAction.needs = True
@ -203,38 +190,27 @@ class _TiramisuHelpAction(_HelpAction):
class _BuildKwargs:
def __init__(
self,
name: str,
option: "Option",
cmdlineparser: "TiramisuCmdlineParser",
properties: List[str],
force_no: bool,
force_del: bool,
add_extra_options: bool,
display_modified_value: bool,
not_display: bool,
) -> None:
def __init__(self,
name: str,
option: 'Option',
cmdlineparser: 'TiramisuCmdlineParser',
properties: List[str],
force_no: bool,
force_del: bool,
display_modified_value: bool,
not_display: bool) -> None:
self.kwargs = {}
self.cmdlineparser = cmdlineparser
self.properties = properties
self.force_no = force_no
self.force_del = force_del
if (
(not self.force_no or not add_extra_options)
or (not_display and not display_modified_value)
) and not self.force_del:
if self.force_no:
description = option.information.get("negative_description", None)
else:
description = None
if description is None:
description = option.description()
self.kwargs["help"] = description
if "positional" not in self.properties:
is_short_name = self.cmdlineparser._is_short_name(
name, "longargument" in self.properties
)
if (not self.force_no or (not_display and not display_modified_value)) and not self.force_del:
description = option.description()
if not description:
description = description.replace('%', '%%')
self.kwargs['help'] = description
if 'positional' not in self.properties:
is_short_name = self.cmdlineparser._is_short_name(name, 'longargument' in self.properties)
if self.force_no:
ga_name = self.gen_argument_name(name, is_short_name)
ga_path = self.gen_argument_name(option.path(), is_short_name)
@ -245,7 +221,7 @@ class _BuildKwargs:
self.cmdlineparser.namespace.list_force_del[ga_path] = option.path()
else:
ga_name = name
self.kwargs["dest"] = self.gen_argument_name(option.path(), False)
self.kwargs['dest'] = self.gen_argument_name(option.path(), False)
argument = self.cmdlineparser._gen_argument(ga_name, is_short_name)
self.cmdlineparser.namespace.arguments[option.path()] = argument
self.args = [argument]
@ -253,13 +229,14 @@ class _BuildKwargs:
self.cmdlineparser.namespace.arguments[option.path()] = option.path()
self.args = [option.path()]
def __setitem__(self, key: str, value: Any) -> None:
def __setitem__(self,
key: str,
value: Any) -> None:
self.kwargs[key] = value
def add_argument(self, option: "Option"):
is_short_name = self.cmdlineparser._is_short_name(
option.name(), "longargument" in self.properties
)
def add_argument(self,
option: 'Option'):
is_short_name = self.cmdlineparser._is_short_name(option.name(), 'longargument' in self.properties)
if self.force_no:
name = self.gen_argument_name(option.name(), is_short_name)
elif self.force_del:
@ -273,22 +250,22 @@ class _BuildKwargs:
def gen_argument_name(self, name, is_short_name):
if self.force_no:
if is_short_name:
prefix = "n"
prefix = 'n'
else:
prefix = "no-"
if "." in name:
sname = name.rsplit(".", 1)
name = sname[0] + "." + prefix + sname[1]
prefix = 'no-'
if '.' in name:
sname = name.rsplit('.', 1)
name = sname[0] + '.' + prefix + sname[1]
else:
name = prefix + name
if self.force_del:
if is_short_name:
prefix = "p"
prefix = 'p'
else:
prefix = "pop-"
if "." in name:
sname = name.rsplit(".", 1)
name = sname[0] + "." + prefix + sname[1]
prefix = 'pop-'
if '.' in name:
sname = name.rsplit('.', 1)
name = sname[0] + '.' + prefix + sname[1]
else:
name = prefix + name
return name
@ -298,21 +275,17 @@ class _BuildKwargs:
class TiramisuCmdlineParser(ArgumentParser):
def __init__(
self,
config: Union[Config, ConfigJson],
*args,
root: str = None,
fullpath: bool = True,
remove_empty_od: bool = False,
display_modified_value: bool = True,
formatter_class=ArgumentDefaultsHelpFormatter,
unrestraint: bool = False,
add_extra_options: bool = True,
short_name_max_len: int = 1,
_forhelp: bool = False,
**kwargs,
):
def __init__(self,
config: Union[Config, ConfigJson],
*args,
root: str=None,
fullpath: bool=True,
remove_empty_od: bool=False,
display_modified_value: bool=True,
formatter_class=HelpFormatter,
unrestraint: bool=False,
_forhelp: bool=False,
**kwargs):
if not _forhelp:
unrestraint = True
self.fullpath = fullpath
@ -320,15 +293,11 @@ class TiramisuCmdlineParser(ArgumentParser):
self.root = root
self.remove_empty_od = remove_empty_od
self.unrestraint = unrestraint
self.add_extra_options = add_extra_options
self.display_modified_value = display_modified_value
self.short_name_max_len = short_name_max_len
if TiramisuHelpFormatter not in formatter_class.__mro__:
formatter_class = type(
"TiramisuHelpFormatter", (TiramisuHelpFormatter, formatter_class), {}
)
formatter_class = type('TiramisuHelpFormatter', (TiramisuHelpFormatter, formatter_class), {})
formatter_class.remove_empty_od = self.remove_empty_od
kwargs["formatter_class"] = formatter_class
kwargs['formatter_class'] = formatter_class
if not _forhelp and self.unrestraint:
subconfig = self.config.unrestraint
else:
@ -339,20 +308,20 @@ class TiramisuCmdlineParser(ArgumentParser):
subconfig = subconfig.option(self.root)
self.namespace = TiramisuNamespace(self.config, self.root)
super().__init__(*args, **kwargs)
self.register("action", "help", _TiramisuHelpAction)
self._config_to_argparser(
_forhelp,
subconfig,
self.root,
)
self.register('action', 'help', _TiramisuHelpAction)
self._config_to_argparser(_forhelp,
subconfig,
self.root)
def _pop_action_class(self, kwargs, default=None):
ret = super()._pop_action_class(kwargs, default)
if kwargs.get("action") != "help" and kwargs.get("dest") != "help":
if kwargs.get('action') != 'help' and kwargs.get('dest') != 'help':
return ret
return _TiramisuHelpAction
def _match_arguments_partial(self, actions, arg_string_pattern):
def _match_arguments_partial(self,
actions,
arg_string_pattern):
# used only when check first proposal for first value
# we have to remove all actions with propertieserror
# so only first settable option will be returned
@ -367,7 +336,7 @@ class TiramisuCmdlineParser(ArgumentParser):
return super()._match_arguments_partial(actions, arg_string_pattern)
def _is_short_name(self, name, longargument):
return len(name) <= self.short_name_max_len and not longargument
return len(name) == 1 and not longargument
def _gen_argument(self, name, is_short_name):
if is_short_name:
@ -382,61 +351,60 @@ class TiramisuCmdlineParser(ArgumentParser):
if args != args_ and args_ and args_[0].startswith(self.prefix_chars):
# option that was disabled are no more disable
# so create a new parser
new_parser = TiramisuCmdlineParser(
self.config,
self.prog,
root=self.root,
remove_empty_od=self.remove_empty_od,
display_modified_value=self.display_modified_value,
formatter_class=self.formatter_class,
epilog=self.epilog,
description=self.description,
unrestraint=self.unrestraint,
add_extra_options=self.add_extra_options,
short_name_max_len=self.short_name_max_len,
fullpath=self.fullpath,
)
namespace_, args_ = new_parser._parse_known_args(
args_, new_parser.namespace
)
new_parser = TiramisuCmdlineParser(self.config,
self.prog,
root=self.root,
remove_empty_od=self.remove_empty_od,
display_modified_value=self.display_modified_value,
formatter_class=self.formatter_class,
epilog=self.epilog,
description=self.description,
unrestraint=self.unrestraint,
fullpath=self.fullpath)
namespace_, args_ = new_parser._parse_known_args(args_, new_parser.namespace)
else:
if self._registries["action"]["help"].needs:
if self._registries['action']['help'].needs:
# display help only when all variables assignemnt are done
self._registries["action"]["help"].needs = False
helper = self._registries["action"]["help"](None)
self._registries['action']['help'].needs = False
helper = self._registries['action']['help'](None)
helper.display(self)
return namespace_, args_
def add_argument(self, *args, **kwargs):
if args == ("-h", "--help"):
if args == ('-h', '--help'):
super().add_argument(*args, **kwargs)
else:
raise NotImplementedError(_("do not use add_argument"))
raise NotImplementedError(_('do not use add_argument'))
def add_arguments(self, *args, **kwargs):
raise NotImplementedError(_("do not use add_argument"))
raise NotImplementedError(_('do not use add_argument'))
def add_subparsers(self, *args, **kwargs):
raise NotImplementedError(_("do not use add_subparsers"))
raise NotImplementedError(_('do not use add_subparsers'))
def _option_is_not_default(self, properties, type, name, value):
if "positional" not in properties:
is_short_name = self._is_short_name(name, "longargument" in properties)
self.prog += " {}".format(self._gen_argument(name, is_short_name))
if type != "boolean":
def _option_is_not_default(self,
properties,
type,
name,
value):
if 'positional' not in properties:
is_short_name = self._is_short_name(name, 'longargument' in properties)
self.prog += ' {}'.format(self._gen_argument(name, is_short_name))
if type != 'boolean':
if isinstance(value, list):
for val in value:
self.prog += ' "{}"'.format(val)
else:
self.prog += ' "{}"'.format(value)
def _config_list(
self, config: Config, prefix: Optional[str], _forhelp: bool, group, level
):
obj = None
def _config_list(self,
config: Config,
prefix: Optional[str],
_forhelp: bool,
group, level):
for obj in config:
# do not display frozen option
if "frozen" in obj.property.get():
if 'frozen' in obj.property.get():
continue
if obj.isoptiondescription():
if _forhelp:
@ -447,15 +415,11 @@ class TiramisuCmdlineParser(ArgumentParser):
else:
newgroup = group
if prefix:
prefix_ = prefix + "." + obj.name()
prefix_ = prefix + '.' + obj.name()
else:
prefix_ = obj.path()
self._config_to_argparser(_forhelp, obj, prefix_, newgroup, level + 1)
elif (
self.add_extra_options
and obj.type() == "boolean"
and not obj.issymlinkoption()
):
elif obj.type() == 'boolean' and not obj.issymlinkoption():
if not obj.isleader():
yield obj, False, None
yield obj, True, None
@ -463,301 +427,217 @@ class TiramisuCmdlineParser(ArgumentParser):
yield obj, False, False
yield obj, False, True
yield obj, True, None
elif self.add_extra_options and obj.isleader():
elif obj.isleader():
yield obj, None, False
yield obj, None, True
else:
if (
not obj.issymlinkoption()
and obj.type() == "boolean"
and obj.value.get() is True
):
negative_description = obj.information.get(
"negative_description", None
)
if _forhelp and not negative_description:
raise ValueError(
_(
f'the boolean "{obj.path()}" cannot have a default value to "True" with option add_extra_options if there is no negative_description'
)
)
yield obj, True, None
else:
yield obj, None, None
if obj is not None and not obj.isoptiondescription() and obj.isleader():
# no follower found, search if there is a symlink
for sobj in config.list(uncalculated=True):
try:
if sobj.issymlinkoption() and sobj.option().isleader():
yield sobj, None, None
except ConfigError:
pass
yield obj, None, None
def _config_to_argparser(
self, _forhelp: bool, config, prefix: Optional[str], group=None, level=0
) -> None:
def _config_to_argparser(self,
_forhelp: bool,
config,
prefix: Optional[str],
group=None,
level=0) -> None:
if group is None:
group = super()
actions = {}
leadership_len = None
options_is_not_default = {}
for option, force_no, force_del in self._config_list(
config, prefix, _forhelp, group, level
):
for option, force_no, force_del in self._config_list(config, prefix, _forhelp, group, level):
name = option.name()
if name.startswith(self.prefix_chars):
raise ValueError(
_('name cannot startswith "{}"').format(self.prefix_chars)
)
raise ValueError(_('name cannot startswith "{}"').format(self.prefix_chars))
if option.issymlinkoption():
symlink_name = option.option().name()
if symlink_name in options_is_not_default:
options_is_not_default[symlink_name]["name"] = name
options_is_not_default[symlink_name]['name'] = name
if symlink_name in actions:
for action in actions[symlink_name]:
action.add_argument(option)
continue
if force_del:
value = None
# elif force_no:
# value = not option.value.get()
elif option.isleader():
value = option.value.get()
leadership_len = len(value)
elif option.isfollower():
if _forhelp:
value = option.value.defaultmulti()
else:
value = []
try:
for index in range(leadership_len):
value.append(
self.config.option(option.path(), index).value.get()
)
except:
value = None
value = []
try:
for index in range(leadership_len):
value.append(self.config.option(option.path(), index).value.get())
except:
value = None
else:
value = option.value.get()
if self.fullpath and prefix:
name = prefix + "." + name
name = prefix + '.' + name
properties = option.property.get()
not_display = (
not option.isfollower()
and not option.owner.isdefault()
and value is not None
)
kwargs = _BuildKwargs(
name,
option,
self,
properties,
force_no,
force_del,
self.add_extra_options,
self.display_modified_value,
not_display,
)
if (
_forhelp
and not_display
and (
(value is not False and not force_no)
or (value is False and force_no)
)
):
options_is_not_default[option.name()] = {
"properties": properties,
"type": option.type(),
"name": name,
"value": value,
}
not_display = not option.isfollower() and not option.owner.isdefault() and value is not None
kwargs = _BuildKwargs(name, option, self, properties, force_no, force_del, self.display_modified_value, not_display)
if _forhelp and not_display and ((value is not False and not force_no) or (value is False and force_no)):
options_is_not_default[option.name()] = {'properties': properties,
'type': option.type(),
'name': name,
'value': value}
if not self.display_modified_value:
continue
if force_no:
default = False
else:
default = option.value.default()
if isinstance(default, list):
str_default_value = ",".join([str(v) for v in default])
else:
str_default_value = default
if "positional" in properties:
if option.type() == "boolean":
raise ValueError(_("boolean option must not be positional"))
if not "mandatory" in properties:
if 'positional' in properties:
if option.type() == 'boolean':
raise ValueError(_('boolean option must not be positional'))
if not 'mandatory' in properties:
raise ValueError('"positional" argument must be "mandatory" too')
if _forhelp:
kwargs["default"] = str_default_value
kwargs['default'] = option.value.default()
else:
kwargs["default"] = value
kwargs["nargs"] = "?"
kwargs['default'] = value
kwargs['nargs'] = '?'
else:
if _forhelp and not option.isleader():
if default not in [None, []]:
kwargs["default"] = str_default_value
else:
kwargs["default"] = SUPPRESS
else:
kwargs["default"] = SUPPRESS
if _forhelp and "mandatory" in properties:
kwargs["required"] = True
if not force_del and option.type() == "boolean":
kwargs['default'] = SUPPRESS
if _forhelp and 'mandatory' in properties:
kwargs['required'] = True
if not force_del and option.type() == 'boolean':
if not option.isfollower():
if "storefalse" in properties:
if 'storefalse' in properties:
if force_no:
action = "store_true"
action = 'store_true'
else:
action = "store_false"
action = 'store_false'
elif force_no:
action = "store_false"
action = 'store_false'
else:
action = "store_true"
kwargs["action"] = action
action = 'store_true'
kwargs['action'] = action
else:
kwargs["metavar"] = "INDEX"
if option.type() != "boolean" or force_del:
kwargs['metavar'] = 'INDEX'
if option.type() != 'boolean' or force_del:
if not force_del:
if _forhelp:
value = option.value.default()
if value not in [None, []]:
# kwargs['default'] = kwargs['const'] = option.default()
# kwargs['action'] = 'store_const'
kwargs["nargs"] = "?"
#kwargs['default'] = kwargs['const'] = option.default()
#kwargs['action'] = 'store_const'
kwargs['nargs'] = '?'
if not option.isfollower() and option.ismulti():
if _forhelp and "mandatory" in properties:
kwargs["nargs"] = "+"
if _forhelp and 'mandatory' in properties:
kwargs['nargs'] = '+'
else:
kwargs["nargs"] = "*"
if option.isfollower() and not option.type() == "boolean":
kwargs['nargs'] = '*'
if option.isfollower() and not option.type() == 'boolean':
metavar = option.name().upper()
if option.issubmulti():
kwargs["nargs"] = "+"
kwargs['nargs'] = '+'
else:
kwargs["nargs"] = 2
if _forhelp and "mandatory" not in properties:
metavar = "[{}]".format(metavar)
if option.type() == "choice":
kwargs['nargs'] = 2
if _forhelp and 'mandatory' not in properties:
metavar = '[{}]'.format(metavar)
if option.type() == 'choice':
# do not manage choice with argparse there is problem with integer problem
kwargs["metavar"] = (
"INDEX",
get_choice_list(option, properties, True),
)
kwargs['metavar'] = ('INDEX', get_choice_list(option, properties, True))
else:
kwargs["metavar"] = ("INDEX", metavar)
kwargs['metavar'] = ('INDEX', metavar)
if force_del:
kwargs["metavar"] = "INDEX"
kwargs["type"] = int
elif option.type() == "string":
kwargs['metavar'] = 'INDEX'
kwargs['type'] = int
elif option.type() == 'string':
pass
elif option.type() == "integer" or option.type() == "boolean":
elif option.type() == 'integer' or option.type() == 'boolean':
# when boolean we are here only if follower
kwargs["type"] = int
if _forhelp and option.type() == "boolean":
kwargs["metavar"] = "INDEX"
kwargs["nargs"] = 1
elif option.type() == "choice" and not option.isfollower():
kwargs['type'] = int
if _forhelp and option.type() == 'boolean':
kwargs['metavar'] = 'INDEX'
kwargs['nargs'] = 1
elif option.type() == 'choice' and not option.isfollower():
# do not manage choice with argparse there is problem with integer problem
kwargs["choices"] = get_choice_list(option, properties, False)
elif option.type() == "float":
kwargs["type"] = float
kwargs['choices'] = get_choice_list(option, properties, False)
elif option.type() == 'float':
kwargs['type'] = float
else:
pass
actions.setdefault(option.name(), []).append(kwargs)
for option_is_not_default in options_is_not_default.values():
self._option_is_not_default(**option_is_not_default)
for values in actions.values():
# for value in values:
value = values[0]
args, kwargs = value.get()
group.add_argument(*args, **kwargs)
for value in values:
args, kwargs = value.get()
group.add_argument(*args, **kwargs)
def _valid_mandatory(self):
pass
# def _valid_mandatory(self):
# pass
#
def parse_args(self, *args, valid_mandatory=True, **kwargs):
kwargs["namespace"] = self.namespace
def parse_args(self,
*args,
valid_mandatory=True,
**kwargs):
kwargs['namespace'] = self.namespace
try:
namespaces = super().parse_args(*args, **kwargs)
except PropertiesOptionError as err:
name = err._subconfig.path
name = err._option_bag.option.impl_getname()
properties = self.config.option(name).property.get()
if self.fullpath and "positional" not in properties:
if len(name) == 1 and "longargument" not in properties:
if self.fullpath and '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
if err.proptype == ["mandatory"]:
self.error("the following arguments are required: {}".format(name))
if err.proptype == ['mandatory']:
self.error('the following arguments are required: {}'.format(name))
else:
self.error("unrecognized arguments: {}".format(name))
self.error('unrecognized arguments: {}'.format(name))
if valid_mandatory:
errors = []
for option in self.config.value.mandatory():
properties = option.property.get()
if not option.isfollower():
if "positional" not in properties:
if 'positional' not in properties:
if self.fullpath:
name = option.path()
else:
name = option.name()
is_short_name = self._is_short_name(
name, "longargument" in option.property.get()
)
is_short_name = self._is_short_name(name, 'longargument' in option.property.get())
args = self._gen_argument(name, is_short_name)
else:
args = option.path()
else:
if "positional" not in properties:
if 'positional' not in properties:
args = self._gen_argument(option.path(), False)
else:
args = option.path()
if not self.fullpath and "." in args:
args = args.rsplit(".", 1)[1]
if "positional" not in properties:
if not self.fullpath and '.' in args:
args = args.rsplit('.', 1)[1]
if 'positional' not in properties:
args = self._gen_argument(args, False)
errors.append(args)
if errors:
self.error(
"the following arguments are required: {}".format(", ".join(errors))
)
self.error('the following arguments are required: {}'.format(', '.join(errors)))
return namespaces
def format_usage(self, *args, **kwargs):
help_formatter = TiramisuCmdlineParser(
self.config,
self.prog,
root=self.root,
fullpath=self.fullpath,
remove_empty_od=self.remove_empty_od,
display_modified_value=self.display_modified_value,
formatter_class=self.formatter_class,
add_extra_options=self.add_extra_options,
short_name_max_len=self.short_name_max_len,
epilog=self.epilog,
description=self.description,
_forhelp=True,
)
return super(TiramisuCmdlineParser, help_formatter).format_usage(
*args, **kwargs
)
def format_usage(self,
*args,
**kwargs):
help_formatter = TiramisuCmdlineParser(self.config,
self.prog,
root=self.root,
fullpath=self.fullpath,
remove_empty_od=self.remove_empty_od,
display_modified_value=self.display_modified_value,
formatter_class=self.formatter_class,
epilog=self.epilog,
description=self.description,
_forhelp=True)
return super(TiramisuCmdlineParser, help_formatter).format_usage(*args, **kwargs)
def format_help(self):
help_formatter = TiramisuCmdlineParser(
self.config,
self.prog,
root=self.root,
fullpath=self.fullpath,
remove_empty_od=self.remove_empty_od,
display_modified_value=self.display_modified_value,
formatter_class=self.formatter_class,
add_extra_options=self.add_extra_options,
short_name_max_len=self.short_name_max_len,
epilog=self.epilog,
description=self.description,
_forhelp=True,
)
help_formatter = TiramisuCmdlineParser(self.config,
self.prog,
root=self.root,
fullpath=self.fullpath,
remove_empty_od=self.remove_empty_od,
display_modified_value=self.display_modified_value,
formatter_class=self.formatter_class,
epilog=self.epilog,
description=self.description,
_forhelp=True)
return super(TiramisuCmdlineParser, help_formatter).format_help()
def get_config(self):