feat: add json.get to have sub variables

src/rougail/output_json/__init__.py

@@ -56,11 +56,16 @@ class RougailOutputJson:
             self.warnings = []
         self.read_write = self.rougailconfig["json.read_write"]
         self.is_mandatory = self.rougailconfig["json.mandatory"]
+        self.get = self.rougailconfig["json.get"]
         self.dico = {}
 
     def run(self) -> None:
         ret = self.exporter()
-        return ret, dumps(self.dico, ensure_ascii=False, indent=2) + '\n'
+        if isinstance(self.dico, str):
+            value = self.dico
+        else:
+            value = dumps(self.dico, ensure_ascii=False, indent=2)
+        return ret, value
 
     def print(self) -> str:
         ret, data = self.run()
@@ -70,14 +75,21 @@ class RougailOutputJson:
     def exporter(self) -> None:
         self.config.property.read_write()
         self.mandatory()
-        self.manage_warnings()
         self.config.property.read_only()
         if self.manage_errors():
             return False
+        self.manage_warnings()
         if self.read_write:
             self.config.property.read_write()
+        if self.get:
+            config = self.config.option(self.get)
+            if not config.isoptiondescription():
+                self.dico = config.value.get()
+                return True
+        else:
+            config = self.config
         self.parse_family(
-            self.config,
+            config,
             self.dico,
         )
         return True
@@ -126,6 +138,7 @@ class RougailOutputJson:
         if not self.errors:
             return False
         self.dico = {"_errors": self.errors}
