Compare commits

..

7 commits
main ... 1.2.3

20 changed files with 211 additions and 62 deletions

View file

@ -1,3 +1,18 @@
## 1.2.3 (2026-09-02)
### Fix
- variable and family object are same has type object
- a type could be a dynamic family
- main_namespace is not mandatory (for example for risotto)
- correction in error message
## 1.2.2 (2026-08-21)
### Fix
- control if option is not just an unknown dyn family or dyn option
## 1.2.1 (2026-08-19)
### Fix

View file

@ -1,6 +1,6 @@
[project]
name = "rougail"
version = "1.2.1"
version = "1.2.3"
[tool.commitizen]
name = "cz_conventional_commits"

View file

@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
[project]
name = "rougail-base"
version = "1.2.1"
version = "1.2.3"
authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
readme = "README.md"
description = "A consistency handling system that was initially designed in the configuration management"

View file

@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
[project]
name = "rougail"
version = "1.2.1"
version = "1.2.3"
authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
readme = "README.md"
description = "A consistency handling system that was initially designed in the configuration management"
@ -27,7 +27,7 @@ classifiers = [
dependencies = [
"ruamel.yaml ~= 0.19.1", # same version as rougail-user-data-yaml
"pydantic ~= 2.13.4",
"rougail-base == 1.2.1",
"rougail-base == 1.2.3",
]
[tool.flit.sdist]

View file

@ -1 +1 @@
__version__ = "1.2.1"
__version__ = "1.2.3"

View file

@ -42,8 +42,11 @@ class Rougail(UserData):
load_from_tiramisu_cache
and Path(self.rougailconfig["tiramisu_cache"]).is_file()
)
types = rougail_type(self.rougailconfig)
if not self.load_from_tiramisu_cache:
if rougailconfig["types"]:
types = rougail_type(self.rougailconfig)
else:
types = {}
self.converted = RougailConvert(self.rougailconfig, **types)
self.config = None

View file

