feat: leadership => sequence

This commit is contained in:
egarette@silique.fr 2026-06-11 08:07:02 +02:00
parent f8b906071d
commit a06af4086e
179 changed files with 234 additions and 913 deletions

View file

@ -404,7 +404,7 @@ class Collect(_ToString):
if self.support_namespace and family.group_type() is groups.namespace:
return "namespace"
if family.isleadership():
return "leadership"
return "sequence"
if family.isdynamic(only_self=True):
return "dynamic"
return "family"
@ -421,7 +421,7 @@ class Collect(_ToString):
informations = {}
if not self._collect(family, informations, family_type=family_type):
return False, []
if family_type == "leadership":
if family_type == "sequence":
informations.setdefault("help", []).append(
_("This family contains lists of variable blocks")
)
@ -707,6 +707,7 @@ class Collect(_ToString):
calculation_type = calculation.get("type")
if (
calculation_type == "variable"
and isinstance(calculation["value"], dict)
and calculation["value"]["type"] == "condition"
):
condition = calculation["value"]

View file

@ -173,7 +173,7 @@ doc:
default_values:
description: {_('Modify values to document all variables')}
help: {_('To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration.')}
help: {_('To document sequence or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration.')}
default: true
true_color:
@ -186,7 +186,7 @@ doc:
other_root_filenames:
description: {_("The variables in this family are documented in another file")}
help: {_("If you separate the variables into different files, the links between the variables will break. Therefore, you must define different filenames for the files containing these variables.")}
type: leadership
type: sequence
root_path:
description: {_("This file contains child variables of the family")}
@ -227,16 +227,15 @@ doc:
description: {_("Environment variables prefix name")}
alternative_name: dv
default: ROUGAIL
mandatory: false
validators:
- jinja: |-
{{{{ (_.environment_prefix | upper) != _.environment_prefix }}}}
return_type: boolean
description: {_("should only use uppercase characters")}
disabled:
jinja: |-
{{{{ ___.main_namespace is not defined or ___.main_namespace == none or _.with_environment is false }}}}
return_type: boolean
description: {_('if "main_namespace" is not set or "_.with_environment" is false')}
variable: _.with_environment
when: false
changelog:
description: {_('Changelog documentation')}

View file