+        self.manage_warnings()
         return True
 
     def parse_family(

src/rougail/output_json/config.py

@@ -17,29 +17,36 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 
 from pathlib import Path
+from .i18n import _
 
 
 def get_rougail_config(
     *,
     backward_compatibility=True,
 ) -> dict:
-    options = """
+    options = f"""
 json:
-  description: Configuration rougail-json
+  description: {_('configuration rougail-json')}
   disabled:
     type: jinja
     jinja: |
-      {% if step.output != 'json' %}
+      {{% if step.output is propertyerror or step.output != 'json' %}}
       disabled
-      {% endif %}
+      {{% endif %}}
+
   read_write:
-    description: Display variables available in read_write mode
+    description: {_('display variables available in read_write mode')}
-    negative_description: Display variables available in read_only mode
+    negative_description: {_('display variables available in read_only mode')}
     default: false
+
   mandatory:
-    description: Test mandatories variable before display in json
+    description: {_('test mandatories variable before display in json')}
-    negative_description: Do not test mandatories variable before display in json
+    negative_description: {_('do not test mandatories variable before display in json')}
     default: true
+
+  get:
+    description: {_('get value for a variable or a family')}
+    mandatory: false
 """
     return {
         "name": "json",

tests/results/test/00_0empty.json

@@ -1 +1 @@
-{}
+{}

tests/results/test/00_0version_underscore.json

@@ -1,3 +1,3 @@
 {
   "version": "string1"
-}
+}

tests/results/test/00_1empty_variable.json

@@ -1,3 +1,3 @@
 {
   "empty": "string1"
-}
+}

tests/results/test/00_2default_calculated.json

@@ -5,4 +5,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/00_2default_calculated_multi.json

@@ -9,4 +9,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/00_2default_calculated_variable_transitive.json

@@ -7,4 +7,4 @@
     "domain1.lan",
     "domain2.lan"
   ]
-}
+}

tests/results/test/00_4load_subfolder.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "string1"
-}
+}

tests/results/test/00_5load_notype.json

@@ -1,3 +1,3 @@
 {
   "without_type": "string1"
-}
+}

tests/results/test/00_6boolean.json

@@ -5,4 +5,4 @@
   "var4": true,
   "var5": true,
   "var6": true
-}
+}

tests/results/test/00_6boolean_no_mandatory.json

@@ -1,3 +1,3 @@
 {
   "variable": true
-}
+}

tests/results/test/00_6choice.json

@@ -5,4 +5,4 @@
   "var4": null,
   "var5": "a",
   "var6": 1
-}
+}

tests/results/test/00_6choice_calculation.json

@@ -1,3 +1,3 @@
 {
   "var": 0
-}
+}

tests/results/test/00_6choice_variable.json

@@ -5,4 +5,4 @@
     "string3"
   ],
   "var2": "string1"
-}
+}

tests/results/test/00_6custom.json

@@ -1,4 +1,4 @@
 {
   "custom1": "string1",
   "custom2": "string1"
-}
+}

tests/results/test/00_6domainname.json

@@ -1,3 +1,3 @@
 {
   "variable": "domain1.lan"
-}
+}

tests/results/test/00_6domainname_params.json

@@ -1,3 +1,3 @@
 {
   "variable": "domain1.lan"
-}
+}

tests/results/test/00_6float.json

@@ -5,4 +5,4 @@
   "var4": 1.1,
   "var5": 1.1,
   "var6": 1.1
-}
+}

tests/results/test/00_6number.json

@@ -5,4 +5,4 @@
   "var4": 1,
   "var5": 1,
   "var6": 1
-}
+}

tests/results/test/00_6port.json

@@ -2,4 +2,4 @@
   "variable1": "80",
   "variable2": "80",
   "variable3": "80"
-}
+}

tests/results/test/00_6regexp.json

@@ -1,3 +1,3 @@
 {
   "var": "#b1b1b1"
-}
+}

tests/results/test/00_6secret.json

@@ -1,4 +1,4 @@
 {
   "secret1": "string1",
   "secret2": "string1"
-}
+}

tests/results/test/00_6string.json

@@ -5,4 +5,4 @@
   "var4": "string1",
   "var5": "string1",
   "var6": "string1"
-}
+}

tests/results/test/00_7choice_quote.json

@@ -1,3 +1,3 @@
 {
   "var": "quote'"
-}
+}

tests/results/test/00_7help_quote.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "string1"
-}
+}

tests/results/test/00_7value_doublequote.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/00_7value_doublequote2.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/00_7value_doublequote3.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/00_7value_quote.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/00_8calculation_information.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/00_8test.json

@@ -8,4 +8,4 @@
     "test1",
     "test2"
   ]
-}
+}

tests/results/test/00_9choice_variable_multi.json

@@ -7,4 +7,4 @@
     "val1",
     "val2"
   ]
-}
+}

tests/results/test/00_9choice_variables.json

@@ -2,4 +2,4 @@
   "source_variable_1": "string1",
   "source_variable_2": "string1",
   "my_variable": "string1"
-}
+}

tests/results/test/00_9default_calculation.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/00_9default_calculation_information.json

@@ -1,3 +1,3 @@
 {
   "var": "string1"
-}
+}

tests/results/test/00_9default_calculation_information_other_variable.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "string1"
-}
+}

tests/results/test/00_9default_calculation_multi_optional.json

@@ -5,4 +5,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/00_9default_calculation_multi_optional2.json

@@ -5,4 +5,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/00_9default_calculation_optional.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/00_9default_calculation_optional_exists.json

@@ -9,4 +9,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/00_9default_calculation_param_optional.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "string1"
-}
+}

tests/results/test/00_9default_information_other_variable.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "string1"
-}
+}

tests/results/test/00_9default_information_other_variable2.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "string1"
-}
+}

tests/results/test/00_9default_integer.json

@@ -1,3 +1,3 @@
 {
   "var": 0
-}
+}

tests/results/test/01_6boolean_multi.json

@@ -23,4 +23,4 @@
   "var8": [
     true
   ]
-}
+}

tests/results/test/01_6custom_multi.json

@@ -9,4 +9,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/01_6float_multi.json

@@ -39,4 +39,4 @@
     2.2,
     3.3
   ]
-}
+}

tests/results/test/01_6number_multi.json

@@ -39,4 +39,4 @@
     2,
     3
   ]
-}
+}

tests/results/test/01_6string_empty.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/01_6string_multi.json

@@ -39,4 +39,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/01_7value_multi_doublequote.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/01_7value_multi_doublequote2.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/01_7value_multi_quote.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/01_8calculation_information_multi.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/01_9choice_variable_multi.json

@@ -5,4 +5,4 @@
     "string3"
   ],
   "variable2": "string1"
-}
+}

tests/results/test/04_0type_param.json

@@ -1,3 +1,3 @@
 {
   "int": 1
-}
+}

tests/results/test/04_1auto_save.json

@@ -1,3 +1,3 @@
 {
   "variable": "no"
-}
+}

tests/results/test/04_1auto_save_and_calculated.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "no"
-}
+}

tests/results/test/04_1auto_save_and_calculated_hidden.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "yes"
-}
+}

tests/results/test/04_1auto_save_and_hidden.json

@@ -1,3 +1,3 @@
 {
   "var": "yes"
-}
+}

tests/results/test/04_1default_calculation_hidden.json

@@ -2,4 +2,4 @@
   "var1": "string1",
   "var2": "string1",
   "var3": "string1"
-}
+}

tests/results/test/04_1default_calculation_hidden_2.json

@@ -2,4 +2,4 @@
   "var1": "string1",
   "var2": "string1",
   "var3": "string1"
-}
+}

tests/results/test/04_5disabled_calculation_optional.json

@@ -2,4 +2,4 @@
   "condition": "string1",
   "var1": null,
   "var2": "string1"
-}
+}

tests/results/test/04_5disabled_calculation_variable.json

@@ -1,3 +1,3 @@
 {
   "condition": true
-}
+}

tests/results/test/04_5disabled_calculation_variable2.json

@@ -1,3 +1,3 @@
 {
   "condition": true
-}
+}

tests/results/test/04_5disabled_calculation_variable3.json

@@ -1,4 +1,4 @@
 {
   "condition": "string1",
   "variable": "string1"
-}
+}

tests/results/test/04_5disabled_calculation_variable4.json

@@ -1,3 +1,3 @@
 {
   "condition": "string1"
-}
+}

tests/results/test/04_5disabled_calculation_variable_multi.json

@@ -1,3 +1,3 @@
 {
   "condition": true
-}
+}

tests/results/test/04_5disabled_calculation_variable_multi2.json

@@ -0,0 +1,12 @@
+{
+  "condition": [
+    "string1",
+    "string2",
+    "string3"
+  ],
+  "variable": [
+    "string1",
+    "string2",
+    "string3"
+  ]
+}

tests/results/test/04_5disabled_calculation_variable_multi3.json

@@ -0,0 +1,12 @@
+{
+  "condition": [
+    "string1",
+    "string2",
+    "string3"
+  ],
+  "variable": [
+    "string1",
+    "string2",
+    "string3"
+  ]
+}

tests/results/test/04_5validators.json

@@ -1,3 +1,3 @@
 {
   "int": 1
-}
+}

tests/results/test/04_5validators_differ.json

@@ -1,4 +1,4 @@
 {
   "var1": "another_value",
   "var2": "string1"
-}
+}

tests/results/test/04_5validators_multi.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/04_5validators_multi2.json

@@ -3,4 +3,4 @@
     "val1",
     "val2"
   ]
-}
+}

tests/results/test/05_0multi_not_uniq.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/05_0multi_uniq.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/12_1auto_save_expert.json

@@ -1,3 +1,3 @@
 {
   "var": "no"
-}
+}

tests/results/test/16_0redefine_description.json

@@ -1,3 +1,3 @@
 {
   "var": "string1"
-}
+}

tests/results/test/16_2family_redefine_calculation.json

@@ -1 +1 @@
-{}
+{}

tests/results/test/16_2family_redefine_disabled.json

@@ -1 +1 @@
-{}
+{}

tests/results/test/16_5exists_nonexists.json

@@ -1,4 +1,4 @@
 {
   "var1": "string1",
   "var2": "string1"
-}
+}

tests/results/test/16_5exists_redefine.json

@@ -1,3 +1,3 @@
 {
   "var1": "yes"
-}
+}

tests/results/test/16_5redefine_calculation.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/16_5redefine_choice.json

@@ -1,3 +1,3 @@
 {
   "variable": "a"
-}
+}

tests/results/test/16_5redefine_default.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/16_5redefine_default_calculation.json

@@ -1,3 +1,3 @@
 {
   "variable": "string1"
-}
+}

tests/results/test/16_5redefine_family.json

@@ -2,4 +2,4 @@
   "family": {
     "variable": "string1"
   }
-}
+}

tests/results/test/16_5redefine_help.json

@@ -2,4 +2,4 @@
   "family": {
     "variable": "string1"
   }
-}
+}

tests/results/test/16_5redefine_hidden.json

@@ -1,3 +1,3 @@
 {
   "variable": "no"
-}
+}

tests/results/test/16_5redefine_multi.json

@@ -4,4 +4,4 @@
     "string2",
     "string3"
   ]
-}
+}

tests/results/test/16_5redefine_remove_disable_calculation.json

@@ -1,4 +1,4 @@
 {
   "condition": "string1",
   "variable": "string1"
-}
+}

tests/results/test/16_5test_redefine.json

@@ -2,4 +2,4 @@
   "var1": "test1",
   "var2": "test1",
   "var3": "string1"
-}
+}

tests/results/test/16_6choice_redefine.json

@@ -1,3 +1,3 @@
 {
   "var": "a"
-}
+}

tests/results/test/16_6exists_family.json

@@ -1 +1 @@
-{}
+{}

tests/results/test/16_6exists_redefine_family.json

@@ -5,4 +5,4 @@
   "family2": {
     "variable2": "string1"
   }
-}
+}

tests/results/test/16exists_exists.json

@@ -1,3 +1,3 @@
 {
   "var": "string1"
-}
+}

tests/results/test/17_5redefine_leadership.json

@@ -1,3 +1,3 @@
 {
   "leader": []
-}
+}

tests/results/test/20_0empty_family.json

@@ -1 +1 @@
-{}
+{}

tests/results/test/20_0family_append.json

@@ -3,4 +3,4 @@
     "var1": "string1",
     "var2": "string1"
   }
-}
+}