@ -37,6 +37,7 @@ from .object_model import (
)
from ..i18n import _
from ..error import DictConsistencyError
from ..tiramisu import CONVERT_OPTION
class CollectFamily:
@ -53,7 +54,7 @@ class CollectFamily:
elif "variable" in self.parameters:
self.name += "{{ identifier }}"
self.path += "{{ identifier }}"
elif self.raises:
elif self.raises and not self.is_type:
msg = f'dynamic family name must have "{{{{ identifier }}}}" in his name for "{self.path}"'
raise DictConsistencyError(msg, 13, self.sources)
if self.version == "1.0":
@ -197,7 +198,14 @@ class CollectVariable:
)
new_params = []
namespace = self.objectspace.namespace
params_data = list(CONVERT_OPTION.get(self.user_type, {}).get("params", {}))
for key, val in params.items():
if params_data and key not in params_data:
raise DictConsistencyError(
_('params "{0}" is not a known parameters with type "{1}" for "{2}" (the list of possible parameters is {3})').format(key, self.user_type, self.path, display_list(params_data, add_quote=True)),
92,
self.sources,
)
try:
new_params.append(
AnyParam(
@ -493,6 +501,7 @@ class Collect(CollectType, CollectFamily, CollectVariable):
parent_option: Optional["Collect"],
*,
raises: bool = True,
is_type: bool = False,
test_exists: bool = True,
) -> None:
self.sources_types = None
@ -503,6 +512,7 @@ class Collect(CollectType, CollectFamily, CollectVariable):
else:
path = f"{subpath}.{name}"
self.raises = raises
self.is_type = is_type
self.test_exists = test_exists
if self.raises and name.startswith("_"):
msg = f'the variable or family "{self.path}" is incorrect, it must not starts with "_" character'

View file

@ -206,6 +206,7 @@ class ParserVariable:
return
root = Path(__file__).parent.parent
self.walker = None
if self.variable_objects is None:
self.variable = Variable
self.family = Family
for structural_name in self.structurals:
@ -248,6 +249,20 @@ class ParserVariable:
self.get_variable_object(obj, is_variable=False)
for obj in [self.dynamic, self.family]
]
else:
self.variable = self.variable_objects[0]
self.choices = self.variable_objects[2]
self.regexp = self.variable_objects[3]
self.family = self.family_objects[-1]
self.dynamic = self.family_objects[0]
for structural_name in self.structurals:
structural = f"structural_{structural_name}"
module_path = root / structural / "__init__.py"
if not module_path.is_file():
continue
module = load_modules(f"rougail.{structural}", str(module_path))
if not self.walker and "Walker" in module.__all__:
self.walker = module.Walker
self.is_init = True
def get_variable_object(self, obj, *, is_variable: bool) -> dict:
@ -293,6 +308,7 @@ class ParserVariable:
obj,
comment,
parent_option,
is_type=self.loaded_custom_types is not None,
)
if option.option_type == "family":
parser = self.parse_family
@ -598,12 +614,16 @@ class RougailConvert(ParserVariable):
*,
custom_variable_types: dict = {},
custom_family_types: dict = {},
variable_objects = None,
family_objects = None,
) -> None:
self.annotator = False
self.has_namespace = False
self.custom_variable_types = custom_variable_types
self.custom_family_types = custom_family_types
self.loaded_custom_types = None
self.variable_objects = variable_objects
self.family_objects = family_objects
super().__init__(rougailconfig)
def get_attributes_types(

View file

@ -64,6 +64,9 @@ class Walker:
main_structures: Optional[List[str]] = None,
isolated_namespace: bool = True,
) -> None:
if not main_namespace:
directory_dict = extra_structures.items()
else:
directory_dict = chain(
(
(

View file

@ -27,6 +27,7 @@ class TypeRougailConvert(StaticRougailConvert):
main_structural_directories: list[str],
secret_pattern: str,
default_structural_format_version: str,
structurals: list[str],
) -> None:
super().__init__(
False,
@ -38,23 +39,21 @@ class TypeRougailConvert(StaticRougailConvert):
)
self.default_structural_format_version = default_structural_format_version
self.secret_pattern = secret_pattern
self.structurals = structurals
self.loaded_custom_types = {}
def load_config(self) -> None:
super().load_config()
# self.add_extra_options = self.add_extra_options
self.sort_structural_files_all = False
self.structurals = ["directory"]
def rougail_type(rougailconfig):
types = rougailconfig["types"]
if not types:
return {"custom_variable_types": {}, "custom_family_types": {}}
convert = TypeRougailConvert(
types,
rougailconfig["types"],
rougailconfig["secret_manager.pattern"],
rougailconfig["default_structural_format_version"],
rougailconfig["step.structural"],
)
convert.init()
convert.parse_directories()
@ -79,6 +78,8 @@ def rougail_type(rougailconfig):
else:
custom_family_types[typ] = data
return {
"variable_objects": convert.variable_objects,
"family_objects": convert.family_objects,
"custom_variable_types": custom_variable_types,
"custom_family_types": custom_family_types,
}

View file

@ -115,7 +115,7 @@ class UserData:
option.name()
except (ConfigError, PropertiesOptionError):
pass
except AttributeError:
except (AttributeError, AttributeOptionError):
self._not_found_is_dynamic(self.config, path, cache, added, data[-1])
def _not_found_is_dynamic(self, config, path, cache, added, data):
@ -632,7 +632,7 @@ class UserData:
default = option.value.default()
if option.isleader():
default = default[0]
value = _('{0} (the search key is "{1}")').format(value, default)
value = _('{0} (the key being sought is "{1}")').format(value, default)
option_without_index.information.set(
key,
value,

View file

@ -129,6 +129,14 @@ def test_type_dynfamily_namespace():
type_variable("family_dynfamily", namespace=True)
def test_type_root_dynfamily():
type_variable("family_root_dynfamily")
def test_type_root_dynfamily_namespace():
type_variable("family_root_dynfamily", namespace=True)
def test_type_family_subfamily_add():
type_variable("family_subfamily_add")

View file

@ -0,0 +1,15 @@
from tiramisu import *
from tiramisu.setting import ALLOWED_LEADER_PROPERTIES
from re import compile as re_compile
from rougail.tiramisu import func, dict_env, load_functions, ConvertDynOptionDescription
try:
groups.namespace
except:
groups.addgroup('namespace')
ALLOWED_LEADER_PROPERTIES.add("basic")
ALLOWED_LEADER_PROPERTIES.add("standard")
ALLOWED_LEADER_PROPERTIES.add("advanced")
option_1 = StrOption(name="a_variable", doc="A variable", multi=True, default=["val1", "val2"], default_multi="val1", properties=frozenset({"mandatory", "standard"}), informations={'ymlfiles': ['tests/types/structures/family_root_dynfamily/00_structure.yml'], 'type': 'string'})
option_3 = StrOption(name="a_first_variable", doc="A first variable", default=Calculation(func['calc_value'], Params((ParamIdentifier()))), properties=frozenset({"mandatory", "standard"}), informations={'ymlfiles': ['tests/types/types/family_root_dynfamily/00_structure.yml', 'tests/types/structures/family_root_dynfamily/00_structure.yml'], 'type': 'string'})
optiondescription_2 = ConvertDynOptionDescription(name="my_family_{{ identifier }}", doc="My family type", identifiers=Calculation(func['calc_value'], Params((ParamOption(option_1)))), children=[option_3], properties=frozenset({"standard"}), informations={'dynamic_variable': 'a_variable', 'ymlfiles': ['tests/types/types/family_root_dynfamily/00_structure.yml', 'tests/types/structures/family_root_dynfamily/00_structure.yml']})
option_0 = OptionDescription(name="baseoption", doc="baseoption", children=[option_1, optiondescription_2])

View file

@ -0,0 +1,8 @@
{
"a_variable": [
"val1",
"val2"
],
"my_family_val1.a_first_variable": "val1",
"my_family_val2.a_first_variable": "val2"
}

View file

@ -0,0 +1,8 @@
{
"a_variable": [
"val1",
"val2"
],
"my_family_val1.a_first_variable": "val1",
"my_family_val2.a_first_variable": "val2"
}

View file

@ -0,0 +1,16 @@
from tiramisu import *
from tiramisu.setting import ALLOWED_LEADER_PROPERTIES
from re import compile as re_compile
from rougail.tiramisu import func, dict_env, load_functions, ConvertDynOptionDescription
try:
groups.namespace
except:
groups.addgroup('namespace')
ALLOWED_LEADER_PROPERTIES.add("basic")
ALLOWED_LEADER_PROPERTIES.add("standard")
ALLOWED_LEADER_PROPERTIES.add("advanced")
option_3 = StrOption(name="a_variable", doc="A variable", multi=True, default=["val1", "val2"], default_multi="val1", properties=frozenset({"mandatory", "standard"}), informations={'ymlfiles': ['tests/types/structures/family_root_dynfamily/00_structure.yml'], 'type': 'string'})
option_5 = StrOption(name="a_first_variable", doc="A first variable", default=Calculation(func['calc_value'], Params((ParamIdentifier()))), properties=frozenset({"mandatory", "standard"}), informations={'ymlfiles': ['tests/types/types/family_root_dynfamily/00_structure.yml', 'tests/types/structures/family_root_dynfamily/00_structure.yml'], 'type': 'string'})
optiondescription_4 = ConvertDynOptionDescription(name="my_family_{{ identifier }}", doc="My family type", identifiers=Calculation(func['calc_value'], Params((ParamOption(option_3)))), children=[option_5], properties=frozenset({"standard"}), informations={'dynamic_variable': 'ns2.a_variable', 'ymlfiles': ['tests/types/types/family_root_dynfamily/00_structure.yml', 'tests/types/structures/family_root_dynfamily/00_structure.yml']})
optiondescription_2 = OptionDescription(name="ns2", doc="NS2", group_type=groups.namespace, children=[option_3, optiondescription_4], properties=frozenset({"standard"}))
option_0 = OptionDescription(name="baseoption", doc="baseoption", children=[optiondescription_2])

View file

@ -0,0 +1,8 @@
{
"ns2.a_variable": [
"val1",
"val2"
],
"ns2.my_family_val1.a_first_variable": "val1",
"ns2.my_family_val2.a_first_variable": "val2"
}

View file

@ -0,0 +1,8 @@
{
"ns2.a_variable": [
"val1",
"val2"
],
"ns2.my_family_val1.a_first_variable": "val1",
"ns2.my_family_val2.a_first_variable": "val2"
}

View file

@ -0,0 +1,13 @@
%YAML 1.2
---
version: 1.1
a_variable: # A variable
- val1
- val2
my_family_{{ identifier }}:
type: my_family_type
dynamic:
variable: _.a_variable
...

View file

@ -0,0 +1,13 @@
%YAML 1.2
---
version: 1.1
my_family_type:
description: My family type
dynamic: []
a_first_variable:
description: A first variable
default:
type: identifier
...