Compare commits
3 commits
52069f00c3
...
97c87c24d3
| Author | SHA1 | Date | |
|---|---|---|---|
| 97c87c24d3 | |||
| d9c197ca72 | |||
| e0a45ad4a6 |
6 changed files with 129 additions and 121 deletions
10
CHANGELOG.md
10
CHANGELOG.md
|
|
@ -1,3 +1,13 @@
|
|||
## 0.2.0a24 (2025-10-10)
|
||||
|
||||
### Feat
|
||||
|
||||
- use rougail-user-data-commandline and mix config use data
|
||||
|
||||
### Fix
|
||||
|
||||
- remove force_apply_user_data support
|
||||
|
||||
## 0.2.0a23 (2025-10-03)
|
||||
|
||||
### Fix
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
|
|||
|
||||
[project]
|
||||
name = "rougail.cli"
|
||||
version = "0.2.0a23"
|
||||
version = "0.2.0a24"
|
||||
authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
|
||||
readme = "README.md"
|
||||
description = "CLI for Rougail"
|
||||
|
|
@ -13,9 +13,6 @@ 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.13",
|
||||
|
|
@ -28,7 +25,7 @@ classifiers = [
|
|||
]
|
||||
dependencies = [
|
||||
"rougail >= 1.1,<2",
|
||||
"tiramisu_cmdline_parser >= 0.6,<1",
|
||||
"rougail-user-data-commandline",
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ from rougail.utils import load_modules
|
|||
from rougail.user_datas import UserDatas
|
||||
from rougail.error import RougailWarning
|
||||
|
||||
from rougail.user_data_commandline import RougailUserDataCommandline
|
||||
try:
|
||||
from rougail.user_data_yaml import RougailUserDataYaml
|
||||
except ImportError:
|
||||
|
|
@ -46,88 +47,108 @@ from .i18n import _
|
|||
ENV_PREFIX = "ROUGAILCLI"
|
||||
|
||||
|
||||
|
||||
def _main(arguments, do_not_print):
|
||||
global print_traceback
|
||||
rougailconfig = get_rougail_config(
|
||||
backward_compatibility=False, add_extra_options=False
|
||||
)
|
||||
rougailconfig.generate_config()
|
||||
cmd_config = rougailconfig.config
|
||||
cmd_config = load_cmd_user_datas(rougailconfig.config, arguments)
|
||||
print_traceback = rougailconfig["cli.debug"]
|
||||
if rougailconfig["cli.versions"]:
|
||||
versions = display_version(cmd_config)
|
||||
if do_not_print:
|
||||
return list(versions)
|
||||
for version in versions:
|
||||
print(version)
|
||||
else:
|
||||
manage_warnings(rougailconfig["cli.warnings"])
|
||||
config, err_warn = load_user_datas(rougailconfig)
|
||||
output = get_output(rougailconfig, config, err_warn)
|
||||
if do_not_print:
|
||||
return output.run()
|
||||
ret = output.print()
|
||||
if ret is False:
|
||||
exit(1)
|
||||
|
||||
|
||||
def load_cmd_user_datas(cmd_config, arguments):
|
||||
origin_prop = cmd_config.property.default("read_write", "append")
|
||||
cmd_config.property.setdefault(
|
||||
frozenset(origin_prop | {"not_for_commandline"}), "read_write", "append"
|
||||
)
|
||||
cmd_config.property.read_write()
|
||||
fake_rougail_config = {
|
||||
"step.user_data": [],
|
||||
}
|
||||
fake_user_datas = []
|
||||
cmd_user_datas = []
|
||||
if RougailUserDataYaml:
|
||||
cli_config_file_key = f"{ENV_PREFIX}_CLI.CONFIG_FILE"
|
||||
config_file = os.environ.pop(cli_config_file_key, None)
|
||||
config_file = os.environ.pop(f"{ENV_PREFIX}_CLI.CONFIG_FILE", None)
|
||||
if not config_file:
|
||||
config_file = cmd_config.forcepermissive.option("cli.config_file").value.get()
|
||||
if Path(config_file).is_file():
|
||||
fake_rougail_config = {
|
||||
"step.user_data": "yaml",
|
||||
"step.user_data": ["yaml"],
|
||||
"yaml.filename": [config_file],
|
||||
"yaml.file_with_secrets": "all",
|
||||
}
|
||||
fake_user_datas.extend(
|
||||
RougailUserDataYaml(cmd_config, rougailconfig=fake_rougail_config).run()
|
||||
cmd_user_datas.extend(
|
||||
RougailUserDataYaml(cmd_config,
|
||||
rougailconfig=fake_rougail_config,
|
||||
).run()
|
||||
)
|
||||
if RougailUserDataEnvironment:
|
||||
fake_rougail_config = {
|
||||
"step.user_data": "environment",
|
||||
"step.user_data": ["environment"],
|
||||
"environment.default_environment_name": ENV_PREFIX,
|
||||
}
|
||||
fake_user_datas.extend(
|
||||
cmd_user_datas.extend(
|
||||
RougailUserDataEnvironment(
|
||||
cmd_config, rougailconfig=fake_rougail_config
|
||||
cmd_config,
|
||||
rougailconfig=fake_rougail_config,
|
||||
).run()
|
||||
)
|
||||
if fake_user_datas:
|
||||
user_datas = UserDatas(cmd_config).user_datas(fake_user_datas, return_values_not_error=True)
|
||||
else:
|
||||
user_datas = {}
|
||||
parser = TiramisuCmdlineParser(
|
||||
cmd_config,
|
||||
# add_extra_options=False,
|
||||
fake_rougail_config = {
|
||||
"step.user_data": ["commandline"],
|
||||
}
|
||||
cmd_user_datas.extend(
|
||||
RougailUserDataCommandline(cmd_config,
|
||||
rougailconfig=fake_rougail_config,
|
||||
short_name_max_len=2,
|
||||
arguments=arguments,
|
||||
).run()
|
||||
)
|
||||
parser.parse_args(arguments)
|
||||
if user_datas:
|
||||
user_data = UserDatas(cmd_config).user_datas(user_datas, user_datas_type="values", only_default=True)
|
||||
user_data = UserDatas(cmd_config).user_datas(cmd_user_datas)
|
||||
if user_data["warnings"] and cmd_config.option("cli.warnings").value.get():
|
||||
for warning in user_data["warnings"]:
|
||||
warn(warning)
|
||||
# replays to display errors if needed
|
||||
parser = TiramisuCmdlineParser(
|
||||
cmd_config,
|
||||
short_name_max_len=2,
|
||||
)
|
||||
if not cmd_config.option("cli.versions").value.get():
|
||||
parser.parse_args(arguments)
|
||||
if user_data["errors"]:
|
||||
raise Exception(user_data["errors"][0])
|
||||
global print_traceback
|
||||
print_traceback = rougailconfig["cli.debug"]
|
||||
|
||||
cmd_config.property.setdefault(origin_prop, "read_write", "append")
|
||||
cmd_config.property.remove("not_for_commandline")
|
||||
cmd_config.property.read_only()
|
||||
if not cmd_config.option("cli.warnings").value.get():
|
||||
filterwarnings("ignore", category=DeprecationWarning)
|
||||
filterwarnings("ignore", category=RougailWarning)
|
||||
else:
|
||||
filterwarnings("default", category=DeprecationWarning)
|
||||
filterwarnings("default", category=RougailWarning)
|
||||
if rougailconfig["cli.versions"]:
|
||||
return cmd_config
|
||||
|
||||
|
||||
def display_version(cmd_config):
|
||||
versions = []
|
||||
from tiramisu import __version__
|
||||
yield(f"tiramisu: {__version__}")
|
||||
|
||||
versions.append(f"tiramisu: {__version__}")
|
||||
from tiramisu_cmdline_parser import __version__
|
||||
yield(f"tiramisu-cmdline-parser: {__version__}")
|
||||
|
||||
versions.append(f"tiramisu-cmdline-parser: {__version__}")
|
||||
from rougail import __version__
|
||||
yield(f"rougail: {__version__}")
|
||||
|
||||
versions.append(f"rougail: {__version__}")
|
||||
from . import __version__
|
||||
yield(f"rougail-cli: {__version__}")
|
||||
|
||||
versions.append(f"rougail-cli: {__version__}")
|
||||
for step in ["structural", "user_data", "output"]:
|
||||
display_step = step.replace("_", "-")
|
||||
for step_name in sorted(cmd_config.unrestraint.option(f"step.{step}").value.list()):
|
||||
|
|
@ -141,16 +162,22 @@ def _main(arguments, do_not_print):
|
|||
module = load_modules(
|
||||
"rougail." + step + "_" + step_name, str(path)
|
||||
)
|
||||
versions.append(
|
||||
yield(
|
||||
f"rougail-{display_step}-{step_name}: {module.__version__}"
|
||||
)
|
||||
except Exception as err:
|
||||
pass
|
||||
if do_not_print:
|
||||
return versions
|
||||
for version in versions:
|
||||
print(version)
|
||||
return
|
||||
|
||||
|
||||
def manage_warnings(warnings):
|
||||
if not warnings:
|
||||
filterwarnings("ignore", category=DeprecationWarning)
|
||||
filterwarnings("ignore", category=RougailWarning)
|
||||
else:
|
||||
filterwarnings("default", category=DeprecationWarning)
|
||||
filterwarnings("default", category=RougailWarning)
|
||||
|
||||
def load_user_datas(rougailconfig):
|
||||
try:
|
||||
user_data_names = rougailconfig["step.user_data"]
|
||||
except PropertiesOptionError:
|
||||
|
|
@ -159,13 +186,10 @@ def _main(arguments, do_not_print):
|
|||
if rougailconfig["cli.load_config"]:
|
||||
rougail = Rougail(rougailconfig)
|
||||
config = rougail.run()
|
||||
config.property.read_write()
|
||||
else:
|
||||
config = None
|
||||
# data user
|
||||
if not user_data_names:
|
||||
user_datas = None
|
||||
else:
|
||||
config.property.read_write()
|
||||
user_datas = []
|
||||
for user_data_name in user_data_names:
|
||||
path = (
|
||||
|
|
@ -178,11 +202,6 @@ def _main(arguments, do_not_print):
|
|||
_('cannot find "user_data" module "{0}"').format(user_data_name)
|
||||
)
|
||||
module = load_modules("rougail.user_data_" + user_data_name, str(path))
|
||||
if (
|
||||
hasattr(module.RougailUserData, "force_apply_user_data")
|
||||
and module.RougailUserData.force_apply_user_data is True
|
||||
):
|
||||
continue
|
||||
user_datas.extend(
|
||||
module.RougailUserData(
|
||||
config,
|
||||
|
|
@ -193,25 +212,10 @@ def _main(arguments, do_not_print):
|
|||
err_warn = rougail.user_datas(user_datas)
|
||||
else:
|
||||
err_warn = {"errors": [], "warnings": []}
|
||||
if user_data_names:
|
||||
config.property.read_write()
|
||||
for user_data_name in user_data_names:
|
||||
path = (
|
||||
Path(__file__).parent.parent
|
||||
/ ("user_data_" + user_data_name)
|
||||
/ "__init__.py"
|
||||
)
|
||||
module = load_modules("rougail.user_data_" + user_data_name, str(path))
|
||||
if (
|
||||
hasattr(module.RougailUserData, "force_apply_user_data")
|
||||
and module.RougailUserData.force_apply_user_data is True
|
||||
):
|
||||
ret = module.RougailUserData(
|
||||
config,
|
||||
rougailconfig=rougailconfig,
|
||||
).run()
|
||||
err_warn["errors"].extend(ret["errors"])
|
||||
err_warn["warnings"].extend(ret["warnings"])
|
||||
return config, err_warn
|
||||
|
||||
|
||||
def get_output(rougailconfig, config, err_warn):
|
||||
# output
|
||||
if config and (not rougailconfig["cli.load_config"] or not rougailconfig["cli.read_write"]):
|
||||
config.property.read_only()
|
||||
|
|
@ -228,11 +232,7 @@ def _main(arguments, do_not_print):
|
|||
user_data_errors=err_warn["errors"],
|
||||
user_data_warnings=err_warn["warnings"],
|
||||
)
|
||||
if do_not_print:
|
||||
return output.run()
|
||||
ret = output.print()
|
||||
if ret is False:
|
||||
exit(1)
|
||||
return output
|
||||
|
||||
|
||||
def main(arguments=None, do_not_print=False):
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
__version__ = "0.2.0a23"
|
||||
__version__ = "0.2.0a24"
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
["tiramisu: 5.2.0a12", "tiramisu-cmdline-parser: 0.7.0a2", "rougail: 1.2.0a35", "rougail-cli: 0.2.0a21", "rougail-structural-bitwarden: 0.1.0a5", "rougail-user-data-ansible: 0.1.0a3", "rougail-user-data-bitwarden: 0.1.0a21", "rougail-user-data-environment: 0.1.0a11", "rougail-user-data-yaml: 0.2.0a13", "rougail-output-ansible: 0.2.0a14", "rougail-output-console: 0.2.0a13", "rougail-output-doc: 0.2.0a30", "rougail-output-json: 0.2.0a10"]
|
||||
|
|
@ -48,6 +48,7 @@ def test_cli_boolean_no():
|
|||
def test_cli_version():
|
||||
with chdir(test_dir / 'cli'):
|
||||
ret = main(['--cli.version'], do_not_print=True)
|
||||
ret = [r.rsplit(': ', 1)[0] for r in ret]
|
||||
filename = Path('versions.txt')
|
||||
if not filename.is_file():
|
||||
with filename.open('w') as fh:
|
||||
|
|
@ -60,6 +61,7 @@ def test_cli_version():
|
|||
def test_cli_version_user_data_disabled():
|
||||
with chdir(test_dir / 'cli'):
|
||||
ret = main(['--cli.version', '--step.output', 'doc'], do_not_print=True)
|
||||
ret = [r.rsplit(': ', 1)[0] for r in ret]
|
||||
filename = Path('versions.txt')
|
||||
if not filename.is_file():
|
||||
with filename.open('w') as fh:
|
||||
|
|
|
|||
Loading…
Reference in a new issue