@ -125,12 +125,9 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
def _set_mandatories(self, config):
for calculated_too in [False, True]:
for option in config.value.mandatory():
for option in config.value.mandatory(set_permissive=False):
if not calculated_too:
try:
uncalculated = option.value.default(uncalculated=True)
except PropertiesOptionError:
continue
uncalculated = option.value.default(uncalculated=True)
if isinstance(uncalculated, Calculation):
continue
self._set_value_example(option, self._get_an_example(option))
@ -207,7 +204,7 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
for option, values in config.items():
if option.isoptiondescription():
if option.isleadership():
subresults = self._example_parse_leadership(values, dump_type)
subresults = self._example_parse_sequence(values, dump_type)
if subresults:
name = option.name()
results[name] = subresults
@ -244,18 +241,18 @@ class Examples: # pylint: disable=no-member,too-few-public-methods
or (dump_type == 'default' and is_default)
)
def _example_parse_leadership(self, values, dump_type):
leadership_iter = iter(values.items())
leader, leader_values = next(leadership_iter)
def _example_parse_sequence(self, values, dump_type):
sequence_iter = iter(values.items())
leader, leader_values = next(sequence_iter)
if not self._is_valid_owner(leader, dump_type):
return None
leadership = [CommentedMap() for idx in range(len(leader_values))]
sequence = [CommentedMap() for idx in range(len(leader_values))]
for idx, value in enumerate(leader_values):
self._set_example_value(leadership[idx], leader, value, dump_type)
for option, value in leadership_iter:
self._set_example_value(sequence[idx], leader, value, dump_type)
for option, value in sequence_iter:
idx = option.index()
self._set_example_value(leadership[idx], option, value, dump_type)
return leadership
self._set_example_value(sequence[idx], option, value, dump_type)
return sequence
def _set_description(self, results, name, option):
if not self.comment_examples or option.information.get(

View file

@ -276,11 +276,10 @@ class CommonFormatter:
if self.with_environment and not gen_argument_name:
raise Exception("please install tiramisu_cmdline_parser")
if not self.rougailconfig["main_namespace"] and self.with_environment:
if self.support_namespace:
self.prefix = ""
else:
environment_prefix = self.rougailconfig["doc.tabulars.environment_prefix"]
if environment_prefix:
self.prefix = (
self.rougailconfig["doc.tabulars.environment_prefix"] + "_"
environment_prefix + "_"
)
self.with_family = not self.rougailconfig["doc.tabulars.without_family"]
self.other_root_filenames = dict(self.rougailconfig["doc.other_root_filenames"].items())

View file

@ -17,12 +17,12 @@
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var6. +
**Choices**:
*
*
| **var7** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var7. +
**Choices**:
*
*
| **var8** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[choice]` `mandatory` | My var8. +
**Choices**: values of "a.unknown.variable".

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership",
"name": "leadership",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership",
"name": "leadership",

View file

@ -40,7 +40,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "general1.leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership",
"name": "leadership",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership",
"name": "leadership",

View file

@ -1,6 +1,6 @@
{
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership",
"name": "leadership",

View file

@ -1,6 +1,6 @@
{
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership",
"name": "leadership",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -30,7 +30,7 @@
"multiple": true
},
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leadership_1": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership_1",
"name": "leadership_1",
@ -61,7 +61,7 @@
}
},
"leadership_2": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership_2",
"name": "leadership_2",

View file

@ -1,6 +1,6 @@
{
"leadership_1": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership_1",
"name": "leadership_1",
@ -61,7 +61,7 @@
}
},
"leadership_2": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership_2",
"name": "leadership_2",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leadership",
"name": "leadership",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -20,7 +20,7 @@
"variable_type": "string"
},
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -20,7 +20,7 @@
"variable_type": "string"
},
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -62,7 +62,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "dyn{{ identifier }}.leadership",
"name": "leadership",

View file

@ -56,7 +56,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "dyn{{ identifier }}.leadership",
"name": "leadership",

View file

@ -1,6 +1,6 @@
{
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "leader",
"name": "leader",

View file

@ -3,5 +3,5 @@
[,yaml]
----
---
variable: string_1_True_
variable: string_1_True_None
----

View file

@ -2,7 +2,7 @@
```yaml
---
variable: string_1_True_
variable: string_1_True_None
```
</details>

View file

@ -1,4 +1,4 @@
<h1>Example with all variables modifiable</h1>
<pre>---
variable: string_1_True_</pre>
variable: string_1_True_None</pre>

View file

@ -2,5 +2,5 @@
```yaml
---
variable: string_1_True_
variable: string_1_True_None
```

View file

@ -1,5 +1,5 @@
Example with all variables modifiable
--- 
variable: string_1_True_ 
variable: string_1_True_None 

View file

@ -3,5 +3,5 @@
[,yaml]
----
---
variable: string_1_True_ # A variable
variable: string_1_True_None # A variable
----

View file

@ -2,7 +2,7 @@
```yaml
---
variable: string_1_True_ # A variable
variable: string_1_True_None # A variable
```
</details>

View file

@ -1,4 +1,4 @@
<h1>Example with all variables modifiable</h1>
<pre>---
variable: string_1_True_ # A variable</pre>
variable: string_1_True_None # A variable</pre>

View file

@ -2,5 +2,5 @@
```yaml
---
variable: string_1_True_ # A variable
variable: string_1_True_None # A variable
```

View file

@ -1,5 +1,5 @@
Example with all variables modifiable
--- 
variable: string_1_True_ # A variable 
variable: string_1_True_None # A variable 

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -53,7 +53,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.general1.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -43,7 +43,7 @@
"multiple": true
},
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership_1": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership_1",
"name": "leadership_1",
@ -74,7 +74,7 @@
}
},
"leadership_2": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership_2",
"name": "leadership_2",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership_1": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership_1",
"name": "leadership_1",
@ -74,7 +74,7 @@
}
},
"leadership_2": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership_2",
"name": "leadership_2",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -33,7 +33,7 @@
"variable_type": "boolean"
},
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -33,7 +33,7 @@
"variable_type": "string"
},
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -33,7 +33,7 @@
"variable_type": "string"
},
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -75,7 +75,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.dyn{{ identifier }}.leadership",
"name": "leadership",

View file

@ -69,7 +69,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.dyn{{ identifier }}.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -4,5 +4,5 @@
----
---
rougail:
variable: string_1_True_
variable: string_1_True_None
----

View file

@ -3,7 +3,7 @@
```yaml
---
rougail:
variable: string_1_True_
variable: string_1_True_None
```
</details>

View file

@ -2,4 +2,4 @@
<pre>---
rougail:
variable: string_1_True_</pre>
variable: string_1_True_None</pre>

View file

@ -3,5 +3,5 @@
```yaml
---
rougail:
variable: string_1_True_
variable: string_1_True_None
```

View file

@ -2,5 +2,5 @@
--- 
rougail: 
 variable: string_1_True_ 
 variable: string_1_True_None 

View file

@ -4,5 +4,5 @@
----
---
rougail: # Rougail
variable: string_1_True_ # A variable
variable: string_1_True_None # A variable
----

View file

@ -3,7 +3,7 @@
```yaml
---
rougail: # Rougail
variable: string_1_True_ # A variable
variable: string_1_True_None # A variable
```
</details>

View file

@ -2,4 +2,4 @@
<pre>---
rougail: # Rougail
variable: string_1_True_ # A variable</pre>
variable: string_1_True_None # A variable</pre>

View file

@ -3,5 +3,5 @@
```yaml
---
rougail: # Rougail
variable: string_1_True_ # A variable
variable: string_1_True_None # A variable
```

View file

@ -2,5 +2,5 @@
--- 
rougail: # Rougail 
 variable: string_1_True_ # A variable 
 variable: string_1_True_None # A variable 

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leadership": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leadership",
"name": "leadership",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

View file

@ -13,7 +13,7 @@
},
"children": {
"leader": {
"type": "leadership",
"type": "sequence",
"informations": {
"path": "rougail.leader",
"name": "leader",

Some files were not shown because too many files have changed in this diff Show more